[chore] Move GCP attributes to the registry (#849)

2024-03-27 18:14:09 +01:00 · 2024-03-27 18:14:09 +01:00 · 2541b87236
parent a187625b51
commit 2541b87236
12 changed files with 87 additions and 41 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@ -37,6 +37,8 @@ body:
        - area:exception
        - area:faas
        - area:feature-flag
+        - area:gcp-cloud-run
+        - area:gcp-gce
        - area:host
        - area:http
        - area:k8s
--- a/.github/ISSUE_TEMPLATE/change_proposal.yaml
+++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml
@ -30,6 +30,8 @@ body:
        - area:exception
        - area:faas
        - area:feature-flag
+        - area:gcp-cloud-run
+        - area:gcp-gce
        - area:host
        - area:http
        - area:k8s
--- a/.github/ISSUE_TEMPLATE/new-conventions.yaml
+++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml
@ -39,6 +39,8 @@ body:
        - area:exception
        - area:faas
        - area:feature-flag
+        - area:gcp-cloud-run
+        - area:gcp-gce
        - area:host
        - area:http
        - area:k8s
--- a/docs/attributes-registry/README.md
+++ b/docs/attributes-registry/README.md
@ -44,6 +44,8 @@ Currently, the following namespaces exist:
 * [Exception](exception.md)
 * [FaaS](faas.md)
 * [Feature Flag](feature-flag.md)
+* [Google Cloud Run](gcp-cloud-run.md)
+* [Google Compute Engine](gcp-gce.md)
 * [Host](host.md)
 * [HTTP](http.md)
 * [K8s](k8s.md)
--- a/docs/attributes-registry/gcp-cloud-run.md
+++ b/docs/attributes-registry/gcp-cloud-run.md
@ -0,0 +1,9 @@
+# Google Cloud Run
+
+## Google Cloud Run Attributes
+<!-- semconv registry.gcp.cloud_run(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `gcp.cloud_run.job.execution` | string | The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `job-name-xxxx`; `sample-job-mdw84` |
+| `gcp.cloud_run.job.task_index` | int | The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `0`; `1` |
+<!-- endsemconv -->
--- a/docs/attributes-registry/gcp-gce.md
+++ b/docs/attributes-registry/gcp-gce.md
@ -0,0 +1,9 @@
+# Google Compute Engine
+
+## Google Compute Engine Attributes
+<!-- semconv registry.gcp.gce(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `gcp.gce.instance.hostname` | string | The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` |
+| `gcp.gce.instance.name` | string | The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). | `instance-1`; `my-vm-name` |
+<!-- endsemconv -->
--- a/docs/resource/cloud-provider/gcp/cloud-run.md
+++ b/docs/resource/cloud-provider/gcp/cloud-run.md
@ -11,8 +11,8 @@ These conventions are recommended for resources running on Cloud Run.
 <!-- semconv gcp.cloud_run -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `gcp.cloud_run.job.execution` | string | The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `job-name-xxxx`; `sample-job-mdw84` | Recommended |
-| `gcp.cloud_run.job.task_index` | int | The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `0`; `1` | Recommended |
+| [`gcp.cloud_run.job.execution`](../../../attributes-registry/gcp-cloud-run.md) | string | The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `job-name-xxxx`; `sample-job-mdw84` | Recommended |
+| [`gcp.cloud_run.job.task_index`](../../../attributes-registry/gcp-cloud-run.md) | int | The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `0`; `1` | Recommended |
 <!-- endsemconv -->

 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md
--- a/docs/resource/cloud-provider/gcp/gce.md
+++ b/docs/resource/cloud-provider/gcp/gce.md
@ -7,6 +7,6 @@
 <!-- semconv gcp.gce -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `gcp.gce.instance.hostname` | string | The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | Recommended |
-| `gcp.gce.instance.name` | string | The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). | `instance-1`; `my-vm-name` | Recommended |
+| [`gcp.gce.instance.hostname`](../../../attributes-registry/gcp-gce.md) | string | The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | Recommended |
+| [`gcp.gce.instance.name`](../../../attributes-registry/gcp-gce.md) | string | The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). | `instance-1`; `my-vm-name` | Recommended |
 <!-- endsemconv -->
--- a/model/registry/gcp-cloud-run.yaml
+++ b/model/registry/gcp-cloud-run.yaml
@ -0,0 +1,25 @@
+groups:
+  - id: registry.gcp.cloud_run
+    prefix: gcp.cloud_run
+    type: attribute_group
+    brief: >
+      This document defines attributes for Google Cloud Run.
+    attributes:
+      - id: job.execution
+        type: string
+        stability: experimental
+        brief: >
+          The name of the Cloud Run
+          [execution](https://cloud.google.com/run/docs/managing/job-executions)
+          being run for the Job, as set by the
+          [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
+          environment variable.
+        examples: ['job-name-xxxx', 'sample-job-mdw84']
+      - id: job.task_index
+        type: int
+        stability: experimental
+        brief: >
+          The index for a task within an execution as provided by the
+          [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
+          environment variable.
+        examples: [0, 1]
--- a/model/registry/gcp-gce.yaml
+++ b/model/registry/gcp-gce.yaml
@ -0,0 +1,24 @@
+groups:
+  - id: registry.gcp.gce
+    prefix: gcp.gce
+    type: attribute_group
+    brief: >
+      This document defines attributes for Google Compute Engine (GCE).
+    attributes:
+      - id: instance.name
+        type: string
+        stability: experimental
+        brief: >
+          The instance name of a GCE instance. This is the value
+          provided by `host.name`, the visible name of the instance in
+          the Cloud Console UI, and the prefix for the default
+          hostname of the instance as defined by the [default internal
+          DNS
+          name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
+        examples: ['instance-1', 'my-vm-name']
+      - id: instance.hostname
+        type: string
+        stability: experimental
+        brief: >
+          The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm).
+        examples: ['my-host1234.example.com', 'sample-vm.us-west1-b.c.my-project.internal']
--- a/model/resource/cloud_provider/gcp/cloud_run.yaml
+++ b/model/resource/cloud_provider/gcp/cloud_run.yaml
@ -1,25 +1,10 @@
 groups:
  - id: gcp.cloud_run
-    prefix: gcp.cloud_run
    type: resource
    brief: >
      Resource used by Google Cloud Run.
    attributes:
-      - id: job.execution
-        type: string
-        stability: experimental
-        brief: >
-          The name of the Cloud Run
-          [execution](https://cloud.google.com/run/docs/managing/job-executions)
-          being run for the Job, as set by the
-          [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
-          environment variable.
-        examples: ['job-name-xxxx', 'sample-job-mdw84']
-      - id: job.task_index
-        type: int
-        stability: experimental
-        brief: >
-          The index for a task within an execution as provided by the
-          [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
-          environment variable.
-        examples: [0, 1]
+      - ref: gcp.cloud_run.job.execution
+        requirement_level: recommended
+      - ref: gcp.cloud_run.job.task_index
+        requirement_level: recommended
--- a/model/resource/cloud_provider/gcp/gce.yaml
+++ b/model/resource/cloud_provider/gcp/gce.yaml
@ -1,24 +1,10 @@
 groups:
  - id: gcp.gce
-    prefix: gcp.gce
    type: resource
    brief: >
      Resources used by Google Compute Engine (GCE).
    attributes:
-      - id: instance.name
-        type: string
-        stability: experimental
-        brief: >
-          The instance name of a GCE instance. This is the value
-          provided by `host.name`, the visible name of the instance in
-          the Cloud Console UI, and the prefix for the default
-          hostname of the instance as defined by the [default internal
-          DNS
-          name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
-        examples: ['instance-1', 'my-vm-name']
-      - id: instance.hostname
-        type: string
-        stability: experimental
-        brief: >
-          The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm).
-        examples: ['my-host1234.example.com', 'sample-vm.us-west1-b.c.my-project.internal']
+      - ref: gcp.gce.instance.name
+        requirement_level: recommended
+      - ref: gcp.gce.instance.hostname
+        requirement_level: recommended