A prometheus-libvirt-exporter for host and vm metrics exposed for prometheus, written in Go with pluggable metric collectors. By default, this exporter listens on TCP port 9177, path '/metrics', to expose metrics.
This exporter is built upon the go-libvirt package developed by DigitalOcean. It offers a pure Go interface for interacting with Libvirt, leveraging the RPC interface provided by Libvirt. For detailed information about the Go bindings used, you can refer to the Libvirt API reference.
You can run the exporter as a standalone binary or as a systemd service.
Build the exporter (see Building and running), then run:
./prometheus-libvirt-exporterBy default, the exporter listens on port 9177 and exposes metrics at /metrics.
A sample systemd service file is provided at contrib/prometheus-libvirt-exporter.service. To install:
sudo cp contrib/prometheus-libvirt-exporter.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable --now prometheus-libvirt-exporterYou can configure the exporter using command-line flags:
-
--libvirt.uri
Libvirt URI from which to extract metrics.
Default:/var/run/libvirt/libvirt-sock-ro -
--libvirt.driver
Libvirt driver to use.
Default:qemu:///system -
--exporter.timeout
Maximum libvirt API call duration (e.g.,3s).
Default:3s -
--exporter.max-concurrent-collects
Maximum number of concurrent collects (min: 1).
Adapt libvirtdmax_client_requestsaccording to the value chosen here
Default:4 -
--web.telemetry-path
Path under which to expose metrics.
Default:/metrics
For a full list of options, run:
./prometheus-libvirt-exporter --helpAdd a scrape job to your Prometheus configuration:
scrape_configs:
- job_name: 'libvirt'
static_configs:
- targets: ['localhost:9177']This release provides a set of assets for the prometheus-libvirt-exporter. It includes installation packages for various platforms (apk, deb, rpm) and the the binaries. Additionally, source code archives in both zip and tar.gz formats are available for download.
-
Gorelease:
go install github.com/goreleaser/goreleaser@latest -
Taskfile:
go install github.com/go-task/task/v3/cmd/task@latest
-
Run
task build -
Afterwards all packages, binaries and archives are available in the
dist/folder
| Name | Label | Description |
|---|---|---|
| up | scraping libvirt's metrics state | |
| libvirt_domains | number of domains | |
| libvirt_domain_timed_out | "domain" | Whether scraping libvirt's domain metrics has timed out |
| libvirt_domain_openstack_info | "domain", "instance_name", "instance_id", "flavor_name", "user_name", "user_id", "project_name", "project_id" | Aggregated OpenStack metadata as labels |
| libvirt_domain_info | "domain", "os_type", "os_type_machine", "os_type_arch" | e.g. os (operating system booting) settings as labels |
| libvirt_domain_info_state | "domain", "state_desc" | Code of the domain state,include state description |
| libvirt_domain_info_maximum_memory_bytes | "domain" | Maximum allowed memory of the domain |
| libvirt_domain_info_memory_usage_bytes | "domain" | Memory usage of the domain |
| libvirt_domain_info_virtual_cpus | "domain" | Number of virtual CPUs for the domain |
| libvirt_domain_info_cpu_time_seconds_total | "domain" | Amount of CPU time used by the domain |
| libvirt_domain_memory_stats_swap_in_bytes | "domain" | Memory swapped in for this domain(the total amount of data read from swap space) |
| libvirt_domain_memory_stats_swap_out_bytes | "domain" | Memory swapped out for this domain (the total amount of memory written out to swap space) |
| libvirt_domain_memory_stats_unused_bytes | "domain" | Memory unused by the domain |
| libvirt_domain_memory_stats_available_bytes | "domain" | Memory available to the domain |
| libvirt_domain_memory_stats_usable_bytes | "domain" | Memory usable by the domain (corresponds to 'Available' in /proc/meminfo) |
| libvirt_domain_memory_stats_rss_bytes | "domain" | Resident Set Size of the process running the domain |
| libvirt_domain_block_stats_info | "domain", "disk_type", "driver_cache", "driver_discard", "driver_name", "driver_type", "serial", "source_file", "target_bus", "target_device" | Metadata information on block devices |
| libvirt_domain_memory_stats_used_percent | "domain" | The amount of memory in percent, that used by domain |
| libvirt_domain_memory_stats_current_balloon_bytes | "domain" | Current balloon value (in bytes) |
| libvirt_domain_memory_stats_major_fault_total | "domain" | Page faults occur when a process makes a valid access to virtual memory that is not available. When servicing the page fault, if disk IO is required, it is considered a major fault |
| libvirt_domain_memory_stats_minor_fault_total | "domain" | Page faults occur when a process makes a valid access to virtual memory that is not available. When servicing the page not fault, if disk IO is required, it is considered a minor fault |
| libvirt_domain_memory_stats_disk_caches_bytes | "domain" | The amount of memory that can be reclaimed without additional I/O, typically disk |
| libvirt_domain_memory_stats_hugetlb_pgalloc_total | "domain" | The number of successful huge page allocations from inside the domain via virtio balloon |
| libvirt_domain_memory_stats_hugetlb_pgfail_total | "domain" | The number of failed huge page allocations from inside the domain via virtio balloon |
| libvirt_domain_memory_stats_last_update_timestamp_seconds | "domain" | Last time the memory stats were updated for this domain, in seconds since epoch |
| libvirt_domain_memory_stats_maximum_bytes | "domain" | Maximum memory used by the domain (the maximum amount of memory that can be used by the domain) |
| libvirt_domain_block_stats_read_bytes_total | "domain", "target_device", "host" | Number of bytes read from a block device, in bytes |
| libvirt_domain_block_stats_read_requests_total | "domain", "target_device", "host" | Number of read requests from a block device |
| libvirt_domain_block_stats_write_bytes_total | "domain", "target_device" | Number of bytes written from a block device, in bytes |
| libvirt_domain_block_stats_write_requests_total | "domain", "target_device" | Number of write requests from a block device |
| libvirt_domain_block_stats_read_time_seconds_total | "domain", "target_device" | Total time spent on reads from a block device, in seconds. |
| libvirt_domain_block_stats_write_time_seconds_total | "domain", "target_device" | Total time spent on writes on a block device, in seconds |
| libvirt_domain_block_stats_flush_requests_total | "domain", "target_device" | Total flush requests from a block device |
| libvirt_domain_block_stats_flush_time_seconds_total | "domain", "target_device" | Total time in seconds spent on cache flushing to a block device |
| libvirt_domain_block_stats_capacity_bytes | "domain", "target_device" | Logical size in bytes of the block device backing image |
| libvirt_domain_interface_stats_info | "domain", "interface_type", "mac_address", "model_type", "mtu_size", "source_bridge", "target_device" | Metadata on network interfaces |
| libvirt_domain_interface_stats_receive_bytes_total | "domain", "target_device", | Number of bytes received on a network interface, in bytes |
| libvirt_domain_interface_stats_receive_packets_total | "domain", "target_device" | Number of packets received on a network interface |
| libvirt_domain_interface_stats_receive_errors_total | "domain", "target_device" | Number of packet receive errors on a network interface |
| libvirt_domain_interface_stats_receive_drops_total | "domain", "target_device" | Number of packet receive drops on a network interface |
| libvirt_domain_interface_stats_transmit_bytes_total | "domain", "target_device" | Number of bytes transmitted on a network interface, in bytes |
| libvirt_domain_interface_stats_transmit_packets_total | "domain", "target_device" | Number of packets transmitted on a network interface |
| libvirt_domain_interface_stats_transmit_errors_total | "domain", "target_device" | Number of packet transmit errors on a network interface |
| libvirt_domain_interface_stats_transmit_drops_total | "domain", "target_device" | Number of packet transmit drops on a network interface |
| libvirt_domain_job_type | "domain" | Code of the domain job type |
| libvirt_domain_job_time_elapsed_seconds | "domain" | Time elapsed since the start of the domain job |
| libvirt_domain_job_time_remaining_seconds | "domain" | Time remaining until the end of the domain job |
| libvirt_domain_job_data_total_bytes | "domain" | Data total of the domain job |
| libvirt_domain_job_data_processed_bytes | "domain" | Data processed of the domain job |
| libvirt_domain_job_data_remaining_bytes | "domain" | Data remaining of the domain job |
| libvirt_domain_job_mem_total_bytes | "domain" | Memory total of the domain job |
| libvirt_domain_job_mem_processed_bytes | "domain" | Memory processed of the domain job |
| libvirt_domain_job_mem_remaining_bytes | "domain" | Memory remaining of the domain job |
| libvirt_domain_job_file_total_bytes | "domain" | File total of the domain job |
| libvirt_domain_job_file_processed_bytes | "domain" | File processed of the domain job |
| libvirt_domain_job_file_remaining_bytes | "domain" | File remaining of the domain job |
| libvirt_domain_vcpu_current | "domain" | Number of current online vCPUs |
| libvirt_domain_vcpu_delay_seconds_total | "domain", "vcpu" | Time the vCPU spent waiting in the queue instead of running. Exposed to the VM as steal time |
| libvirt_domain_vcpu_maximum | "domain" | Number of maximum online vCPUs |
| libvirt_domain_vcpu_state | "domain", "vcpu" | State of the vCPU |
| libvirt_domain_vcpu_time_seconds_total | "domain", "vcpu" | Time spent by the virtual CPU |
| libvirt_domain_vcpu_wait_seconds_total | "domain", "vcpu" | Time the vCPU wants to run, but the host scheduler has something else running ahead of it |
| libvirt_storage_pool_allocation_bytes | "storage_pool" | Current allocation bytes of the storage pool |
| libvirt_storage_pool_available_bytes | "storage_pool" | Remaining free space of the storage pool in bytes |
| libvirt_storage_pool_capacity_bytes | "storage_pool" | Size of the storage pool in logical bytes |
| libvirt_storage_pool_state | "storage_pool" | State of the storage pool |
| libvirt_storage_pool_timed_out | "storage_pool" | Whether scraping libvirt's pool metrics has timed out pool |
libvirt_domain_block_stats_info{disk_type="network",domain="instance-0001e06e",driver_cache="none",driver_discard="unmap",driver_name="qemu",driver_type="raw",serial="6ef20b92-1d9d-4de9-8a81-e324b98ae787",source_file="",target_bus="scsi",target_device="sda"} 1
libvirt_domain_block_stats_read_bytes_total{domain="instance-0001e06e",target_device="vda"} 1.497283072e+09
libvirt_domain_block_stats_read_requests_total{domain="instance-0001e06e",target_device="vda"} 23560
libvirt_domain_block_stats_write_bytes_total{domain="instance-0001e06e",target_device="vda"} 7.6914481664e+10
libvirt_domain_block_stats_write_requests_total{domain="instance-0001e06e",target_device="vda"} 2.409676e+06
libvirt_domain_block_stats_read_time_seconds_total{domain="instance-00000337",target_device="sda"} 161803.085086353
libvirt_domain_block_stats_write_time_seconds_total{domain="instance-00000337",target_device="sda"} 530522.437009019
libvirt_domain_block_stats_capacity_bytes{domain="instance-00000337",target_device="sda"} 2.147483648e+10
libvirt_domain_block_stats_flush_requests_total{domain="instance-00000337",target_device="sda"} 5.153142e+06
libvirt_domain_block_stats_flush_time_seconds_total{domain="instance-00000337",target_device="sda"} 473.56850521
libvirt_domain_info{domain="instance-0001e06e",os_type="hvm",os_type_arch="x86_64",os_type_machine="pc-q35-4.0"} 1
libvirt_domain_info_cpu_time_seconds_total{domain="instance-0001e06e"} 136215.65
libvirt_domain_info_maximum_memory_bytes{domain="instance-0001e06e"} 1.7179869184e+10
libvirt_domain_info_memory_usage_bytes{domain="instance-0001e06e"} 1.7179869184e+10
libvirt_domain_info_state{domain="instance-0001e06e",state_desc="the domain is running"} 1
libvirt_domain_info_virtual_cpus{domain="instance-0001e06e"} 4
libvirt_domain_interface_stats_info{domain="instance-0001e06e",interface_type="bridge",mac_address="fa:16:3e:fe:51:0a",model_type="virtio",mtu_size="7950",source_bridge="brq1cbc2c2b-af",target_device="tap3c5556a4-93"} 1
libvirt_domain_interface_stats_receive_bytes_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 1.589638794e+09
libvirt_domain_interface_stats_receive_drops_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_receive_errors_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_receive_packets_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 4.671267e+06
libvirt_domain_interface_stats_transmit_bytes_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 6.90886551e+08
libvirt_domain_interface_stats_transmit_drops_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_transmit_errors_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_transmit_packets_total{domain="instance-0001e06e",target_device="tapab672ce4-11"} 1.412009e+06
libvirt_domain_memory_stats_available_bytes{domain="instance-0001e06e"} 1.676619776e+10
libvirt_domain_memory_stats_rss_bytes{domain="instance-0001e06e"} 6.386884608e+09
libvirt_domain_memory_stats_swap_in_bytes{domain="instance-0001e06e"} 0
libvirt_domain_memory_stats_swap_out_bytes{domain="instance-0001e06e"} 0
libvirt_domain_memory_stats_unused_bytes{domain="instance-0001e06e"} 1.3844406272e+10
libvirt_domain_memory_stats_usable_bytes{domain="instance-0001e06e"} 1.4880370688e+10
libvirt_domain_memory_stats_current_balloon_bytes{domain="instance-00000337"} 8.589934592e+09
libvirt_domain_memory_stats_major_fault_total{domain="instance-00000337"} 3.34448e+06
libvirt_domain_memory_stats_minor_fault_total{domain="instance-00000337"} 5.6630255354e+10
libvirt_domain_memory_stats_used_percent{domain="instance-00000337"} 72.84790881786736
libvirt_domain_memory_stats_disk_caches_bytes{domain="domaintest1"} 5.0110464e+07
libvirt_domain_memory_stats_disk_caches_bytes{domain="domaintest2"} 6.3537152e+07
libvirt_domain_memory_stats_hugetlb_pgalloc_total{domain="domaintest1"} 0
libvirt_domain_memory_stats_hugetlb_pgalloc_total{domain="domaintest2"} 0
libvirt_domain_memory_stats_hugetlb_pgfail_total{domain="domaintest1"} 0
libvirt_domain_memory_stats_hugetlb_pgfail_total{domain="domaintest2"} 0
libvirt_domain_memory_stats_last_update_timestamp_seconds{domain="domaintest1"} 1.748270127e+09
libvirt_domain_memory_stats_last_update_timestamp_seconds{domain="domaintest2"} 1.74827013e+09
libvirt_domain_memory_stats_maximum_bytes{domain="domaintest1"} 1.073741824e+09
libvirt_domain_memory_stats_maximum_bytes{domain="domaintest2"} 4.294967296e+09
libvirt_domain_openstack_info{domain="instance-0001e06e",flavor_name="z1.4xlarge",instance_id="a12423b02-4a36-4530-bf25-acb8ba80b1b1",instance_name="openstackInstanceName",project_id="hghngfhbf45435352353623gvfegt352",project_name="openstackProjectName",user_id="",user_name="openstackUserName"} 1
libvirt_domain_vcpu_current{domain="instance-00000131"} 2
libvirt_domain_vcpu_delay_seconds_total{domain="instance-00000131",vcpu="0"} 6309719178
libvirt_domain_vcpu_maximum{domain="instance-00000131"} 2
libvirt_domain_vcpu_state{domain="instance-00000131",vcpu="0"} 1
libvirt_domain_vcpu_time_seconds_total{domain="instance-00000131",vcpu="0"} 2111850000000
libvirt_domain_vcpu_wait_seconds_total{domain="instance-00000131",vcpu="0"} 4103560000000
libvirt_domain_timed_out{domain="instance-00000337"} 0
libvirt_domain_timed_out{domain="instance-0001e06e"} 0
libvirt_storage_pool_allocation_bytes{storage_pool="testpool"} 5309386752
libvirt_storage_pool_available_bytes{storage_pool="testpool"} 7264227328
libvirt_storage_pool_capacity_bytes{storage_pool="testpool"} 12573614080
libvirt_storage_pool_state{storage_pool="testpool"} 2
libvirt_storage_pool_timed_out{storage_pool="testpool"} 0