Skip to content

Commit

Permalink
Clarify the cloud resource attributes (#1481)
Browse files Browse the repository at this point in the history
  • Loading branch information
rakyll authored Mar 2, 2021
1 parent 7033091 commit cfba04b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
19 changes: 12 additions & 7 deletions semantic_conventions/resource/cloud.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,25 @@ groups:
- id: account.id
type: string
brief: >
The cloud account ID used to identify different entities.
examples: ['opentelemetry']
The cloud account ID the resource is assigned to.
examples: ['111111111111', 'opentelemetry']
- id: region
type: string
brief: >
A specific geographical location where different entities can run.
examples: ['us-central1']
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).
examples: ['us-central1', 'us-east-1']
- id: zone
type: string
brief: >
Zones are a sub set of the region connected through low-latency links.
Cloud regions often have multiple, isolated locations known as zones
to increase availability. Zone represents the zone where the resource
is running.
note: >
In AWS, this is called availability-zone.
examples: ['us-central1-a']
AWS and Azure calls them availability zones or AZs.
examples: ['us-central1-a', 'us-east-1c']
- id: infrastructure_service
type:
allow_custom_values: true
Expand Down
8 changes: 4 additions & 4 deletions specification/resource/semantic_conventions/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
| Attribute | Type | Description | Examples | 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.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.zone` | string | Cloud regions often have multiple, isolated locations known as zones to increase availability. Zone represents the zone where the resource is running. [1] | `us-central1-a`; `us-east-1c` | No |
| `cloud.infrastructure_service` | string | The cloud infrastructure resource in use. [2] | `aws_ec2`; `azure_vm`; `gcp_compute_engine` | No |

**[1]:** In AWS, this is called availability-zone.
**[1]:** AWS and Azure calls them availability zones or AZs.

**[2]:** The prefix of the service SHOULD match the one specified in `cloud.provider`.

Expand Down

0 comments on commit cfba04b

Please sign in to comment.