libvirt (virsh)

Description

This connector enables hardware monitoring for VMs through the virsh command. The libvirt API must be installed on the host.

hardware linux

Target

Typical platforms: Linux, Microsoft Windows, QEMU/KVM, VirtualBox, VMware, Xen

Operating system: Linux

Prerequisites

Leverages: libvirt API

Technology and protocols: Commands

Examples

CLI

metricshub HOSTNAME -t linux -c +Virsh --ssh -u USER

metricshub.yaml

resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: linux
        connectors: [ +Virsh ] # Optional, to load only this connector
        protocols:
          ssh:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt

Connector Activation Criteria

The libvirt (virsh) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

• The command below succeeds on the monitored host:
  • Command: virsh list
  • Output contains: Name (regex)

Metrics

Type	Collected Metrics	Specific Attributes
vm	hw.power_state{hw.type="vm", state="off|on|suspended"} hw.status{hw.type="vm", state="present"} hw.vm.power_ratio	hw.parent.type id info name vm.host.name