Skip to content

Latest commit

 

History

History
102 lines (83 loc) · 9.11 KB

cloud.md

File metadata and controls

102 lines (83 loc) · 9.11 KB

Cloud

Status: Experimental

type: cloud

Description: A cloud environment (e.g. GCP, Azure, AWS)

Attribute Type Description Examples Requirement Level Stability
cloud.account.id string The cloud account ID the resource is assigned to. 111111111111; opentelemetry Recommended Experimental
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 Experimental
cloud.platform string The cloud platform in use. [2] alibaba_cloud_ecs; alibaba_cloud_fc; alibaba_cloud_openshift Recommended Experimental
cloud.provider string Name of the cloud provider. alibaba_cloud; aws; azure Recommended Experimental
cloud.region string The geographical region the resource is running. [3] us-central1; us-east-1 Recommended Experimental
cloud.resource_id string Cloud provider-specific native identifier of the monitored cloud resource (e.g. an ARN on AWS, a fully qualified resource ID on Azure, a 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/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC> Recommended Experimental

[1] cloud.availability_zone: Availability zones are called "zones" on Alibaba Cloud and Google Cloud.

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

[3] cloud.region: Refer to your provider's docs to see the available regions, for example Alibaba Cloud regions, AWS regions, Azure regions, Google Cloud regions, or Tencent Cloud regions.

[4] cloud.resource_id: 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. Take care not to use the "invoked ARN" directly but replace any alias suffix with the resolved function version, as the same runtime instance may be invocable with multiple different aliases.
  • GCP: The URI of the resource
  • Azure: The Fully Qualified Resource ID of the invoked function, not the function app, having the form /subscriptions/<SUBSCRIPTION_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 Stability
alibaba_cloud_ecs Alibaba Cloud Elastic Compute Service Experimental
alibaba_cloud_fc Alibaba Cloud Function Compute Experimental
alibaba_cloud_openshift Red Hat OpenShift on Alibaba Cloud Experimental
aws_app_runner AWS App Runner Experimental
aws_ec2 AWS Elastic Compute Cloud Experimental
aws_ecs AWS Elastic Container Service Experimental
aws_eks AWS Elastic Kubernetes Service Experimental
aws_elastic_beanstalk AWS Elastic Beanstalk Experimental
aws_lambda AWS Lambda Experimental
aws_openshift Red Hat OpenShift on AWS (ROSA) Experimental
azure_aks Azure Kubernetes Service Experimental
azure_app_service Azure App Service Experimental
azure_container_apps Azure Container Apps Experimental
azure_container_instances Azure Container Instances Experimental
azure_functions Azure Functions Experimental
azure_openshift Azure Red Hat OpenShift Experimental
azure_vm Azure Virtual Machines Experimental
gcp_app_engine Google Cloud App Engine (GAE) Experimental
gcp_bare_metal_solution Google Bare Metal Solution (BMS) Experimental
gcp_cloud_functions Google Cloud Functions (GCF) Experimental
gcp_cloud_run Google Cloud Run Experimental
gcp_compute_engine Google Cloud Compute Engine (GCE) Experimental
gcp_kubernetes_engine Google Cloud Kubernetes Engine (GKE) Experimental
gcp_openshift Red Hat OpenShift on Google Cloud Experimental
ibm_cloud_openshift Red Hat OpenShift on IBM Cloud Experimental
tencent_cloud_cvm Tencent Cloud Cloud Virtual Machine (CVM) Experimental
tencent_cloud_eks Tencent Cloud Elastic Kubernetes Service (EKS) Experimental
tencent_cloud_scf Tencent Cloud Serverless Cloud Function (SCF) Experimental

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 Stability
alibaba_cloud Alibaba Cloud Experimental
aws Amazon Web Services Experimental
azure Microsoft Azure Experimental
gcp Google Cloud Platform Experimental
heroku Heroku Platform as a Service Experimental
ibm_cloud IBM Cloud Experimental
tencent_cloud Tencent Cloud Experimental