Home
Operations Guide
Administer an MKE cluster
Collect MKE cluster metrics with Prometheus
Core MKE metrics
Core MKE metrics
MKE exports metrics on every node and also exports additional metrics
from every controller.
Node-sourced MKE metrics
The metrics that MKE exports from nodes are specific to those nodes (for
example, the total memory on that node).
The tables below offer detail on the node-sourced metrics that MKE
exposes in Prometheus with the ucp_ label.
ucp_engine_container_cpu_percent
Units
Description
Labels
Percentage
Percentage of CPU time in use by the container
Container
ucp_engine_container_cpu_total_time_nanoseconds
Units
Description
Labels
Nanoseconds
Total CPU time used by the container
Container
ucp_engine_container_disk_size_rootfs
Units
Description
Labels
Bytes
Total container disk size
Container
ucp_engine_container_health
Units
Description
Labels
0.0 or 1.0
The container health, according to its healthcheck. The 0 value indicates that the container is not reporting as healthy, which is likely because it either does not have a healthcheck defined or because healthcheck results have not yet been returned
Container
ucp_engine_container_memory_max_usage_bytes
Units
Description
Labels
Bytes
Maximum memory in use by the container in bytes
Container
ucp_engine_container_memory_usage_bytes
Units
Description
Labels
Bytes
Current memory in use by the container in bytes
Container
ucp_engine_container_memory_usage_percent
Units
Description
Labels
Percentage
Percentage of total node memory currently in use by the container
Container
ucp_engine_container_network_rx_bytes_total
Units
Description
Labels
Bytes
Number of bytes received by the container over the network in the last sample
Container networking
ucp_engine_container_network_rx_dropped_packets_total
Units
Description
Labels
Number of packets
Number of packets bound for the container over the network that were dropped in the last sample
Container networking
ucp_engine_container_network_rx_errors_total
Units
Description
Labels
Number of errors
Number of received network errors for the container over the network in the last sample
Container networking
ucp_engine_container_network_rx_packets_total
Units
Description
Labels
Number of packets
Number of packets received by the container over the network in the last sample
Container networking
ucp_engine_container_network_tx_bytes_total
Units
Description
Labels
Bytes
Number of bytes sent by the container over the network in the last sample
Container networking
ucp_engine_container_network_tx_dropped_packets_total
Units
Description
Labels
Number of packets
Number of packets sent from the container over the network that were dropped in the last sample
Container networking
ucp_engine_container_network_tx_errors_total
Units
Description
Labels
Number of errors
Number of sent network errors for the container on the network in the last sample
Container networking
ucp_engine_container_network_tx_packets_total
Units
Description
Labels
Number of packets
Number of sent packets for the container over the network in the last sample
Container networking
ucp_engine_container_unhealth
Units
Description
Labels
0.0 or 1.0
Indicates whether the container is healthy, according to its healthcheck. The 0 value indicates that the container is not reporting as healthy, which is likely because it either does not have a healthcheck defined or because healthcheck results have not yet been returned
Container
ucp_engine_containers
Units
Description
Labels
Number of containers
Total number of containers on the node
Node
ucp_engine_cpu_total_time_nanoseconds
Units
Description
Labels
Nanoseconds
System CPU time used by the container
Container
ucp_engine_disk_free_bytes
Units
Description
Labels
Bytes
Free disk space on the Docker root directory on the node, in bytes. This metric is not available to Windows nodes
Node
ucp_engine_disk_total_bytes
Units
Description
Labels
Bytes
Total disk space on the Docker root directory on this node in bytes. Note that the ucp_engine_disk_free_bytes metric is not available for Windows nodes
Node
ucp_engine_images
Units
Description
Labels
Number of images
Total number of images on the node
Node
ucp_engine_memory_total_bytes
Units
Description
Labels
Bytes
Total amount of memory on the node
Node
ucp_engine_networks
Units
Description
Labels
Number of networks
Total number of networks on the node
Node
ucp_engine_num_cpu_cores
Units
Description
Labels
Number of cores
Number of CPU cores on the node
Node
ucp_engine_volumes
Units
Description
Labels
Number of volumes
Total number of volumes on the node
Node
Controller-sourced MKE metrics
The metrics that MKE exports from controllers are cluster-scoped (for example,
the total number of Swarm services).
The tables below offer detail on the controller-sourced metrics that MKE
exposes in Prometheus with the ucp_ label.
ucp_controller_services
Units
Description
Labels
Number of services
Total number of Swarm services
Not applicable
ucp_engine_node_health
Units
Description
Labels
0.0 or 1.0
Health status of the node, as determined by MKE
nodeName: node name, nodeAddr: node IP address
ucp_engine_pod_container_ready
Units
Description
Labels
0.0 or 1.0
Readiness of the container in a Kubernetes pod, as determined by its readiness probe
Pod
ucp_engine_pod_ready
Units
Description
Labels
0.0 or 1.0
Readiness of the container in a Kubernetes pod, as determined by its readiness probe
Pod
Previous
Metrics labels
Next
MKE component metrics