pmdakvm(1) — Linux manual page

NAME | DESCRIPTION | INSTALLATION | CAVEATS | FILES | PCP ENVIRONMENT | SEE ALSO | COLOPHON

PMDAKVM(1)               General Commands Manual              PMDAKVM(1)

NAME         top

       pmdakvm - Linux virtualization performance metrics domain agent
       (PMDA)

DESCRIPTION         top

       pmdakvm is a Performance Metrics Domain Agent (PMDA) which
       exports metric values from the Linux KVM (Kernel Virtual Machine)
       virtualization subsystem.

       Per-processor KVM trace metrics from the kernel events enumerated
       below /sys/kernel/debug/tracing/events/kvm can be configured
       statically using the pmdakvm configuration file,
       /etc/pcp/kvm/kvm.conf.

INSTALLATION         top

       Optionally configure trace points in the configuration file, then
       install the KVM PMDA by using the Install script as root:

           # cd $PCP_PMDAS_DIR/kvm
           # ./Install

       To uninstall, do the following as root:

           # cd $PCP_PMDAS_DIR/kvm
           # ./Remove

       pmdakvm is launched by pmcd(1) and should never be executed
       directly. The Install and Remove scripts notify pmcd(1) when the
       agent is installed or removed.

CAVEATS         top

       When pmdakvm is running, it holds references to kernel resources
       within the KVM device driver.  It is thus not possible to unload
       or reload the device driver module while the PMDA is running.
       The ideal procedure to follow in order to reload the kernel
       module is the reverse of that described in the ``INSTALLATION''
       section above - i.e. first run ./Remove, then reload the kernel
       module, then run ./Install.

FILES         top

       $PCP_SYSCONF_DIR/kvm/kvm.conf
           configuration file for the pmdakvm agent

       $PCP_PMDAS_DIR/kvm/Install
           installation script for the pmdakvm agent

       $PCP_PMDAS_DIR/kvm/Remove
           undo installation script for the pmdakvm agent

       $PCP_LOG_DIR/pmcd/kvm.log
           default log file for error messages from pmdakvm

PCP ENVIRONMENT         top

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

SEE ALSO         top

       PCPIntro(1), pmcd(1) and kvm(1).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨http://www.pcp.io/⟩.  If you have a bug report for this manual
       page, send it to [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       [email protected]

Performance Co-Pilot               PCP                        PMDAKVM(1)