-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move cloud attributes to the registry (#453)
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
- Loading branch information
1 parent
a2bbcc3
commit ed054bc
Showing
7 changed files
with
280 additions
and
181 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.