docker_monitor Metrics

The following article describes the metrics that you can collect with the probe.
uimpga-ga
The following article describes the metrics that you can collect with the probe.
Contents
Metrics for CA Business Intelligence Dashboards
The following metrics must be enabled for the predefined Docker CA Business Intelligence dashboards. These metrics are automatically enabled if the probe is configured with a default template.
QoS Monitors:
  • QOS_DOCKER_CONTAINER_STATUS
  • QOS_DOCKER_CPU_PERCENT_CPU_PCT
  • QOS_DOCKER_TOTALS_NUM_CONTAINERS_COUNT
  • QOS_DOCKER_TOTALS_NUM_ACTIVE_CONTAINERS_COUNT
  • QOS_DOCKER_TOTALS_PERCENT_CPU_PCT
Default Template Settings
This section lists the default monitor and alarm settings in the docker_monitor default template.
Component
Type
QoS Monitor
Alarm
Docker Container
QoS and Alarm
Container Status
If value < 1, then alarm MonitorCritical
Docker CPU
QoS and Alarm
CPU Usage (% of available)
If value > 90 percent, then alarm MonitorCritical
Docker Disk
QoS
Disk Transfer Rate
Docker Host
QoS
Active Container Count
QoS and Alarm
CPU Usage
If value > 90 percent, then alarm MonitorCritical
QoS
Container Count
QoS
Dangling Volumes Count
QoS
Disk Transfer Rate
QoS
Image Count
QoS
Memory Usage
QoS
Memory Usage Percent
QoS
Network Receive Rate
Docker Memory
QoS
Memory Process Group Usage
QoS
Memory Process Group Usage Percentage
Docker Network IO
QoS
Network Usage Receive Rate
Docker Volume
QoS
Dangling Volume
Resource Metrics
The metric in the following table is for monitoring the availability of the Docker environment.
Monitor Name
QoS Name
Unit
Description
Version
Resource Response Time
QOS_RESOURCE_RESPONSE_TIME
milliseconds
This metric is the duration time in milliseconds of last resource collection cycle.
 1.0
