Skip to content

Commit

Permalink
Avoid using "infrastructure" terminology for all cloud (open-telemetr…
Browse files Browse the repository at this point in the history
…y#1530)

* Avoid using "infrastructure" terminology for all cloud

Infrastructure in cloud has a specific connotation for concepts
explained in Infrastructure-as-a-Service (IaaS). Avoid this
termilogy because it's exclusive of some other services/platforms
that is represented by the "cloud" namespace.

Renaming "infrastructure_service" to "service" also due to the new
key length limits we are considering and infrastructure_service is
a lengthy choice.
  • Loading branch information
rakyll authored and ThomsonTan committed Mar 30, 2021
1 parent 4daace4 commit 259acca
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Google products under `cloud.infrastructure_service` ([#1496](https://github.com
- `http.url` MUST NOT contain credentials ([#1502](https://github.com/open-telemetry/opentelemetry-specification/pull/1502))
- Add `aws.eks.cluster.arn` to EKS specific semantic conventions ([#1484](https://github.com/open-telemetry/opentelemetry-specification/pull/1484))
- Rename `zone` to `availability_zone` in `cloud` semantic conventions ([#1495](https://github.com/open-telemetry/opentelemetry-specification/pull/1495))
- Rename `cloud.infrastructure_service` to `cloud.platform` ([#1530](https://github.com/open-telemetry/opentelemetry-specification/pull/1530))
- Add section describing that libraries and the collector should autogenerate
the semantic convention keys. ([#1515](https://github.com/open-telemetry/opentelemetry-specification/pull/1515))

Expand Down
6 changes: 3 additions & 3 deletions semantic_conventions/resource/cloud.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ groups:
- id: cloud
prefix: cloud
brief: >
A cloud infrastructure (e.g. GCP, Azure, AWS)
A cloud environment (e.g. GCP, Azure, AWS)
attributes:
- id: provider
type:
Expand Down Expand Up @@ -42,7 +42,7 @@ groups:
note: >
Availability zones are called "zones" on Google Cloud.
examples: ['us-east-1c']
- id: infrastructure_service
- id: platform
type:
allow_custom_values: true
members:
Expand Down Expand Up @@ -92,7 +92,7 @@ groups:
value: 'gcp_app_engine'
brief: Google Cloud App Engine (GAE)
brief: >
The cloud infrastructure resource in use.
The cloud platform in use.
note: >
The prefix of the service SHOULD match the one specified in `cloud.provider`.
examples: ['aws_ec2', 'azure_vm', 'gcp_compute_engine']
4 changes: 2 additions & 2 deletions specification/resource/semantic_conventions/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| `cloud.account.id` | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | No |
| `cloud.region` | string | The geographical region the resource is running. Refer to your provider's docs to see the available regions, for example [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/en-us/global-infrastructure/geographies/), or [Google Cloud regions](https://cloud.google.com/about/locations). | `us-central1`; `us-east-1` | No |
| `cloud.availability_zone` | string | Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. [1] | `us-east-1c` | No |
| `cloud.infrastructure_service` | string | The cloud infrastructure resource in use. [2] | `aws_ec2`; `azure_vm`; `gcp_compute_engine` | No |
| `cloud.platform` | string | The cloud platform in use. [2] | `aws_ec2`; `azure_vm`; `gcp_compute_engine` | No |

**[1]:** Availability zones are called "zones" on Google Cloud.

Expand All @@ -27,7 +27,7 @@
| `azure` | Microsoft Azure |
| `gcp` | Google Cloud Platform |

`cloud.infrastructure_service` MUST be one of the following or, if none of the listed values apply, a custom value:
`cloud.platform` MUST be one of the following or, if none of the listed values apply, a custom value:

| Value | Description |
|---|---|
Expand Down

0 comments on commit 259acca

Please sign in to comment.