Module: OpenTelemetry::SemConv::Incubating::CONTAINER

Defined in:: lib/opentelemetry/semconv/incubating/container/metrics.rb,
lib/opentelemetry/semconv/incubating/container/attributes.rb

Metrics Names collapse

CONTAINER_CPU_TIME =

Note:
Stability Level: development

Total CPU time consumed

Total CPU time consumed by the specific container on all available CPU cores

'container.cpu.time'

CONTAINER_CPU_USAGE =

Note:
Stability Level: development

Container’s CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs

CPU usage of the specific container on all available CPU cores, averaged over the sample window

'container.cpu.usage'

CONTAINER_DISK_IO =

Note:
Stability Level: development

Disk bytes for the container.

The total number of bytes read/written successfully (aggregated from all disks).

'container.disk.io'

CONTAINER_MEMORY_USAGE =

Note:
Stability Level: development

Memory usage of the container.

Memory usage of the container.

'container.memory.usage'

CONTAINER_NETWORK_IO =

Note:
Stability Level: development

Network bytes for the container.

The number of bytes sent/received on all network interfaces by the container.

'container.network.io'

CONTAINER_UPTIME =

Note:
Stability Level: development

The time the container has been running

Instrumentations SHOULD use a gauge with type double and measure uptime in seconds as a floating point number with the highest precision available. The actual accuracy would depend on the instrumentation and operating system.

'container.uptime'

Attribute Names collapse

CONTAINER_COMMAND =

Note:
Stability Level: development

The command used to run the container (i.e. the command name).

If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage.

Examples:

Sample Values

otelcontribcol

'container.command'

CONTAINER_COMMAND_ARGS =

Note:
Stability Level: development

All the command arguments (including the command/executable itself) run by the container.

Examples:

Sample Values

["otelcontribcol", "--config", "config.yaml"]

'container.command_args'

CONTAINER_COMMAND_LINE =

Note:
Stability Level: development

The full command run by the container as a single string representing the full command.

Examples:

Sample Values

otelcontribcol --config config.yaml

'container.command_line'

CONTAINER_CPU_STATE =

Deprecated.
“Replaced by cpu.mode.”, “reason”: “renamed”, “renamed_to”: “cpu.mode”

Note:
Stability Level: development

Deprecated, use cpu.mode instead.

Examples:

Sample Values

user kernel

'container.cpu.state'

CONTAINER_CSI_PLUGIN_NAME =

Note:
Stability Level: development

The name of the CSI (Container Storage Interface) plugin used by the volume.

This can sometimes be referred to as a “driver” in CSI implementations. This should represent the name field of the GetPluginInfo RPC.

Examples:

Sample Values

pd.csi.storage.gke.io

'container.csi.plugin.name'

CONTAINER_CSI_VOLUME_ID =

Note:
Stability Level: development

The unique volume ID returned by the CSI (Container Storage Interface) plugin.

This can sometimes be referred to as a “volume handle” in CSI implementations. This should represent the Volume.volume_id field in CSI spec.

Examples:

Sample Values

projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk

'container.csi.volume.id'

CONTAINER_ID =

Note:
Stability Level: development

Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated.

Examples:

Sample Values

a3bf90e006b2

'container.id'

CONTAINER_IMAGE_ID =

Note:
Stability Level: development

Runtime specific image identifier. Usually a hash algorithm followed by a UUID.

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.

Examples:

Sample Values

sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f

'container.image.id'

CONTAINER_IMAGE_NAME =

Note:
Stability Level: development

Name of the image the container was built on.

Examples:

Sample Values

gcr.io/opentelemetry/operator

'container.image.name'

CONTAINER_IMAGE_REPO_DIGESTS =

Note:
Stability Level: development

Repo digests of the container image as provided by the container runtime.

Docker and CRI report those under the RepoDigests field.

Examples:

Sample Values

["example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb", "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"]

'container.image.repo_digests'

CONTAINER_IMAGE_TAGS =

Note:
Stability Level: development

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

Examples:

Sample Values

["v1.27.1", "3.5.7-0"]

'container.image.tags'

CONTAINER_LABEL_LAMBDA =

Note:
Stability Level: development

Must be called with a key for the full attribute name. See notes below about the expectations for the state of the key.

Container labels, <key> being the label name, the value being the label value.

For example, a docker container label app with value nginx SHOULD be recorded as the container.label.app attribute with value "nginx".

Examples:

Usage

CONTAINER_LABEL_LAMBDA.call('some-cool-key') #=> 'container.label.some-cool-key'

Sample Values

nginx

->(key) { "container.label.#{key}" }

CONTAINER_LABELS_LAMBDA =

Deprecated.
“Replaced by container.label.”, “reason”: “renamed”, “renamed_to”: “container.label”

Note:
Stability Level: development

Must be called with a key for the full attribute name. See notes below about the expectations for the state of the key.

Deprecated, use container.label instead.

Examples:

Usage

CONTAINER_LABELS_LAMBDA.call('some-cool-key') #=> 'container.labels.some-cool-key'

Sample Values

nginx

->(key) { "container.labels.#{key}" }

CONTAINER_NAME =

Note:
Stability Level: development

Container name used by container runtime.

Examples:

Sample Values

opentelemetry-autoconf

'container.name'

CONTAINER_RUNTIME =

Note:
Stability Level: development

The container runtime managing this container.

Examples:

Sample Values

docker containerd rkt

'container.runtime'