Host Metrics
The metrics in the following table are for monitoring the status of a host resource with Docker containers.
Monitor Name
QoS Name
Unit
Description
Version
Active Container Count
QOS_DOCKER_TOTALS_NUM_ACTIVE_CONTAINERS_COUNT
Count
This metric is the number of running containers in Docker.
1.0
Base Device Size 
QOS_DOCKER_BASE_DEVICE_SIZE
GB
This metric specifies the base device size in GB.
1.50
CPU Usage
QOS_DOCKER_TOTALS_PERCENT_CPU_PCT
percentage
This metric is the percent of the CPU time.
1.0
Container Count
QOS_DOCKER_TOTALS_NUM_CONTAINERS_COUNT
Count
This metric is the number of containers in Docker.
1.0
Data Space Available 
QOS_DOCKER_DATA_SPACE_AVAILABLE
GB
This metric specifies the available data space in GB.
1.50
Data Space Total 
QOS_DOCKER_DATA_SPACE_TOTAL
GB
This metric specifies the total data space in GB.
1.50
Data Space Used 
QOS_DOCKER_DATA_SPACE_USED
GB
This metric specifies the used data space in GB.
1.50
Deferred Deleted Device Count
QOS_DOCKER_DEFERRED_DELETED_DEVICE_COUNT
Count
This metric specifies the count of number of Deferred Deleted Devices.
1.50
Deferred Deletion Enabled
QOS_DOCKER_DEFERRED_DELETION_ENABLED
Boolean
This metric specifies whether the deferred deletion is enabled. The values can be true or false.
1.50
Deferred Removal Enabled
QOS_DOCKER_DEFERRED_REMOVAL_ENABLED
Boolean
This metric specifies whether the deferred removal is enabled. The values can be true or false.
1.50
Disk Transfer Rate
QOS_DOCKER_TOTALS_IO_SERVICE_RECURSIVE_TOTAL_RATE
KB/s
This metric is the rate of kilobytes transferred to or from block I/O devices.
1.0
Disk Operation Rate
QOS_DOCKER_TOTALS_IO_SERVICED_RECURSIVE_TOTAL_RATE
Count/s
This metric is the rate of I/O operations that are performed on block I/O devices.
1.0
Dangling Volumes Count
QOS_DOCKER_TOTALS_VOLUMES_DANGLING_COUNT
Count
This metric is the number of dangling volumes.
1.31
Image Store Size
QOS_DOCKER_TOTALS_IMAGE_STORE_SIZE_KB
KB
This metric is the actual image store size, excluding the root file system.
1.0
Image Count
QOS_DOCKER_TOTALS_NUM_IMAGES_COUNT
Count
This metric is the number of images in the local Docker repository.
1.0
Metadata Space Available
QOS_DOCKER_METADATA_SPACE_AVAILABLE
GB
This metric specifies the available space for metadata in GB.
1.50
Metadata Space Total 
QOS_DOCKER_METADATA_SPACE_TOTAL
GB
This metric is the total space for metadata in GB.
1.50
Metadata Space Used 
QOS_DOCKER_METADATA_SPACE_USED
MB
This metric is the used space for metadata in MB.
1.50
Memory Usage
QOS_DOCKER_TOTALS_USAGE_TOTAL_KB
KB
This metric is the memory usage for the process group.
1.0
Memory Usage Percent
QOS_DOCKER_TOTALS_PERCENT_USAGE_PCT
percentage
This metric is the percent of available memory used.
1.20
Network Transmit Rate
QOS_DOCKER_TOTALS_TX_RATE_TOTAL_DOCKER
KB/s
This metric is the rate of packets being transmitted for all Docker containers.
1.0
Network Receive Rate
QOS_DOCKER_TOTALS_RX_RATE_TOTAL_DOCKER
KB/s
This metric is the rate of packets being received for all Docker containers.
1.0
Number of CPU
QOS_DOCKER_NUMBER_OF_CPU
Count
This metric specifies the number of CPU.
1.50
Paused Containers
QOS_DOCKER_PAUSED_CONTAINER
Count
This metric specifies the number of containers which are in paused state.
1.50
Pool Blocksize
QOS_DOCKER_POOL_BLOCKSIZE
KB
This metric specifies the pool blocksize in KB.
1.50
Stopped Containers 
QOS_DOCKER_STOPPED_CONTAINERS
Count
This metric is the number of containers that are in stopped state. See the State metric in the Container Metrics section.
1.50
Thin Pool Minimum Free Space 
QOS_DOCKER_THIN_POOL_MINIMUM_FREE_SPACE
GB
This metric is the minimum thin pool free space size in GB.
1.50
Udev Sync Supported
QOS_DOCKER_UDEV_SYNC_SUPPORT
Boolean
This metric specifies whether udev sync is supported. The values can be true or false.
1.50
Container Metrics
The metric in the following table is for monitoring the availability of a Docker container.
Monitor Name
QoS Name
Unit
Description
Version
Container Status
QOS_DOCKER_CONTAINER_STATUS
State
This metric is the status of the container. You can set up the threshold for status using a numeric value that is assigned a status value, as follows:
  • -1: Unknown
  • 0: Exited
  • 1: Created
  • 2: Paused
  • 3: Restarting
  • 4: Running
