Skip to content

OVN-Kubernetes control plane metrics

Base metrics are registered by every cluster-manager instance. Functional metrics are registered after the instance wins leader election; they may therefore be absent from a standby instance.

Cluster Manager Metrics

All metrics in this section are rooted at ovnkube_clustermanager_.

Base metrics

Name Type Labels Description
build_info Gauge version, revision, branch, build_user, build_date, goversion Build information. The value is always 1.
leader Gauge None Whether this instance is the leader: 1 for leader and 0 otherwise.
ready_duration_seconds Gauge None Time for the cluster manager to become ready.

Network and subnet metrics

These metrics are registered on the leader.

Name Type Labels Description
num_v4_host_subnets Gauge network_name Total number of possible IPv4 host subnets per network.
num_v6_host_subnets Gauge network_name Total number of possible IPv6 host subnets per network.
allocated_v4_host_subnets Gauge network_name Number of currently allocated IPv4 host subnets per network.
allocated_v6_host_subnets Gauge network_name Number of currently allocated IPv6 host subnets per network.
user_defined_networks Gauge role, topology Number of UserDefinedNetwork resources.
cluster_user_defined_networks Gauge role, topology, transport Number of ClusterUserDefinedNetwork resources. A CUDN is counted once its finalizer is added and uncounted when it is deleted or disappears.
cluster_user_defined_network_condition Gauge name, condition, status CUDN status condition. Both status="true" and status="false" are emitted; the active status is 1. The series of a CUDN are removed when it is deleted or disappears.
udn_nodes_rendered Gauge network_name Number of nodes on which a UDN or CUDN is rendered. Registered only when dynamic UDN allocation is enabled. The series of a CUDN is removed when it is deleted or disappears.
route_advertisement_condition Gauge name, condition, status RouteAdvertisements status condition. The condition label is Accepted or Degraded. Degraded reports failures to generate node configurations or reconcile the RA, as recorded in its status. Both status="true" and status="false" are emitted for each condition; the active status is 1 and the inactive status is 0. Registered only when route advertisements are enabled. The series of a RouteAdvertisements are removed when it is deleted.
vtep_condition Gauge name, condition, status VTEP status condition. Registered only when EVPN is enabled.

Egress IP metrics

These metrics are registered only when EgressIP is enabled.

Name Type Labels Description
num_egress_ips Gauge None Number of defined egress IP addresses.
egress_ips_node_unreachable_total Counter None Number of times assigned egress IPs were unreachable.
egress_ips_rebalance_total Counter None Number of assigned egress IPs moved to a different node.

Scale metrics

These metrics are registered only when --metrics-enable-scale is enabled. The name label on UDN histograms identifies the network.

Name Type Labels Description
udn_update_node_annotation_duration_seconds Histogram name Time spent updating node annotations during UDN network allocation.
udn_nad_sync_duration_seconds Histogram name Time spent syncing NetworkAttachmentDefinitions during UDN reconciliation.
workqueue_depth Gauge name Current workqueue depth.
workqueue_adds_total Counter name Items added to a workqueue.
workqueue_queue_duration_seconds Histogram name Time an item remains queued before processing. Buckets are powers of two from 1ms to ~524s.
workqueue_work_duration_seconds Histogram name Time spent processing an item. Buckets are powers of two from 1ms to ~524s.
workqueue_unfinished_work_seconds Gauge name Total in-progress work not yet observed by the work-duration metric.
workqueue_longest_running_processor_seconds Gauge name Runtime of the longest-running workqueue processor.
workqueue_retries_total Counter name Workqueue retries.

RouteAdvertisements scale metrics

These metrics are registered only when both route advertisements and --metrics-enable-scale are enabled. Except where noted, the name label is the RouteAdvertisements resource name, and its series are removed when the resource is deleted.

Name Type Labels Description
route_advertisement_reconcile_duration_seconds Histogram name, result Time in seconds spent reconciling a RouteAdvertisements resource. The result label is success, error, config_error, or pending.
route_advertisement_frr_configurations Gauge name Number of FRRConfigurations currently generated for a RouteAdvertisements resource. Grows with the number of nodes and selected source FRRConfigurations.
route_advertisement_frr_configuration_processed_total Counter name, op Generated FRRConfigurations processed by a reconcile. The op label is create, update, delete, or unchanged, where unchanged counts objects that were compared and found up to date.
route_advertisement_advertised_prefixes Gauge name, family Number of distinct prefixes in the resource's generated FRRConfigurations. The family label is ipv4 or ipv6.
route_advertisement_nad_updates_total Counter name NetworkAttachmentDefinition annotation updates issued by a RouteAdvertisements reconcile.

After a failed FRRConfiguration write, cluster manager counts the generated objects and prefixes in its informer cache. The gauges can lag behind successful writes from the same pass. The next reconcile refreshes them after the cache catches up. FRR applies these objects asynchronously.

Shared OVN-Kubernetes Metrics

All metrics in this section are rooted at ovnkube_.

Name Type Labels Description
resource_retry_failures_total Counter None Number of Kubernetes resources that reached the maximum reconciliation retry limit and are no longer processed. This family is shared with ovnkube-controller and ovnkube-node.