////
This file is generated! See scripts/mage/docs_collector.go
////

:modulename: kvm

[[metricbeat-module-kvm]]
== KVM module

beta[]

This is the kvm module.


[float]
=== Example configuration

The KVM module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: kvm
  metricsets: ["dommemstat", "status"]
  enabled: true
  period: 10s
  hosts: ["unix:///var/run/libvirt/libvirt-sock"]
  # For remote hosts, setup network access in libvirtd.conf
  # and use the tcp scheme:
  # hosts: [ "tcp://<host>:16509" ]

  # Timeout to connect to Libvirt server
  #timeout: 1s
----

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-kvm-dommemstat,dommemstat>>

* <<metricbeat-metricset-kvm-status,status>>

include::kvm/dommemstat.asciidoc[]

include::kvm/status.asciidoc[]

