open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move cloud attributes to the registry (#453) 

Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
This commit is contained in:
kaiyan-sheng 2023-10-30 04:52:35 -06:00 committed by GitHub
parent a2bbcc3f21
commit ed054bc828
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 280 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/attributes-registry/README.md
View File

@ -27,6 +27,7 @@ All registered attributes are listed by namespace in this registry.
Currently, the following namespaces exist: Currently, the following namespaces exist:
* [Cloud](cloud.md)
* [Code](code.md) * [Code](code.md)
* [Container](container.md) * [Container](container.md)
* [HTTP](http.md) * [HTTP](http.md)

85
docs/attributes-registry/cloud.md Normal file
View File

@ -0,0 +1,85 @@
<!--- Hugo front matter used to generate the website version of this page:
--->
# Cloud
## Cloud Attributes
<!-- semconv registry.cloud(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `cloud.account.id` | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` |
| `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` |
| `cloud.platform` | string | The cloud platform in use. [2] | `alibaba_cloud_ecs` |
| `cloud.provider` | string | Name of the cloud provider. | `alibaba_cloud` |
| `cloud.region` | string | The geographical region the resource is running. [3] | `us-central1`; `us-east-1` |
| `cloud.resource_id` | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [4] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` |
**[1]:** Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
**[2]:** The prefix of the service SHOULD match the one specified in `cloud.provider`.
**[3]:** Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091).
**[4]:** On some cloud providers, it may not be possible to determine the full ID at startup,
so it may be necessary to set `cloud.resource_id` as a span attribute instead.
The exact value to use for `cloud.resource_id` depends on the cloud provider.
The following well-known definitions MUST be used if you set this attribute and they apply:
* **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
Take care not to use the "invoked ARN" directly but replace any
[alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
with the resolved function version, as the same runtime instance may be invokable with
multiple different aliases.
* **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names)
* **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function,
*not* the function app, having the form
`/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`.
This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share
a TracerProvider.
`cloud.platform` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| `alibaba_cloud_ecs` | Alibaba Cloud Elastic Compute Service |
| `alibaba_cloud_fc` | Alibaba Cloud Function Compute |
| `alibaba_cloud_openshift` | Red Hat OpenShift on Alibaba Cloud |
| `aws_ec2` | AWS Elastic Compute Cloud |
| `aws_ecs` | AWS Elastic Container Service |
| `aws_eks` | AWS Elastic Kubernetes Service |
| `aws_lambda` | AWS Lambda |
| `aws_elastic_beanstalk` | AWS Elastic Beanstalk |
| `aws_app_runner` | AWS App Runner |
| `aws_openshift` | Red Hat OpenShift on AWS (ROSA) |
| `azure_vm` | Azure Virtual Machines |
| `azure_container_instances` | Azure Container Instances |
| `azure_aks` | Azure Kubernetes Service |
| `azure_functions` | Azure Functions |
| `azure_app_service` | Azure App Service |
| `azure_openshift` | Azure Red Hat OpenShift |
| `gcp_bare_metal_solution` | Google Bare Metal Solution (BMS) |
| `gcp_compute_engine` | Google Cloud Compute Engine (GCE) |
| `gcp_cloud_run` | Google Cloud Run |
| `gcp_kubernetes_engine` | Google Cloud Kubernetes Engine (GKE) |
| `gcp_cloud_functions` | Google Cloud Functions (GCF) |
| `gcp_app_engine` | Google Cloud App Engine (GAE) |
| `gcp_openshift` | Red Hat OpenShift on Google Cloud |
| `ibm_cloud_openshift` | Red Hat OpenShift on IBM Cloud |
| `tencent_cloud_cvm` | Tencent Cloud Cloud Virtual Machine (CVM) |
| `tencent_cloud_eks` | Tencent Cloud Elastic Kubernetes Service (EKS) |
| `tencent_cloud_scf` | Tencent Cloud Serverless Cloud Function (SCF) |
`cloud.provider` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| `alibaba_cloud` | Alibaba Cloud |
| `aws` | Amazon Web Services |
| `azure` | Microsoft Azure |
| `gcp` | Google Cloud Platform |
| `heroku` | Heroku Platform as a Service |
| `ibm_cloud` | IBM Cloud |
| `tencent_cloud` | Tencent Cloud |
<!-- endsemconv -->

2
docs/faas/faas-spans.md
View File

@ -41,7 +41,7 @@ If Spans following this convention are produced, a Resource of type `faas` MUST
<!-- semconv faas_span(full) --> <!-- semconv faas_span(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| [`cloud.resource_id`](../resource/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended | | [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
| `faas.invocation_id` | string | The invocation ID of the current function invocation. | `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` | Recommended | | `faas.invocation_id` | string | The invocation ID of the current function invocation. | `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` | Recommended |
| `faas.trigger` | string | Type of the trigger which caused this function invocation. [2] | `datasource` | Recommended | | `faas.trigger` | string | Type of the trigger which caused this function invocation. [2] | `datasource` | Recommended |

14
docs/resource/cloud.md
View File

@ -6,15 +6,15 @@
**Description:** A cloud infrastructure (e.g. GCP, Azure, AWS). **Description:** A cloud infrastructure (e.g. GCP, Azure, AWS).
<!-- semconv cloud --> <!-- semconv cloud(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `cloud.account.id` | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | Recommended | | [`cloud.account.id`](../attributes-registry/cloud.md) | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | Recommended |
| `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` | Recommended | | [`cloud.availability_zone`](../attributes-registry/cloud.md) | 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` | Recommended |
| `cloud.platform` | string | The cloud platform in use. [2] | `alibaba_cloud_ecs` | Recommended | | [`cloud.platform`](../attributes-registry/cloud.md) | string | The cloud platform in use. [2] | `alibaba_cloud_ecs` | Recommended |
| `cloud.provider` | string | Name of the cloud provider. | `alibaba_cloud` | Recommended | | [`cloud.provider`](../attributes-registry/cloud.md) | string | Name of the cloud provider. | `alibaba_cloud` | Recommended |
| `cloud.region` | string | The geographical region the resource is running. [3] | `us-central1`; `us-east-1` | Recommended | | [`cloud.region`](../attributes-registry/cloud.md) | string | The geographical region the resource is running. [3] | `us-central1`; `us-east-1` | Recommended |
| `cloud.resource_id` | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [4] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended | | [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [4] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
**[1]:** Availability zones are called "zones" on Alibaba Cloud and Google Cloud. **[1]:** Availability zones are called "zones" on Alibaba Cloud and Google Cloud.

2
docs/resource/faas.md
View File

@ -16,7 +16,7 @@ See also:
<!-- semconv faas_resource --> <!-- semconv faas_resource -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| [`cloud.resource_id`](cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended | | [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
| `faas.instance` | string | The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version. [2] | `2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de` | Recommended | | `faas.instance` | string | The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version. [2] | `2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de` | Recommended |
| `faas.max_memory` | int | The amount of memory available to the serverless function converted to Bytes. [3] | `134217728` | Recommended | | `faas.max_memory` | int | The amount of memory available to the serverless function converted to Bytes. [3] | `134217728` | Recommended |
| `faas.name` | string | The name of the single function that this runtime instance executes. [4] | `my-function`; `myazurefunctionapp/some-function-name` | Required | | `faas.name` | string | The name of the single function that this runtime instance executes. [4] | `my-function`; `myazurefunctionapp/some-function-name` | Required |

179
model/registry/cloud.yaml Normal file
View File

@ -0,0 +1,179 @@
groups:
- id: registry.cloud
prefix: cloud
type: attribute_group
brief: >
A cloud environment (e.g. GCP, Azure, AWS).
attributes:
- id: provider
type:
allow_custom_values: true
members:
- id: 'alibaba_cloud'
value: 'alibaba_cloud'
brief: 'Alibaba Cloud'
- id: 'aws'
value: 'aws'
brief: 'Amazon Web Services'
- id: 'azure'
value: 'azure'
brief: 'Microsoft Azure'
- id: 'gcp'
value: 'gcp'
brief: 'Google Cloud Platform'
- id: 'heroku'
value: 'heroku'
brief: 'Heroku Platform as a Service'
- id: 'ibm_cloud'
value: 'ibm_cloud'
brief: 'IBM Cloud'
- id: 'tencent_cloud'
value: 'tencent_cloud'
brief: 'Tencent Cloud'
brief: >
Name of the cloud provider.
- id: account.id
type: string
brief: >
The cloud account ID the resource is assigned to.
examples: ['111111111111', 'opentelemetry']
- id: region
type: string
brief: >
The geographical region the resource is running.
note: >
Refer to your provider's docs to see the available regions, for example
[Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm),
[AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/),
[Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/),
[Google Cloud regions](https://cloud.google.com/about/locations),
or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091).
examples: ['us-central1', 'us-east-1']
- id: resource_id
type: string
brief: >
Cloud provider-specific native identifier of the monitored cloud resource
(e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS,
a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure,
a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP)
note: |
On some cloud providers, it may not be possible to determine the full ID at startup,
so it may be necessary to set `cloud.resource_id` as a span attribute instead.
The exact value to use for `cloud.resource_id` depends on the cloud provider.
The following well-known definitions MUST be used if you set this attribute and they apply:
* **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
Take care not to use the "invoked ARN" directly but replace any
[alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
with the resolved function version, as the same runtime instance may be invokable with
multiple different aliases.
* **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names)
* **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function,
*not* the function app, having the form
`/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`.
This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share
a TracerProvider.
examples:
- 'arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function'
- '//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID'
- '/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>'
- id: availability_zone
type: string
brief: >
Cloud regions often have multiple, isolated locations known as zones
to increase availability. Availability zone represents the
zone where the resource is running.
note: >
Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
examples: ['us-east-1c']
- id: platform
type:
allow_custom_values: true
members:
- id: alibaba_cloud_ecs
value: 'alibaba_cloud_ecs'
brief: Alibaba Cloud Elastic Compute Service
- id: alibaba_cloud_fc
value: 'alibaba_cloud_fc'
brief: Alibaba Cloud Function Compute
- id: alibaba_cloud_openshift
value: 'alibaba_cloud_openshift'
brief: Red Hat OpenShift on Alibaba Cloud
- id: aws_ec2
value: 'aws_ec2'
brief: AWS Elastic Compute Cloud
- id: aws_ecs
value: 'aws_ecs'
brief: AWS Elastic Container Service
- id: aws_eks
value: 'aws_eks'
brief: AWS Elastic Kubernetes Service
- id: aws_lambda
value: 'aws_lambda'
brief: AWS Lambda
- id: aws_elastic_beanstalk
value: 'aws_elastic_beanstalk'
brief: AWS Elastic Beanstalk
- id: aws_app_runner
value: 'aws_app_runner'
brief: AWS App Runner
- id: aws_openshift
value: 'aws_openshift'
brief: Red Hat OpenShift on AWS (ROSA)
- id: azure_vm
value: 'azure_vm'
brief: Azure Virtual Machines
- id: azure_container_instances
value: 'azure_container_instances'
brief: Azure Container Instances
- id: azure_aks
value: 'azure_aks'
brief: Azure Kubernetes Service
- id: azure_functions
value: 'azure_functions'
brief: Azure Functions
- id: azure_app_service
value: 'azure_app_service'
brief: Azure App Service
- id: azure_openshift
value: 'azure_openshift'
brief: Azure Red Hat OpenShift
- id: gcp_bare_metal_solution
value: 'gcp_bare_metal_solution'
brief: Google Bare Metal Solution (BMS)
- id: gcp_compute_engine
value: 'gcp_compute_engine'
brief: Google Cloud Compute Engine (GCE)
- id: gcp_cloud_run
value: 'gcp_cloud_run'
brief: Google Cloud Run
- id: gcp_kubernetes_engine
value: 'gcp_kubernetes_engine'
brief: Google Cloud Kubernetes Engine (GKE)
- id: gcp_cloud_functions
value: 'gcp_cloud_functions'
brief: Google Cloud Functions (GCF)
- id: gcp_app_engine
value: 'gcp_app_engine'
brief: Google Cloud App Engine (GAE)
- id: gcp_openshift
value: 'gcp_openshift'
brief: Red Hat OpenShift on Google Cloud
- id: ibm_cloud_openshift
value: 'ibm_cloud_openshift'
brief: Red Hat OpenShift on IBM Cloud
- id: tencent_cloud_cvm
value: 'tencent_cloud_cvm'
brief: Tencent Cloud Cloud Virtual Machine (CVM)
- id: tencent_cloud_eks
value: 'tencent_cloud_eks'
brief: Tencent Cloud Elastic Kubernetes Service (EKS)
- id: tencent_cloud_scf
value: 'tencent_cloud_scf'
brief: Tencent Cloud Serverless Cloud Function (SCF)
brief: >
The cloud platform in use.
note: >
The prefix of the service SHOULD match the one specified in `cloud.provider`.

178
model/resource/cloud.yaml
View File

@ -5,175 +5,9 @@ groups:
brief: > brief: >
A cloud environment (e.g. GCP, Azure, AWS) A cloud environment (e.g. GCP, Azure, AWS)
attributes: attributes:
- id: provider - ref: cloud.provider
type: - ref: cloud.account.id
allow_custom_values: true - ref: cloud.region
members: - ref: cloud.resource_id
- id: 'alibaba_cloud' - ref: cloud.availability_zone
value: 'alibaba_cloud' - ref: cloud.platform
brief: 'Alibaba Cloud'
- id: 'aws'
value: 'aws'
brief: 'Amazon Web Services'
- id: 'azure'
value: 'azure'
brief: 'Microsoft Azure'
- id: 'gcp'
value: 'gcp'
brief: 'Google Cloud Platform'
- id: 'heroku'
value: 'heroku'
brief: 'Heroku Platform as a Service'
- id: 'ibm_cloud'
value: 'ibm_cloud'
brief: 'IBM Cloud'
- id: 'tencent_cloud'
value: 'tencent_cloud'
brief: 'Tencent Cloud'
brief: >
Name of the cloud provider.
- id: account.id
type: string
brief: >
The cloud account ID the resource is assigned to.
examples: ['111111111111', 'opentelemetry']
- id: region
type: string
brief: >
The geographical region the resource is running.
note: >
Refer to your provider's docs to see the available regions, for example
[Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm),
[AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/),
[Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/),
[Google Cloud regions](https://cloud.google.com/about/locations),
or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091).
examples: ['us-central1', 'us-east-1']
- id: resource_id
type: string
brief: >
Cloud provider-specific native identifier of the monitored cloud resource
(e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS,
a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure,
a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP)
note: |
On some cloud providers, it may not be possible to determine the full ID at startup,
so it may be necessary to set `cloud.resource_id` as a span attribute instead.
The exact value to use for `cloud.resource_id` depends on the cloud provider.
The following well-known definitions MUST be used if you set this attribute and they apply:
* **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
Take care not to use the "invoked ARN" directly but replace any
[alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
with the resolved function version, as the same runtime instance may be invokable with
multiple different aliases.
* **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names)
* **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function,
*not* the function app, having the form
`/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`.
This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share
a TracerProvider.
examples:
- 'arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function'
- '//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID'
- '/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>'
- id: availability_zone
type: string
brief: >
Cloud regions often have multiple, isolated locations known as zones
to increase availability. Availability zone represents the
zone where the resource is running.
note: >
Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
examples: ['us-east-1c']
- id: platform
type:
allow_custom_values: true
members:
- id: alibaba_cloud_ecs
value: 'alibaba_cloud_ecs'
brief: Alibaba Cloud Elastic Compute Service
- id: alibaba_cloud_fc
value: 'alibaba_cloud_fc'
brief: Alibaba Cloud Function Compute
- id: alibaba_cloud_openshift
value: 'alibaba_cloud_openshift'
brief: Red Hat OpenShift on Alibaba Cloud
- id: aws_ec2
value: 'aws_ec2'
brief: AWS Elastic Compute Cloud
- id: aws_ecs
value: 'aws_ecs'
brief: AWS Elastic Container Service
- id: aws_eks
value: 'aws_eks'
brief: AWS Elastic Kubernetes Service
- id: aws_lambda
value: 'aws_lambda'
brief: AWS Lambda
- id: aws_elastic_beanstalk
value: 'aws_elastic_beanstalk'
brief: AWS Elastic Beanstalk
- id: aws_app_runner
value: 'aws_app_runner'
brief: AWS App Runner
- id: aws_openshift
value: 'aws_openshift'
brief: Red Hat OpenShift on AWS (ROSA)
- id: azure_vm
value: 'azure_vm'
brief: Azure Virtual Machines
- id: azure_container_instances
value: 'azure_container_instances'
brief: Azure Container Instances
- id: azure_aks
value: 'azure_aks'
brief: Azure Kubernetes Service
- id: azure_functions
value: 'azure_functions'
brief: Azure Functions
- id: azure_app_service
value: 'azure_app_service'
brief: Azure App Service
- id: azure_openshift
value: 'azure_openshift'
brief: Azure Red Hat OpenShift
- id: gcp_bare_metal_solution
value: 'gcp_bare_metal_solution'
brief: Google Bare Metal Solution (BMS)
- id: gcp_compute_engine
value: 'gcp_compute_engine'
brief: Google Cloud Compute Engine (GCE)
- id: gcp_cloud_run
value: 'gcp_cloud_run'
brief: Google Cloud Run
- id: gcp_kubernetes_engine
value: 'gcp_kubernetes_engine'
brief: Google Cloud Kubernetes Engine (GKE)
- id: gcp_cloud_functions
value: 'gcp_cloud_functions'
brief: Google Cloud Functions (GCF)
- id: gcp_app_engine
value: 'gcp_app_engine'
brief: Google Cloud App Engine (GAE)
- id: gcp_openshift
value: 'gcp_openshift'
brief: Red Hat OpenShift on Google Cloud
- id: ibm_cloud_openshift
value: 'ibm_cloud_openshift'
brief: Red Hat OpenShift on IBM Cloud
- id: tencent_cloud_cvm
value: 'tencent_cloud_cvm'
brief: Tencent Cloud Cloud Virtual Machine (CVM)
- id: tencent_cloud_eks
value: 'tencent_cloud_eks'
brief: Tencent Cloud Elastic Kubernetes Service (EKS)
- id: tencent_cloud_scf
value: 'tencent_cloud_scf'
brief: Tencent Cloud Serverless Cloud Function (SCF)
brief: >
The cloud platform in use.
note: >
The prefix of the service SHOULD match the one specified in `cloud.provider`.