Package io.opentelemetry.semconv.incubating

Class CloudIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.CloudIncubatingAttributes
public final class CloudIncubatingAttributes extends Object

  • Field Details

    • CLOUD_ACCOUNT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_ACCOUNT_ID
      The cloud account ID the resource is assigned to.

    • CLOUD_AVAILABILITY_ZONE

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_AVAILABILITY_ZONE
      Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running.

      Notes:

      Availability zones are called "zones" on Alibaba Cloud and Google Cloud.

    • CLOUD_PLATFORM

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_PLATFORM
      The cloud platform in use.

      Notes:

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

    • CLOUD_PROVIDER

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_PROVIDER
      Name of the cloud provider.

    • CLOUD_REGION

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_REGION
      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.

      Notes:

      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.

    • CLOUD_RESOURCE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_RESOURCE_ID
      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)

      Notes:

      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.