1.00
CPU Period Limit
QOS_DOCKER_CONTAINER_LIMIT_CPU_PERIOD
microseconds
This metric is the Limit CPU CFS (Completely Fair Scheduler) period.
1.45
CPU Usage Limit
QOS_DOCKER_CONTAINER_LIMIT_CPU_USAGE
microseconds
This metric is the Limit CPU CFS (Completely Fair Scheduler) quota.
1.45
CPU Throttled Periods Limit
QOS_DOCKER_CONTAINER_LIMIT_CPU_REALTIME_PERIOD
microseconds
This metric is the Limit CPU real-time period in microseconds.
1.45
Memory Limit
QOS_DOCKER_CONTAINER_LIMIT_MEMORY
MB
This metric is the Memory limit.
1.45
Container CPU Metrics
The metrics in the following table are for monitoring CPU utilization by an image in a Docker container.
Monitor Name
QoS Name
Unit
Description
Version
CPU Usage (Total)
QOS_DOCKER_CPU_TOTAL_USAGE_NS
Nanoseconds
This metric is the total usage of CPU by container.
1.00
CPU Usage (System)
QOS_DOCKER_CPU_SYSTEM_CPU_USAGE_NS
Nanoseconds
This metric is the total CPU usage for system.
1.00
CPU Usage (User Mode)
QOS_DOCKER_CPU_USAGE_IN_USERMODE_NS
Nanoseconds
This metric is the total usage of CPU by user mode.
1.00
CPU Usage (Kernel Mode)
QOS_DOCKER_CPU_USAGE_IN_KERNELMODE_NS
Nanoseconds
This metric is the total usage of CPU by kernel functions.
1.00
CPU Periods
QOS_DOCKER_CPU_PERIODS_COUNT
Count
This metric is the number of periods throttled/unthrottled.
1.00
CPU Throttled Periods
QOS_DOCKER_CPU_THROTTLED_PERIODS_COUNT
Count
This metric is the number of throttled periods.
1.00
CPU Throttled Time
QOS_DOCKER_CPU_THROTTLED_TIME_NS
Nanoseconds
This metric is the time spent on throttled periods.
1.00
CPU Usage (% of available)
QOS_DOCKER_CPU_PERCENT_CPU_PCT
percentage
This metric is the percent of the CPU time.
1.00
Container Disk Metrics
The metrics in the following table are for monitoring disk utilization by an image in a Docker container.
Monitor Name
QoS Name
Unit
Description
Version
Disk Total Transfer
QOS_DOCKER_DISK_IO_SERVICE_RECURSIVE_TOTAL_KB
KB
This metric is the number of kilobytes transferred to and from block I/O devices.
1.00
Disk Read
QOS_DOCKER_DISK_IO_SERVICE_RECURSIVE_READ_KB
KB
This metric is the number of kilobytes read from block I/O devices.
1.00
Disk Write
QOS_DOCKER_DISK_IO_SERVICE_RECURSIVE_WRITE_KB
KB
This metric is the number of kilobytes written to block I/O devices.
1.00
Disk Transfer Synchronous
QOS_DOCKER_DISK_IO_SERVICE_RECURSIVE_SYNC_KB
KB
This metric is the number of kilobytes transferred to or from block I/O devices synchronously.
1.00
Disk Transfer Asynchronous
QOS_DOCKER_DISK_IO_SERVICE_RECURSIVE_ASYNC_KB
KB
This metric is the number of kilobytes transferred to or from block I/O devices asynchronously.
1.00
Disk Read/Write Operations
QOS_DOCKER_DISK_IO_SERVICED_RECURSIVE_TOTAL_COUNT
Count
This metric is the number of I/O operations that are performed on block I/O devices.
1.00
Disk Read Operations
QOS_DOCKER_DISK_IO_SERVICED_RECURSIVE_READ_COUNT
Count
This metric is the number of read operations that are performed on block I/O devices.
1.00
Disk Write Operations
QOS_DOCKER_DISK_IO_SERVICED_RECURSIVE_WRITE_COUNT
Count
This metric is the number of write operations that are performed on block I/O devices.
1.00
Disk Synchronous Operations
QOS_DOCKER_DISK_IO_SERVICED_RECURSIVE_SYNC_COUNT
Count
This metric is the number of synchronous I/O operations performed block I/O devices.
1.00
Disk Asynchronous Operations
QOS_DOCKER_DISK_IO_SERVICED_RECURSIVE_ASYNC_COUNT
Count
This metric is the number of asynchronous operations that are performed on specific devices.
1.00
Disk Request
QOS_DOCKER_DISK_IO_SERVICE_TIME_RECURSIVE_TOTAL_NS
Nanoseconds
This metric is the total time between request dispatch and request completion.
1.00
Disk Read Request
QOS_DOCKER_DISK_IO_SERVICE_TIME_RECURSIVE_READ_NS
Nanoseconds
This metric is the total time between read request dispatch and read completion.
1.00
Disk Write Request
QOS_DOCKER_DISK_IO_SERVICE_TIME_RECURSIVE_WRITE_NS
Nanoseconds
This metric is the total time between write request dispatch and write completion.
1.00
Disk Wait
QOS_DOCKER_DISK_IO_WAIT_TIME_RECURSIVE_TOTAL_NS
Nanoseconds
This metric is the total time I/O operations on specific devices by a cgroup spent waiting for service in the scheduler queues.
1.00
Disk Read Wait
QOS_DOCKER_DISK_IO_WAIT_TIME_RECURSIVE_READ_NS
Nanoseconds
This metric is the total time I/O operations spent waiting in read queue.
1.00
Disk Write Wait
QOS_DOCKER_DISK_IO_WAIT_TIME_RECURSIVE_WRITE_NS
Nanoseconds
This metric is the total time I/O operations spent waiting in write queue.
1.00
Disk Access
QOS_DOCKER_DISK_IO_TIME_RECURSIVE_TOTAL_NS
Nanoseconds
This metric reports the time that a group had I/O access to specific devices.
1.00
Disk Access Read
QOS_DOCKER_DISK_IO_TIME_RECURSIVE_READ_NS
Nanoseconds
This metric reports the time that a group read from a block I/O device.
1.00
Disk Access Write
QOS_DOCKER_DISK_IO_TIME_RECURSIVE_WRITE_NS
Nanoseconds
This metric reports the time that a group wrote to a block I/O device.
1.00
Disk Sector
QOS_DOCKER_DISK_SECTORS_RECURSIVE_TOTAL_COUNT
Count
This metric is the number of sectors that are transferred to or from block I/O devices by a cgroup.
1.00
Disk Sector Read
QOS_DOCKER_DISK_SECTORS_RECURSIVE_READ_COUNT
Count
This metric is the number of sectors that are read from block I/O devices by a cgroup.
1.00
Disk Sector Write
QOS_DOCKER_DISK_SECTORS_RECURSIVE_WRITE_COUNT
Count
This metric is the number of sectors that are written to block I/O devices by a cgroup.
1.00
Disk Transfer Rate
QOS_DOCKER_DISK_IO_SERVICE_RECURSIVE_TOTAL_RATE
KB/s
This metric is the total rate of kilobytes transferred to or from block I/O devices.
1.00
Disk Operation Rate
QOS_DOCKER_DISK_IO_SERVICED_RECURSIVE_TOTAL_RATE
Count/s
This metric is the total rate of I/O operations that are performed on block I/O devices.
1.00
Container Memory Metrics
The metrics in the following table are for monitoring memory utilization by an image in a Docker container.
Monitor Name
QoS Name
Unit
Description
Version
Memory Anonymous Active
QOS_DOCKER_MEMORY_ACTIVE_ANON_KB
KB
This metric is the amount of anonymous memory declared active by kernel for the process group.
1.00
Memory Disk Mapped Cache Active
QOS_DOCKER_MEMORY_ACTIVE_FILE_KB
KB
This metric is the amount of cache memory that is mapped and declared active for the process group.
1.00
Memory Cache
QOS_DOCKER_MEMORY_CACHE_KB
KB
This metric is the amount of memory used that can be associated precisely with a block on a block device.
1.00
Memory Usage Limit
QOS_DOCKER_MEMORY_HIERARCHICAL_MEMORY_LIMIT_KB
KB
This metric is the memory limit for the process group and sub groups.
1.00
Memory Anonymous Inactive
QOS_DOCKER_MEMORY_INACTIVE_ANON_KB
KB
This metric is the amount of anonymous memory declared inactive by kernel for the process group.
1.00
Memory Cache Inactive
QOS_DOCKER_MEMORY_INACTIVE_FILE_KB
KB
This metric is the amount of cache memory that is mapped but declared inactive for the process group.
1.00
Memory Mapped
QOS_DOCKER_MEMORY_MAPPED_FILE_KB
KB
This metric is the amount of memory that is mapped by the process group.
1.00
Memory Peak Usage
QOS_DOCKER_MEMORY_MAX_USAGE_KB
KB
This metric is the maximum memory usage recorded.
1.00
Memory Page Faults
QOS_DOCKER_MEMORY_PGFAULT_COUNT
Count
This metric is the number of page faults triggered.
1.00
Memory Major Faults
QOS_DOCKER_MEMORY_PGMAJFAULT_COUNT
Count
This metric is the amount of major faults that are triggered by the process group.
1.00
Memory Charge Events
QOS_DOCKER_MEMORY_PGPGIN_COUNT
Count
This metric is the number of memory charge events (memory pages accounted for) by the process group.
1.00
Memory Uncharge Events
QOS_DOCKER_MEMORY_PGPGOUT_COUNT
Count
This metric is the number of memory uncharge events (memory pages that are no longer accounted for) by the process.
1.00
Memory Unmapped
QOS_DOCKER_MEMORY_RSS_KB
KB
This metric is the amount of memory that does not correspond to anything on disk.
1.00
Memory Huge Pages
QOS_DOCKER_MEMORY_RSS_HUGE_KB
KB
This metric is the amount of memory that corresponds to huge pages.
1.00
Memory Process Group Anonymous Active
QOS_DOCKER_MEMORY_TOTAL_ACTIVE_ANON_KB
KB
This metric is the amount of anonymous memory declared active by kernel for the process group (including subgroups).
1.00
Memory Process Group Anonymous
QOS_DOCKER_MEMORY_TOTAL_ACTIVE_FILE_KB
KB
This metric is the amount of cache memory that is mapped and active for the process group (including subgroups).
1.00
Memory Process Group Cache
QOS_DOCKER_MEMORY_TOTAL_CACHE_KB
KB
This metric is the amount of cache for the process group and all subgroups in total.
1.00
Memory Process Group Anonymous Inactive
QOS_DOCKER_MEMORY_TOTAL_INACTIVE_ANON_KB
KB
This metric is the amount of anonymous memory declared inactive by kernel for the process group (including subgroups).
1.00
Memory Process Group
QOS_DOCKER_MEMORY_TOTAL_INACTIVE_FILE_KB
KB
This metric is the amount of cache memory that is mapped but declared inactive for the process group (including subgroups).
1.00
Memory Process Group Mapped
QOS_DOCKER_MEMORY_TOTAL_MAPPED_FILE_KB
KB
This metric is the amount of memory that is mapped for cache (including subgroups).
1.00
Memory Process Group Page Faults
QOS_DOCKER_MEMORY_TOTAL_PGFAULT_COUNT
Count
This metric is the number of page faults that are triggered by the process group(including subgroups).
1.00
Memory Process Group Major Faults
QOS_DOCKER_MEMORY_TOTAL_PGMAJFAULT_COUNT
Count
This metric is the amount of major faults that are triggered by the process group (including subgroups).
1.00
Memory Process Group Charge Events
QOS_DOCKER_MEMORY_TOTAL_PGPGIN_COUNT
Count
This metric is the number of charge events for the process group (including subgroups).
1.00
Memory Process Group Uncharge Events
QOS_DOCKER_MEMORY_TOTAL_PGPGOUT_COUNT
Count
This metric is the total number of uncharging events for the process group (including subgroups).
1.00
Memory Process Group Unmapped
QOS_DOCKER_MEMORY_TOTAL_RSS_KB
KB
This metric is the amount of memory that does not correspond to anything on disk for the process group (including subgroups).
1.00
Memory Process Group Huge Pages
QOS_DOCKER_MEMORY_TOTAL_RSS_HUGE_KB
KB
This metric is the amount of memory that corresponds to huge pages.
1.00
Memory Process Group Locked
QOS_DOCKER_MEMORY_TOTAL_UNEVICTABLE_KB
KB
This metric is the amount of locked memory that cannot be reclaimed for the process group (including subgroups).
1.00
Memory Process Group Writeback
QOS_DOCKER_MEMORY_TOTAL_WRITEBACK_KB
KB
This metric is the amount of writeback from memory for the process group (including subgroups).
1.00
Memory Locked
QOS_DOCKER_MEMORY_UNEVICTABLE_KB
KB
This metric is the amount of locked memory that cannot be reclaimed.
1.00
Memory Process Group Usage
QOS_DOCKER_MEMORY_USAGE_KB
KB
This metric is the memory usage for the process group.
1.00
Memory Writeback
QOS_DOCKER_MEMORY_WRITEBACK_KB
KB
This metric is the amount of writeback from memory.
1.00
Memory Process Group Usage Percentage
QOS_DOCKER_MEMORY_USAGE_PERCENT
percentage
This metric is the memory usage percentage for the process group.
1.00
Container Network Metrics
The metrics in the following table are for monitoring network utilization by an image in a Docker container.
Monitor Name
QoS Name
Unit
Description
Version
Network Usage Transmit Rate
QOS_DOCKER_NETWORK_TX_RATE
KB/s
This metric is the rate at which data was transmitted.
1.00
Network Usage Receive Rate
QOS_DOCKER_NETWORK_RX_RATE
KB/s
This metric is the rate at which data was received.
1.00
Network Usage Received
QOS_DOCKER_NETWORK_RX_KB
KB
This metric is the number of kilobytes received.
1.00
Network Usage Transmitted
QOS_DOCKER_NETWORK_TX_KB
KB
This metric is the number of kilobytes transmitted.
1.00
Network Packets Received
QOS_DOCKER_NETWORK_RX_PACKETS_COUNT
Count
This metric is the number of packets received.
1.00
Network Packets Transmitted
QOS_DOCKER_NETWORK_TX_PACKETS_COUNT
Count
This metric is the number of packets transmitted.
1.00
Network Receive Packets Dropped
QOS_DOCKER_NETWORK_RX_DROPPED_COUNT
Count
This metric is the number of received packets dropped.
1.00
Network Transmit Packets Dropped
QOS_DOCKER_NETWORK_TX_DROPPED_COUNT
Count
This metric is the number of transmitted packets dropped.
1.00
Network Receive Errors
QOS_DOCKER_NETWORK_RX_ERRORS_COUNT
Count
This metric is the number of receives in error.
1.00
Network Transmit Errors
QOS_DOCKER_NETWORK_TX_ERRORS_COUNT
Count
This metric is the number of transmits in error.
1.00
Container Process Metrics
The metrics in the following table are for monitoring the status of commands running a process in a Docker container.
Monitor Name
QoS Name
Unit
Description
Version
Process Active
QOS_DOCKER_CONTAINER_PROCESS_ACTIVE
Boolean
This metric report true if one or more processes with the command is active. If no processes are active, it reports false.
1.00
Process Count
QOS_DOCKER_CONTAINER_PROCESS_COUNT
Count
This metric is the number of active processes running that match the given command name.
1.01
Image Metrics
The metrics in the following table are for monitoring the availability of Docker images.
Monitor Name
QoS Name
Unit
Description
Version
Running Containers
QOS_DOCKER_IMAGE_RUNNING_CONTAINER_COUNT
Count
This metric is the number of running containers that use the image.
1.31
Image Size
QOS_DOCKER_IMAGE_SIZE_KB
KB
This metric is the size of the image in kilobytes.
1.31
Volume Metrics
The metric in the following table is for monitoring the status of Docker volumes.
Monitor Name
QoS Name
Unit
Description
Version
Dangling Volume
QOS_DOCKER_VOLUME_DANGLING
boolean
The metric determines if the storage volume is unused. A value of true indicates a dangling volume.
1.31