1PMDALIBVIRT(1)              General Commands Manual             PMDALIBVIRT(1)
2
3
4

NAME

6       pmdalibvirt - libvirt PMDA
7

DESCRIPTION

9       pmdalibvirt is a Performance Metrics Domain Agent (PMDA) which extracts
10       live performance data from libvirt hypervisor and domains (VMs).
11
12       See the libvirt documentation for detailed description of each metric.
13

INSTALLATION

15       pmdalibvirt reads an optional ini-style configuration file
16
17           · $PCP_PMDAS_DIR/libvirt/libvirt.conf
18
19       This file can contain in its [pmda] section overriding values  for  the
20       following PMDA options:
21
22           · user
23           · uri
24           · backing
25           · oldapi
26
27       By  default,  root, qemu:///system, False, and False are used as values
28       for these options, respectively.
29
30       The backing setting can be used to expand block device  information  to
31       cover backing chains with recent libvirt versions.
32
33       The  old  API  setting can be used in environments where recent libvirt
34       API additions are not available (e.g., RHEL 6 / libvirt-0.10.2) to pro‐
35       vide  some  of the metrics available with the newer API.  Regardless of
36       the API version, no guest agent is needed for the metrics.
37
38       Note that using non-root user typically requires also libvirt side con‐
39       figuration;  please  refer to libvirt documentation for further details
40       on this.
41
42       Once the needed setup is ready, you can test the connection and install
43       the  PMDA to enable access to the names and values for the libvirt per‐
44       formance metrics.  To install, do the following as root:
45
46           # cd $PCP_PMDAS_DIR/libvirt
47           # ./connect
48           # ./Install
49
50       To uninstall, do the following as root:
51
52           # cd $PCP_PMDAS_DIR/libvirt
53           # ./Remove
54
55       pmdalibvirt is  launched  by  pmcd(1)  and  should  never  be  executed
56       directly.  The Install and Remove scripts notify pmcd(1) when the agent
57       is installed or removed.
58

FILES

60       $PCP_PMDAS_DIR/libvirt/libvirt.conf
61              configuration file for the pmdalibvirt agent
62
63       $PCP_PMDAS_DIR/libvirt/connect
64              connection test helper using the pmdalibvirt agent configuration
65
66       $PCP_PMDAS_DIR/libvirt/Install
67              installation script for the pmdalibvirt agent
68
69       $PCP_PMDAS_DIR/libvirt/Remove
70              undo installation script for the pmdalibvirt agent
71
72       $PCP_LOG_DIR/pmcd/libvirt.log
73              default log file for messages from the pmdalibvirt agent
74

PCP ENVIRONMENT

76       Environment variables with the prefix PCP_ are used to parameterize the
77       file  and  directory names used by PCP.  On each installation, the file
78       /etc/pcp.conf contains the  local  values  for  these  variables.   The
79       $PCP_CONF  variable may be used to specify an alternative configuration
80       file, as described in pcp.conf(5).
81

SEE ALSO

83       PCPIntro(1), pmcd(1), virsh(1) and libvirtd(8).
84
85
86
87Performance Co-Pilot                  PCP                       PMDALIBVIRT(1)
Impressum