knm-io / prometheus-libvirt-exporter

prometheus-libvirt-exporter

Forked to provide a level of isolation -- we're building the exporter directly from this repository, when needed for installation.

Prometheus-libvirt-exporter

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.

Building and running

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.

Requirements

1. Gorelease: go install github.com/goreleaser/goreleaser@latest

2. Taskfile: go install github.com/go-task/task/v3/cmd/task@latest

Local Building

1. Run task build

2. Afterwards all packages, binaries and archives are available in the dist/ folder

To see all available configuration flags:

./prometheus-libvirt-exporter -h

metrics

Name	Label	Description
up		scraping libvirt's metrics state
libvirt_domains		number of domains
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_read_bytes_total	"domain", "source_file", "target_device", "host"	Number of bytes read from a block device, in bytes
libvirt_domain_block_stats_read_requests_total	"domain", "source_file", "target_device", "host"	Number of read requests from a block device
libvirt_domain_block_stats_write_bytes_total	"domain", "source_file", "target_device"	Number of bytes written from a block device, in bytes
libvirt_domain_block_stats_write_requests_total	"domain", "source_file", "target_device"	Number of write requests from a block device
libvirt_domain_interface_stats_receive_bytes_total	"domain", "source_bridge", "target_device",	Number of bytes received on a network interface, in bytes
libvirt_domain_interface_stats_receive_packets_total	"domain", "source_bridge", "target_device"	Number of packets received on a network interface
libvirt_domain_interface_stats_receive_errors_total	"domain", "source_bridge", "target_device"	Number of packet receive errors on a network interface
libvirt_domain_interface_stats_receive_drops_total	"domain", "source_bridge", "target_device"	Number of packet receive drops on a network interface
libvirt_domain_interface_stats_transmit_bytes_total	"domain", "source_bridge", "target_device"	Number of bytes transmitted on a network interface, in bytes
libvirt_domain_interface_stats_transmit_packets_total	"domain", "source_bridge", "target_device"	Number of packets transmitted on a network interface
libvirt_domain_interface_stats_transmit_errors_total	"domain", "source_bridge", "target_device"	Number of packet transmit errors on a network interface
libvirt_domain_interface_stats_transmit_drops_total	"domain", "source_bridge", "target_device"	Number of packet transmit drops on a network interface

Example

libvirt_domain_block_stats_read_bytes_total{domain="instance-0001e06e",source_file="",target_device="vda"} 1.497283072e+09
libvirt_domain_block_stats_read_requests_total{domain="instance-0001e06e",source_file="",target_device="vda"} 23560
libvirt_domain_block_stats_write_bytes_total{domain="instance-0001e06e",source_file="",target_device="vda"} 7.6914481664e+10
libvirt_domain_block_stats_write_requests_total{domain="instance-0001e06e",source_file="",target_device="vda"} 2.409676e+06
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_receive_bytes_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 1.589638794e+09
libvirt_domain_interface_stats_receive_drops_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_receive_errors_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_receive_packets_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 4.671267e+06
libvirt_domain_interface_stats_transmit_bytes_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 6.90886551e+08
libvirt_domain_interface_stats_transmit_drops_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_transmit_errors_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",target_device="tapab672ce4-11"} 0
libvirt_domain_interface_stats_transmit_packets_total{domain="instance-0001e06e",source_bridge="brq1df64f1b-d4",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_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