Package io.opentelemetry.semconv.incubating

Class ServiceIncubatingAttributes

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

  • Field Details

    • SERVICE_INSTANCE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_INSTANCE_ID
      The string ID of the service instance.

      Notes:

      MUST be unique for each instance of the same service.namespace,service.name pair (in other words service.namespace,service.name,service.instance.id triplet MUST be globally unique). The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service).

      Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 RFC 4122 UUID, but are free to use an inherent unique ID as the source of this value if stability is desirable. In that case, the ID SHOULD be used as source of a UUID Version 5 and SHOULD use the following UUID as the namespace: 4d63009a-8d0f-11ee-aad7-4c796ed8e320.

      UUIDs are typically recommended, as only an opaque value for the purposes of identifying a service instance is needed. Similar to what can be seen in the man page for the /etc/machine-id file, the underlying data, such as pod name and namespace should be treated as confidential, being the user's choice to expose it or not via another resource attribute.

      For applications running behind an application server (like unicorn), we do not recommend using one identifier for all processes participating in the application. Instead, it's recommended each division (e.g. a worker thread in unicorn) to have its own instance.id.

      It's not recommended for a Collector to set service.instance.id if it can't unambiguously determine the service instance that is generating that telemetry. For instance, creating an UUID based on pod.name will likely be wrong, as the Collector might not know from which container within that pod the telemetry originated. However, Collectors can set the service.instance.id if they can unambiguously determine the service instance for that telemetry. This is typically the case for scraping receivers, as they know the target address and port.

    • SERVICE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_NAME
      Deprecated.
      deprecated in favor of stable ServiceAttributes.SERVICE_NAME attribute.
      Logical name of the service.

      Notes:

      MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to unknown_service: concatenated with process.executable.name, e.g. unknown_service:bash. If process.executable.name is not available, the value MUST be set to unknown_service.

    • SERVICE_NAMESPACE

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_NAMESPACE
      A namespace for service.name.

      Notes:

      A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. service.name is expected to be unique within the same namespace. If service.namespace is not specified in the Resource then service.name is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.

    • SERVICE_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_VERSION
      Deprecated.
      deprecated in favor of stable ServiceAttributes.SERVICE_VERSION attribute.
      The version string of the service API or implementation. The format is not defined by these conventions.