diff --git a/semantic_conventions/resource/cloud.yaml b/semantic_conventions/resource/cloud.yaml new file mode 100644 index 00000000000..207baec0382 --- /dev/null +++ b/semantic_conventions/resource/cloud.yaml @@ -0,0 +1,39 @@ +groups: + - id: cloud + prefix: cloud + brief: > + A cloud infrastructure (e.g. GCP, Azure, AWS) + attributes: + - id: provider + type: + allow_custom_values: true + members: + - id: AWS + value: 'aws' + brief: 'Amazon Web Services' + - id: Azure + value: 'azure' + brief: 'Amazon Web Services' + - id: GCP + value: 'gcp' + brief: 'Google Cloud Platform' + brief: > + Name of the cloud provider. + examples: 'gcp' + - id: account.id + type: string + brief: > + The cloud account ID used to identify different entities. + examples: ['opentelemetry'] + - id: region + type: string + brief: > + A specific geographical location where different entities can run. + examples: ['us-central1'] + - id: zone + type: string + brief: > + Zones are a sub set of the region connected through low-latency links. + note: > + In AWS, this is called availability-zone. + examples: ['us-central1-a'] diff --git a/semantic_conventions/resource/container.yaml b/semantic_conventions/resource/container.yaml new file mode 100644 index 00000000000..ba54d4437d6 --- /dev/null +++ b/semantic_conventions/resource/container.yaml @@ -0,0 +1,28 @@ +groups: + - id: container + prefix: container + brief: > + A container instance. + attributes: + - id: name + type: string + brief: > + Container name. + examples: ['opentelemetry-autoconf'] + - id: id + type: string + brief: > + Container id. Usually a UUID, as for example used to + [identify Docker containers](https://docs.docker.com/engine/reference/run/#container-identification). + The UUID might be abbreviated. + examples: ['a3bf90e006b2'] + - id: image.name + type: string + brief: > + Name of the image the container was built on. + examples: ['gcr.io/opentelemetry/operator'] + - id: image.tag + type: string + brief: > + Container image tag. + examples: ['0.1'] diff --git a/semantic_conventions/resource/deployment_environment.yaml b/semantic_conventions/resource/deployment_environment.yaml new file mode 100644 index 00000000000..7195ebebde7 --- /dev/null +++ b/semantic_conventions/resource/deployment_environment.yaml @@ -0,0 +1,12 @@ +groups: + - id: deployment + prefix: deployment + brief: > + The software deployment. + attributes: + - id: environment + type: string + brief: > + Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) + (aka deployment tier). + examples: ['staging', 'production'] diff --git a/specification/resource/semantic_conventions/cloud.md b/specification/resource/semantic_conventions/cloud.md index 5a6b37874e2..f755a8dceb5 100644 --- a/specification/resource/semantic_conventions/cloud.md +++ b/specification/resource/semantic_conventions/cloud.md @@ -4,19 +4,21 @@ **Description:** A cloud infrastructure (e.g. GCP, Azure, AWS). -| Attribute | Description | Example | -|---|---|---| -| cloud.provider | Name of the cloud provider. See [Cloud Providers](#cloud-providers) for a list of known values. | `gcp` | -| cloud.account.id | The cloud account id used to identify different entities. | `opentelemetry` | -| cloud.region | A specific geographical location where different entities can run | `us-central1` | -| cloud.zone | Zones are a sub set of the region connected through low-latency links.
In aws it is called availability-zone. | `us-central1-a` | + +| Attribute | Type | Description | Example | Required | +|---|---|---|---|---| +| `cloud.provider` | string | Name of the cloud provider. | `gcp` | No | +| `cloud.account.id` | string | The cloud account ID used to identify different entities. | `opentelemetry` | No | +| `cloud.region` | string | A specific geographical location where different entities can run. | `us-central1` | No | +| `cloud.zone` | string | Zones are a sub set of the region connected through low-latency links. [1] | `us-central1-a` | No | -## Cloud Providers +**[1]:** In AWS, this is called availability-zone. `cloud.provider` MUST be one of the following or, if none of the listed values apply, a custom value: -| cloud.provider | Description | +| Value | Description | |---|---| -| aws | Amazon Web Services | -| azure | Microsoft Azure | -| gcp | Google Cloud Platform | +| `aws` | Amazon Web Services | +| `azure` | Amazon Web Services | +| `gcp` | Google Cloud Platform | + diff --git a/specification/resource/semantic_conventions/container.md b/specification/resource/semantic_conventions/container.md index 78cbce23291..c427706922f 100644 --- a/specification/resource/semantic_conventions/container.md +++ b/specification/resource/semantic_conventions/container.md @@ -4,11 +4,11 @@ **Description:** A container instance. -| Attribute | Description | Example | -|---|---|---| -| container.name | Container name. | `opentelemetry-autoconf` | -| container.id | Container id. Usually a UUID, as for example used to [identify Docker containers][]. The UUID might be abbreviated. | `a3bf90e006b2` | -| container.image.name | Name of the image the container was built on. | `gcr.io/opentelemetry/operator` | -| container.image.tag | Container image tag. | `0.1` | - -[identify Docker containers]: https://docs.docker.com/engine/reference/run/#container-identification + +| Attribute | Type | Description | Example | Required | +|---|---|---|---|---| +| `container.name` | string | Container name. | `opentelemetry-autoconf` | No | +| `container.id` | string | Container id. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/reference/run/#container-identification). The UUID might be abbreviated. | `a3bf90e006b2` | No | +| `container.image.name` | string | Name of the image the container was built on. | `gcr.io/opentelemetry/operator` | No | +| `container.image.tag` | string | Container image tag. | `0.1` | No | + diff --git a/specification/resource/semantic_conventions/deployment_environment.md b/specification/resource/semantic_conventions/deployment_environment.md index 7e2488848de..81ded1b7050 100644 --- a/specification/resource/semantic_conventions/deployment_environment.md +++ b/specification/resource/semantic_conventions/deployment_environment.md @@ -4,6 +4,8 @@ **Description:** The software deployment. -| Attribute | Description | Example | Required? | -|---|---|---|---| -| deployment.environment | Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier) | `staging` , `production` | No | + +| Attribute | Type | Description | Example | Required | +|---|---|---|---|---| +| `deployment.environment` | string | Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier). | `staging`
`production` | No | +