OpenTelemetry Core Concepts: Attributes and Labels
Key:value pairs can be used to affix metadata to spans, events, metrics, and distributed contexts in order to query, filter, and further analyze trace data. Depending on the resource (span, event, or metric), the OpenTelemetry documentation may refer to these key:values as
Attributes and labels should apply to the entirety of the resource they are describing.
Let’s take a closer look at the Resource Conventions document for definitions of standard attributes for OpenTelemtry’s data resources.
Attributes are grouped logically by the type of the concept that they described. Attributes in the same group have a common prefix that ends with a dot. For example all attributes that describe Kubernetes properties start with
Certain attribute groups in this document have a Required column. For these groups if any attribute from the particular group is present in the Resource then all attributes that are marked as Required MUST be also present in the Resource. However it is also valid if the entire attribute group is omitted (i.e. none of the attributes from the particular group are present even though some of them are marked as Required in this document).
Description: A service instance.
|service.name||Logical name of the service.|
MUST be the same for all instances of horizontally scaled services.
|service.namespace||A namespace for |
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.instance.id||The string ID of the service instance.|
MUST be unique for each instance of the same
|service.version||The version string of the service API or implementation as defined in Version Attributes.||No|
service.name are not intended to be concatenated for the purpose of forming a single globally unique name for the service. For example the following 2 sets of attributes actually describe 2 different services (despite the fact that the concatenation would result in the same string).
# Resource attributes that describe a service. namespace = Company.Shop service.name = shoppingcart
# Another set of resource attributes that describe a different service. namespace = Company service.name = Shop.shoppingcart
Description: Telemetry library information.
|library.name||The name of the telemetry library.||No|
|library.language||The language of telemetry library and of the code instrumented with it.|
The following spelling SHOULD be used for language strings: "cpp", "dotnet", "erlang", "go", "java", "nodejs", "php", "python", "ruby", "webjs"
|library.version||The version string of the library as defined in Version Attributes.||No|
Attributes defining a compute unit (e.g. Container, Process, Lambda Function).
Description: A container instance.
|container.image.name||Name of the image the container was built on.|
|container.image.tag||Container image tag.|
Attributes defining a deployment service (e.g. Kubernetes).
Description: A Kubernetes resource.
|k8s.cluster.name||The name of the cluster that the pod is running in.|
|k8s.namespace.name||The name of the namespace that the pod is running in.|
|k8s.pod.name||The name of the pod.|
|k8s.deployment.name||The name of the deployment.|
Attributes defining a computing instance (e.g. host).
Description: A host is defined as a general computing instance.
|host.hostname||Hostname of the host.|
It contains what the
|host.id||Unique host id.|
For Cloud this must be the instance_id assigned by the cloud provider
|host.name||Name of the host.|
It may contain what
|host.type||Type of host.|
For Cloud this must be the machine type.
|host.image.name||Name of the VM image or OS install the host was instantiated from.|
|host.image.id||VM image id. For Cloud, this value is from the provider.|
|host.image.version||The version string of the VM image as defined in Version Attributes.|
Attributes defining a running environment (e.g. Cloud, Data Center).
Description: A cloud infrastructure (e.g. GCP, Azure, AWS).
|cloud.provider||Name of the cloud provider.|
Example values are aws, azure, gcp.
|cloud.account.id||The cloud account id used to identify different entities.|
|cloud.region||A specific geographical location where different entities can run|
|cloud.zone||Zones are a sub set of the region connected through low-latency links.|
In aws it is called availability-zone.
Version attributes such as
library.version are values of type
string, with naming schemas hinting at the type of a version, such as the following:
semver:1.2.3(a semantic version)
git:8ae73a(a git sha hash)
0.0.4.2.20190921(a untyped version)
The type and version value MUST be separated by a colon character