Module: OpenTelemetry::SemConv::Incubating::CLOUD

Defined in:

lib/opentelemetry/semconv/incubating/cloud/attributes.rb

Attribute Names

CLOUD_ACCOUNT_ID =

Note:

Stability Level: development

The cloud account ID the resource is assigned to.

Examples:

Sample Values

111111111111
opentelemetry

'cloud.account.id'

CLOUD_AVAILABILITY_ZONE =

Note:

Stability Level: development

Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running.

Availability zones are called “zones” on Alibaba Cloud and Google Cloud.

Examples:

Sample Values

us-east-1c

'cloud.availability_zone'

CLOUD_PLATFORM =

Note:

Stability Level: development

The cloud platform in use.

The prefix of the service SHOULD match the one specified in cloud.provider.

'cloud.platform'

CLOUD_PROVIDER =

Note:

Stability Level: development

Name of the cloud provider.

'cloud.provider'

CLOUD_REGION =

Note:

Stability Level: development

The geographical region within a cloud provider. When associated with a resource, this attribute specifies the region where the resource operates. When calling services or APIs deployed on a cloud, this attribute identifies the region where the called destination is deployed.

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.

Examples:

Sample Values

us-central1
us-east-1

'cloud.region'

CLOUD_RESOURCE_ID =

Note:

Stability Level: development

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)

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.

Examples:

Sample Values

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>

'cloud.resource_id'