open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/registry/attributes/container.md

7.4 KiB
Raw Blame History

Container

Container Attributes

A container instance.

Attribute Type Description Examples Stability
container.command string The command used to run the container (i.e. the command name). [1] otelcontribcol Development
container.command_args string[] All the command arguments (including the command/executable itself) run by the container. ["otelcontribcol", "--config", "config.yaml"] Development
container.command_line string The full command run by the container as a single string representing the full command. otelcontribcol --config config.yaml Development
container.csi.plugin.name string The name of the CSI (Container Storage Interface) plugin used by the volume. [2] pd.csi.storage.gke.io Development
container.csi.volume.id string The unique volume ID returned by the CSI (Container Storage Interface) plugin. [3] projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk Development
container.id string Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated. a3bf90e006b2 Development
container.image.id string Runtime specific image identifier. Usually a hash algorithm followed by a UUID. [4] sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f Development
container.image.name string Name of the image the container was built on. gcr.io/opentelemetry/operator Development
container.image.repo_digests string[] Repo digests of the container image as provided by the container runtime. [5] ["example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb", "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"] Development
container.image.tags string[] Container image tags. An example can be found in Docker Image Inspect. Should be only the <tag> section of the full name for example from registry.example.com/my-org/my-image:<tag>. ["v1.27.1", "3.5.7-0"] Development
container.label.<key> string Container labels, <key> being the label name, the value being the label value. [6] nginx Development
container.name string Container name used by container runtime. opentelemetry-autoconf Development
container.runtime string The container runtime managing this container. docker; containerd; rkt Development

[1] container.command: If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage.

[2] container.csi.plugin.name: This can sometimes be referred to as a "driver" in CSI implementations. This should represent the name field of the GetPluginInfo RPC.

[3] container.csi.volume.id: This can sometimes be referred to as a "volume handle" in CSI implementations. This should represent the Volume.volume_id field in CSI spec.

[4] container.image.id: Docker defines a sha256 of the image id; container.image.id corresponds to the Image field from the Docker container inspect API endpoint. K8s defines a link to the container registry repository with digest "imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625". The ID is assigned by the container runtime and can vary in different environments. Consider using oci.manifest.digest if it is important to identify the same image in different environments/runtimes.

[5] container.image.repo_digests: Docker and CRI report those under the RepoDigests field.

[6] container.label.<key>: For example, a docker container label app with value nginx SHOULD be recorded as the container.label.app attribute with value "nginx".

Deprecated Container Attributes

Describes deprecated container attributes.

Attribute Type Description Examples Stability
container.cpu.state string Deprecated, use cpu.mode instead. user; kernel Deprecated
Replaced by cpu.mode.
container.labels.<key> string Deprecated, use container.label instead. nginx Deprecated
Replaced by container.label.

container.cpu.state has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
kernel When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). Development
system When CPU is used by the system (host OS) Development
user When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). Development