You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The URL of the OpenTelemetry schema for these keys and values.
24
24
"""
@@ -161,6 +161,26 @@ class ResourceAttributes:
161
161
Note: See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.
The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable.
The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable.
172
+
"""
173
+
174
+
GCP_GCE_INSTANCE_NAME="gcp.gce.instance.name"
175
+
"""
176
+
The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm).
Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
227
+
Note: Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) endpoint.
228
+
K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`.
229
+
OCI defines a digest of manifest.
230
+
"""
231
+
232
+
CONTAINER_COMMAND="container.command"
233
+
"""
234
+
The command used to run the container (i.e. the command name).
235
+
Note: If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage.
236
+
"""
237
+
238
+
CONTAINER_COMMAND_LINE="container.command_line"
239
+
"""
240
+
The full command run by the container as a single string representing the full command. [2].
241
+
"""
242
+
243
+
CONTAINER_COMMAND_ARGS="container.command_args"
244
+
"""
245
+
All the command arguments (including the command/executable itself) run by the container. [2].
246
+
"""
247
+
204
248
DEPLOYMENT_ENVIRONMENT="deployment.environment"
205
249
"""
206
250
Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier).
@@ -236,7 +280,7 @@ class ResourceAttributes:
236
280
Note: This is the name of the function as configured/deployed on the FaaS
237
281
platform and is usually different from the name of the callback
VM image ID. For Cloud, this value is from the provider.
351
+
VM image ID or host OS image ID. For Cloud, this value is from the provider.
308
352
"""
309
353
310
354
HOST_IMAGE_VERSION="host.image.version"
311
355
"""
312
-
The version string of the VM image as defined in [Version Attributes](README.md#version-attributes).
356
+
The version string of the VM image or host OS as defined in [Version Attributes](README.md#version-attributes).
313
357
"""
314
358
315
359
K8S_CLUSTER_NAME="k8s.cluster.name"
316
360
"""
317
361
The name of the cluster.
318
362
"""
319
363
364
+
K8S_CLUSTER_UID="k8s.cluster.uid"
365
+
"""
366
+
A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace.
367
+
Note: K8s does not have support for obtaining a cluster ID. If this is ever
368
+
added, we will recommend collecting the `k8s.cluster.uid` through the
369
+
official APIs. In the meantime, we are able to use the `uid` of the
370
+
`kube-system` namespace as a proxy for cluster ID. Read on for the
371
+
rationale.
372
+
373
+
Every object created in a K8s cluster is assigned a distinct UID. The
374
+
`kube-system` namespace is used by Kubernetes itself and will exist
375
+
for the lifetime of the cluster. Using the `uid` of the `kube-system`
376
+
namespace is a reasonable proxy for the K8s ClusterID as it will only
377
+
change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are
378
+
UUIDs as standardized by
379
+
[ISO/IEC 9834-8 and ITU-T X.667](https://www.itu.int/ITU-T/studygroups/com17/oid.html).
380
+
Which states:
381
+
382
+
> If generated according to one of the mechanisms defined in Rec.
383
+
ITU-T X.667 | ISO/IEC 9834-8, a UUID is either guaranteed to be
384
+
different from all other UUIDs generated before 3603 A.D., or is
385
+
extremely likely to be different (depending on the mechanism chosen).
386
+
387
+
Therefore, UIDs between clusters should be extremely unlikely to
388
+
conflict.
389
+
"""
390
+
320
391
K8S_NODE_NAME="k8s.node.name"
321
392
"""
322
393
The name of the Node.
@@ -429,7 +500,7 @@ class ResourceAttributes:
429
500
430
501
OS_VERSION="os.version"
431
502
"""
432
-
The version string of the operating system as defined in [Version Attributes](../../resource/semantic_conventions/README.md#version-attributes).
503
+
The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes).
433
504
"""
434
505
435
506
PROCESS_PID="process.pid"
@@ -493,6 +564,11 @@ class ResourceAttributes:
493
564
Note: 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`](process.md#process), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
494
565
"""
495
566
567
+
SERVICE_VERSION="service.version"
568
+
"""
569
+
The version string of the service API or implementation. The format is not defined by these conventions.
570
+
"""
571
+
496
572
SERVICE_NAMESPACE="service.namespace"
497
573
"""
498
574
A namespace for `service.name`.
@@ -505,14 +581,15 @@ class ResourceAttributes:
505
581
Note: 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). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this attribute it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations).
506
582
"""
507
583
508
-
SERVICE_VERSION="service.version"
509
-
"""
510
-
The version string of the service API or implementation.
511
-
"""
512
-
513
584
TELEMETRY_SDK_NAME="telemetry.sdk.name"
514
585
"""
515
586
The name of the telemetry SDK as defined above.
587
+
Note: The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`.
588
+
If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the
589
+
`telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point
590
+
or another suitable identifier depending on the language.
591
+
The identifier `opentelemetry` is reserved and MUST NOT be used in this case.
592
+
All custom identifiers SHOULD be stable across different versions of an implementation.
516
593
"""
517
594
518
595
TELEMETRY_SDK_LANGUAGE="telemetry.sdk.language"
@@ -645,6 +722,9 @@ class CloudPlatformValues(Enum):
645
722
AZURE_OPENSHIFT="azure_openshift"
646
723
"""Azure Red Hat OpenShift."""
647
724
725
+
GCP_BARE_METAL_SOLUTION="gcp_bare_metal_solution"
726
+
"""Google Bare Metal Solution (BMS)."""
727
+
648
728
GCP_COMPUTE_ENGINE="gcp_compute_engine"
649
729
"""Google Cloud Compute Engine (GCE)."""
650
730
@@ -773,8 +853,11 @@ class TelemetrySdkLanguageValues(Enum):
0 commit comments