Container

Container

Status:

type: container

Description: A container instance.

Other Attributes:

:warning: This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute	Type	Description	Examples	Requirement Level	Stability
container.id	string	Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated.	a3bf90e006b2	Recommended
container.label.<key>	string	Container labels, <key> being the label name, the value being the label value. [1]	nginx	Recommended
container.name	string	Container name used by container runtime.	opentelemetry-autoconf	Recommended
oci.manifest.digest	string	The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. [2]	sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4	Recommended
container.command	string	The command used to run the container (i.e. the command name). [3]	otelcontribcol	Opt-In
container.command_args	string[]	All the command arguments (including the command/executable itself) run by the container.	["otelcontribcol", "--config", "config.yaml"]	Opt-In
container.command_line	string	The full command run by the container as a single string representing the full command.	otelcontribcol --config config.yaml	Opt-In

[1] 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".

[2] oci.manifest.digest: Follows OCI Image Manifest Specification, and specifically the Digest property. An example can be found in Example Image Manifest.

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

Container Image

Status:

type: container.image

Description: The image used for the container.

Other Attributes:

:warning: This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute	Type	Description	Examples	Requirement Level	Stability
container.image.id	string	Runtime specific image identifier. Usually a hash algorithm followed by a UUID. [4]	sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f	Recommended
container.image.name	string	Name of the image the container was built on.	gcr.io/opentelemetry/operator	Recommended
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"]	Recommended
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"]	Recommended

[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.

Container Runtime

Status:

type: container.runtime

Description: The runtime being used to run the container

Identifying Attributes:

Attribute	Type	Description	Examples	Requirement Level	Stability
container.runtime.name	string	The container runtime managing this container.	docker; containerd; rkt	Recommended
container.runtime.version	string	The version of the runtime of this process, as returned by the runtime without modification.	1.0.0	Recommended

Descriptive Attributes:

Attribute	Type	Description	Examples	Requirement Level	Stability
container.runtime.description	string	A description about the runtime which could include, for example details about the CRI/API version being used or other customisations.	docker://19.3.1 - CRI: 1.22.0	Recommended