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	Percentage
Description	Percentage of CPU time in use by the container
Labels	Container

ucp_engine_container_cpu_total_time_nanoseconds¶

Units	Nanoseconds
Description	Total CPU time used by the container
Labels	Container

ucp_engine_container_disk_size_rootfs¶

Units	Bytes
Description	Total container disk size
Labels	Container

ucp_engine_container_health¶

Units

0.0 or 1.0

Description

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

Labels

Container

ucp_engine_container_memory_max_usage_bytes¶

Units	Bytes
Description	Maximum memory in use by the container in bytes
Labels	Container

ucp_engine_container_memory_usage_bytes¶

Units	Bytes
Description	Current memory in use by the container in bytes
Labels	Container

ucp_engine_container_memory_usage_percent¶

Units	Percentage
Description	Percentage of total node memory currently in use by the container
Labels	Container

ucp_engine_container_network_rx_bytes_total¶

Units	Bytes
Description	Number of bytes received by the container over the network in the last sample
Labels	Container networking

ucp_engine_container_network_rx_dropped_packets_total¶

Units	Number of packets
Description	Number of packets bound for the container over the network that were dropped in the last sample
Labels	Container networking

ucp_engine_container_network_rx_errors_total¶

Units	Number of errors
Description	Number of received network errors for the container over the network in the last sample
Labels	Container networking

ucp_engine_container_network_rx_packets_total¶

Units	Number of packets
Description	Number of packets received by the container over the network in the last sample
Labels	Container networking

ucp_engine_container_network_tx_bytes_total¶

Units	Bytes
Description	Number of bytes sent by the container over the network in the last sample
Labels	Container networking

ucp_engine_container_network_tx_dropped_packets_total¶

Units	Number of packets
Description	Number of packets sent from the container over the network that were dropped in the last sample
Labels	Container networking

ucp_engine_container_network_tx_errors_total¶

Units	Number of errors
Description	Number of sent network errors for the container on the network in the last sample
Labels	Container networking

ucp_engine_container_network_tx_packets_total¶

Units	Number of packets
Description	Number of sent packets for the container over the network in the last sample
Labels	Container networking

ucp_engine_container_unhealth¶

Units

0.0 or 1.0

Description

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

Labels

Container

ucp_engine_containers¶

Units	Number of containers
Description	Total number of containers on the node
Labels	Node

ucp_engine_cpu_total_time_nanoseconds¶

Units	Nanoseconds
Description	System CPU time used by the container
Labels	Container

ucp_engine_disk_free_bytes¶

Units	Bytes
Description	Free disk space on the Docker root directory on the node, in bytes. This metric is not available to Windows nodes
Labels	Node

ucp_engine_disk_total_bytes¶

Units	Bytes
Description	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
Labels	Node

ucp_engine_images¶

Units	Number of images
Description	Total number of images on the node
Labels	Node

ucp_engine_memory_total_bytes¶

Units	Bytes
Description	Total amount of memory on the node
Labels	Node

ucp_engine_networks¶

Units	Number of networks
Description	Total number of networks on the node
Labels	Node

ucp_engine_num_cpu_cores¶

Units	Number of cores
Description	Number of CPU cores on the node
Labels	Node

ucp_engine_volumes¶

Units	Number of volumes
Description	Total number of volumes on the node
Labels	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	Number of services
Description	Total number of Swarm services
Labels	Not applicable

ucp_engine_node_health¶

Units	0.0 or 1.0
Description	Health status of the node, as determined by MKE
Labels	nodeName: node name, nodeAddr: node IP address

ucp_engine_pod_container_ready¶

Units	0.0 or 1.0
Description	Readiness of the container in a Kubernetes pod, as determined by its readiness probe
Labels	Pod

ucp_engine_pod_ready¶

Units	0.0 or 1.0
Description	Readiness of the container in a Kubernetes pod, as determined by its readiness probe
Labels	Pod