ob-col/receiver/dockerstatsreceiver/documentation.md

docker_stats

Default Metrics

The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

metrics:
  <metric_name>:
    enabled: false

container.blockio.io_service_bytes_recursive

Number of bytes transferred to/from the disk by the group and descendant groups.

More docs for cgroups v1 and cgroups v2

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.cpu.usage.kernelmode

Time spent by tasks of the cgroup in kernel mode (Linux). Time spent by all container processes in kernel mode (Windows).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

container.cpu.usage.total

Total CPU time consumed.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

container.cpu.usage.usermode

Time spent by tasks of the cgroup in user mode (Linux). Time spent by all container processes in user mode (Windows).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

container.cpu.utilization

Percent of CPU used by the container.

Unit	Metric Type	Value Type
1	Gauge	Double

container.memory.file

Amount of memory used to cache filesystem data, including tmpfs and shared memory (Only available with cgroups v2).

More docs

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.percent

Percentage of memory used.

Unit	Metric Type	Value Type
1	Gauge	Double

container.memory.total_cache

Total amount of memory used by the processes of this cgroup (and descendants) that can be associated with a block on a block device. Also accounts for memory used by tmpfs (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.usage.limit

Memory limit of the container.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.usage.total

Memory usage of the container. This excludes the cache.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.network.io.usage.rx_bytes

Bytes received by the container.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.network.io.usage.rx_dropped

Incoming packets dropped.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{packets}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.network.io.usage.tx_bytes

Bytes sent.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.network.io.usage.tx_dropped

Outgoing packets dropped.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{packets}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

Optional Metrics

The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:

metrics:
  <metric_name>:
    enabled: true

container.blockio.io_merged_recursive

Number of bios/requests merged into requests belonging to this cgroup and its descendant cgroups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.blockio.io_queued_recursive

Number of requests queued up for this cgroup and its descendant cgroups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.blockio.io_service_time_recursive

Total amount of time in nanoseconds between request dispatch and request completion for the IOs done by this cgroup and descendant cgroups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.blockio.io_serviced_recursive

Number of IOs (bio) issued to the disk by the group and descendant groups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.blockio.io_time_recursive

Disk time allocated to cgroup (and descendant cgroups) per device in milliseconds (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ms	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.blockio.io_wait_time_recursive

Total amount of time the IOs for this cgroup (and descendant cgroups) spent waiting in the scheduler queues for service (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.blockio.sectors_recursive

Number of sectors transferred to/from disk by the group and descendant groups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{sectors}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
device_major	Device major number for block IO operations.	Any Str
device_minor	Device minor number for block IO operations.	Any Str
operation	Type of BlockIO operation.	Any Str

container.cpu.limit

CPU limit set for the container.

This metric is only reported if the container has limits set with -cpus, -cpuset-cpus or -cpu-quota.

Unit	Metric Type	Value Type
{cpus}	Gauge	Double

container.cpu.shares

CPU shares set for the container.

Unit	Metric Type	Value Type
1	Gauge	Int

container.cpu.throttling_data.periods

Number of periods with throttling active.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{periods}	Sum	Int	Cumulative	true

container.cpu.throttling_data.throttled_periods

Number of periods when the container hits its throttling limit.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{periods}	Sum	Int	Cumulative	true

container.cpu.throttling_data.throttled_time

Aggregate time the container was throttled.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

container.cpu.usage.percpu

Per-core CPU usage by the container (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
core	The CPU core number when utilising per-CPU metrics.	Any Str

container.cpu.usage.system

System CPU usage, as reported by docker.

Note this is the usage for the system, not the container.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
ns	Sum	Int	Cumulative	true

container.memory.active_anon

The amount of anonymous memory that has been identified as active by the kernel.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.active_file

Cache memory that has been identified as active by the kernel.

More docs

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.anon

Amount of memory used in anonymous mappings such as brk(), sbrk(), and mmap(MAP_ANONYMOUS) (Only available with cgroups v2).

More docs

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.cache

The amount of memory used by the processes of this control group that can be associated precisely with a block on a block device (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.dirty

Bytes that are waiting to get written back to the disk, from this cgroup (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.hierarchical_memory_limit

The maximum amount of physical memory that can be used by the processes of this control group (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.hierarchical_memsw_limit

The maximum amount of RAM + swap that can be used by the processes of this control group (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.inactive_anon

The amount of anonymous memory that has been identified as inactive by the kernel.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.inactive_file

Cache memory that has been identified as inactive by the kernel.

More docs

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.mapped_file

Indicates the amount of memory mapped by the processes in the control group (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.pgfault

Indicate the number of times that a process of the cgroup triggered a page fault.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{faults}	Sum	Int	Cumulative	true

container.memory.pgmajfault

Indicate the number of times that a process of the cgroup triggered a major fault.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{faults}	Sum	Int	Cumulative	true

container.memory.pgpgin

Number of pages read from disk by the cgroup (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

container.memory.pgpgout

Number of pages written to disk by the cgroup (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

container.memory.rss

The amount of memory that doesn’t correspond to anything on disk: stacks, heaps, and anonymous memory maps (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.rss_huge

Number of bytes of anonymous transparent hugepages in this cgroup (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_active_anon

The amount of anonymous memory that has been identified as active by the kernel. Includes descendant cgroups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_active_file

Cache memory that has been identified as active by the kernel. Includes descendant cgroups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_dirty

Bytes that are waiting to get written back to the disk, from this cgroup and descendants (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_inactive_anon

The amount of anonymous memory that has been identified as inactive by the kernel. Includes descendant cgroups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_inactive_file

Cache memory that has been identified as inactive by the kernel. Includes descendant cgroups (Only available with cgroups v1).

More docs.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_mapped_file

Indicates the amount of memory mapped by the processes in the control group and descendant groups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_pgfault

Indicate the number of times that a process of the cgroup (or descendant cgroups) triggered a page fault (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{faults}	Sum	Int	Cumulative	true

container.memory.total_pgmajfault

Indicate the number of times that a process of the cgroup (or descendant cgroups) triggered a major fault (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{faults}	Sum	Int	Cumulative	true

container.memory.total_pgpgin

Number of pages read from disk by the cgroup and descendant groups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

container.memory.total_pgpgout

Number of pages written to disk by the cgroup and descendant groups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{operations}	Sum	Int	Cumulative	true

container.memory.total_rss

The amount of memory that doesn’t correspond to anything on disk: stacks, heaps, and anonymous memory maps. Includes descendant cgroups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_rss_huge

Number of bytes of anonymous transparent hugepages in this cgroup and descendant cgroups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_unevictable

The amount of memory that cannot be reclaimed. Includes descendant cgroups (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.total_writeback

Number of bytes of file/anon cache that are queued for syncing to disk in this cgroup and descendants (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.unevictable

The amount of memory that cannot be reclaimed.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.usage.max

Maximum memory usage.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.memory.writeback

Number of bytes of file/anon cache that are queued for syncing to disk in this cgroup (Only available with cgroups v1).

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
By	Sum	Int	Cumulative	false

container.network.io.usage.rx_errors

Received errors.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{errors}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.network.io.usage.rx_packets

Packets received.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{packets}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.network.io.usage.tx_errors

Sent errors.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{errors}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.network.io.usage.tx_packets

Packets sent.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{packets}	Sum	Int	Cumulative	true

Attributes

Name	Description	Values
interface	Network interface.	Any Str

container.pids.count

Number of pids in the container's cgroup.

It requires docker API 1.23 or higher and kernel version >= 4.3 with pids cgroup supported. More docs

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{pids}	Sum	Int	Cumulative	false

container.pids.limit

Maximum number of pids in the container's cgroup.

It requires docker API 1.23 or higher and kernel version >= 4.3 with pids cgroup supported. More docs

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{pids}	Sum	Int	Cumulative	false

container.restarts

Number of restarts for the container.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{restarts}	Sum	Int	Cumulative	true

container.uptime

Time elapsed since container start time.

Unit	Metric Type	Value Type
s	Gauge	Double

Resource Attributes

Name	Description	Values	Enabled
container.command_line	The full command executed by the container.	Any Str	false
container.hostname	The hostname of the container.	Any Str	true
container.id	The ID of the container.	Any Str	true
container.image.id	The ID of the container image.	Any Str	false
container.image.name	The name of the docker image in use by the container.	Any Str	true
container.name	The name of the container.	Any Str	true
container.runtime	The runtime of the container. For this receiver, it will always be 'docker'.	Any Str	true