Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add yaml for Cloud, Container, and Deployment resource attributes #1055

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions semantic_conventions/resource/cloud.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
groups:
- id: cloud
prefix: cloud
brief: >
A cloud infrastructure (e.g. GCP, Azure, AWS)
arminru marked this conversation as resolved.
Show resolved Hide resolved
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']
28 changes: 28 additions & 0 deletions semantic_conventions/resource/container.yaml
Original file line number Diff line number Diff line change
@@ -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']
12 changes: 12 additions & 0 deletions semantic_conventions/resource/deployment_environment.yaml
Original file line number Diff line number Diff line change
@@ -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']
24 changes: 13 additions & 11 deletions specification/resource/semantic_conventions/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/> In aws it is called availability-zone. | `us-central1-a` |
<!-- semconv cloud -->
| Attribute | Type | Description | Example | Required |
|---|---|---|---|---|
| `cloud.provider` | string | Name of the cloud provider. | `gcp` | No |
arminru marked this conversation as resolved.
Show resolved Hide resolved
| `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 |
<!-- endsemconv -->
16 changes: 8 additions & 8 deletions specification/resource/semantic_conventions/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- semconv container -->
| 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 |
<!-- endsemconv -->
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
<!-- semconv deployment -->
| Attribute | Type | Description | Example | Required |
|---|---|---|---|---|
| `deployment.environment` | string | Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier). | `staging`<br>`production` | No |
<!-- endsemconv -->