Skip to content

Latest commit

 

History

History
134 lines (86 loc) · 4.82 KB

metrics.md

File metadata and controls

134 lines (86 loc) · 4.82 KB
Raw

Exposed Metrics

Sometimes the Help text on /metrics endpoint just isn't enough to explain what a certain metric means. This document's objective is to give further explanation of KubeVirt related metrics.

Kubevirt Metric

kubevirt_info

Kubevirt's version information

Labels:

  • goversion - GO version used to compile this version of KubeVirt
  • kubeversion - Git commit refspec that created this version of KubeVirt

Node Metric

kubevirt_vmi_phase_count

HELP kubevirt_vmi_phase_count VMI phase.

The total amount of VMIs per node and phase.

Labels:

VMI Metrics

All VMI metrics listed below contain, but are not limited to, these three labels for identifying purposes:

  • name - VMI's name given on its specification.
  • namespace - Namespace which the given VMI is related to.
  • node - Node where the VMI is running on.

kubevirt_vmi_memory_resident_bytes

HELP kubevirt_vmi_memory_resident_bytes resident set size of the process running the domain.

Total resident memory of the process running the VMI.

kubevirt_vmi_memory_available_bytes

HELP kubevirt_vmi_memory_available_bytes amount of usable memory as seen by the domain.

The total amount of usable memory.

kubevirt_vmi_memory_unused_bytes

HELP kubevirt_vmi_memory_unused_bytes amount of unused memory as seen by the domain.

The total amount of unused memory as seen by the domain.

kubevirt_vmi_memory_swap_traffic_bytes_total

HELP kubevirt_vmi_memory_swap_traffic_bytes_total swap memory traffic.

The amount of traffic that is being read and written in swap memory.

Extra labels:

  • type - Whether the data is being transmitted or received. in when transmitting and out when receiving.

kubevirt_vmi_network_errors_total

HELP kubevirt_vmi_network_errors_total network errors.

Counter of network errors when transmitting and receiving data.

Extra labels:

  • interface - Which network interface that errors are occurring.
  • type - Whether the error occurred when transmitting or receiving data. tx when transmitting and rx when receiving.

kubevirt_vmi_network_traffic_bytes_total

HELP kubevirt_vmi_network_traffic_bytes_total network traffic.

The total amount of traffic that is being transmitted and received.

Extra labels:

  • interface - Which network interface that errors are occurring.
  • type - Whether the error occurred when transmitting or receiving data. tx when transmitting and rx when receiving.

kubevirt_vmi_network_traffic_packets_total

HELP kubevirt_vmi_network_traffic_packets_total network traffic.

The total amount of packets that are being transmitted and received.

Extra labels:

  • interface - Which network interface that errors are occurring.
  • type - Whether the error occurred when transmitting or receiving data. tx when transmitting and rx when receiving.

kubevirt_vmi_storage_iops_total

HELP kubevirt_vmi_storage_iops_total I/O operation performed.

Counter of read and write operations per disk device.

Extra labels:

  • drive - Disk device that is being written/read.
  • type - Whether it's a read or write operation.

kubevirt_vmi_storage_times_ms_total

HELP kubevirt_vmi_storage_times_ms_total storage operation time.

Total time spent on read and write operations per disk device.

Extra labels:

  • drive - Disk device that is being written/read.
  • type - Whether it's a read or write operation.

kubevirt_vmi_storage_traffic_bytes_total

HELP kubevirt_vmi_storage_traffic_bytes_total storage traffic.

The total amount of data read and written per disk device.

Extra labels:

  • drive - Disk device that is being written/read.
  • type - Whether it's a read or write operation.

kubevirt_vmi_vcpu_seconds

HELP kubevirt_vmi_vcpu_seconds Vcpu elapsed time.

The total amount of time spent in each vcpu state

Extra labels:

  • id - Identifier to a single Virtual CPU.
  • state - Identify the Virtual CPU state. It can be one of libvirt vcpu's states: OFFLINE, RUNNING or BLOCKED

RoadMap

Improving Kubevirt's Observability is a important topic and we are currently working on new metrics.

A design proposal and its implementation history can be seen here

Other Metrics

kubevirt_vmi_vcpu_wait_seconds

HELP kubevirt_vmi_vcpu_wait_seconds vcpu time spent by waiting on I/O

leading_virt_controller

HELP leading_virt_controller Indication for an operating virt-controller.

ready_virt_controller

HELP ready_virt_controller Indication for a virt-controller that is ready to take the lead.