Semantic Conventions for Container Metrics
Status: Experimental
Container Metrics
Metric: container.cpu.time
This metric is opt-in.
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|---|---|---|---|---|
container.cpu.time | Counter | s | Total CPU time consumed [1] |  |
[1]: Total CPU time consumed by the specific container on all available CPU cores
| Attribute | Type | Description | Examples | Requirement Level | Stability |
|---|---|---|---|---|---|
container.cpu.state | string | The CPU state for this data point. A container SHOULD be characterized either by data points with no state labels, or only data points with state labels. | user; kernel | Opt-In | |
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 |
|---|---|---|
user | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). | |
system | When CPU is used by the system (host OS) | |
kernel | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | |
Metric: container.memory.usage
This metric is opt-in.
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|---|---|---|---|---|
container.memory.usage | Counter | By | Memory usage of the container. [1] | |
[1]: Memory usage of the container.
Metric: container.disk.io
This metric is opt-in.
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|---|---|---|---|---|
container.disk.io | Counter | By | Disk bytes for the container. [1] | |
[1]: The total number of bytes read/written successfully (aggregated from all disks).
| Attribute | Type | Description | Examples | Requirement Level | Stability |
|---|---|---|---|---|---|
disk.io.direction | string | The disk IO operation direction. | read | Recommended | |
system.device | string | The device identifier | (identifier) | Recommended | |
disk.io.direction 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 |
|---|---|---|
read | read | |
write | write | |
Metric: container.network.io
This metric is opt-in.
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|---|---|---|---|---|
container.network.io | Counter | By | Network bytes for the container. [1] | |
[1]: The number of bytes sent/received on all network interfaces by the container.
| Attribute | Type | Description | Examples | Requirement Level | Stability |
|---|---|---|---|---|---|
network.io.direction | string | The network IO operation direction. | transmit | Recommended | |
system.device | string | The device identifier | (identifier) | Recommended | |
network.io.direction 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 |
|---|---|---|
transmit | transmit | |
receive | receive | |