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

NAME

6       pmdapodman - podman container performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/podman/pmdapodman [-d domain] [-l logfile]
10

DESCRIPTION

12       podman(1)  is a utility for managing pods, containers and container im‐
13       ages, following the container pod concept  popularized  by  Kubernetes.
14       pmdapodman  is a Performance Metrics Domain Agent (PMDA) which extracts
15       performance metrics describing the state of containers and pods managed
16       by podman.
17
18       The podman PMDA exports metrics that measure information about individ‐
19       ual containers and groups of containers, called pods.
20
21       A brief description of the pmdapodman command line options follows:
22
23       -d   It is absolutely crucial that the performance metrics domain  num‐
24            ber  specified  here  is  unique  and consistent.  That is, domain
25            should be different for every PMDA on the one host, and  the  same
26            domain number should be used for the same PMDA on all hosts.
27
28       -l   Location of the log file.  By default, a log file named podman.log
29            is written in the current directory of pmcd(1) when pmdapodman  is
30            started,  i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be cre‐
31            ated or is not writable, output is written to the  standard  error
32            instead.
33

INSTALLATION

35       The podman PMDA is installed and available by default on Linux.  If you
36       want to undo the installation, do the following as root:
37
38            # cd $PCP_PMDAS_DIR/podman
39            # ./Remove
40
41       If you want to establish access to the names, help text and values  for
42       the podman performance metrics once more, after removal, do the follow‐
43       ing as root:
44
45            # cd $PCP_PMDAS_DIR/podman
46            # ./Install
47
48       pmdapodman is launched by pmcd(1) and  should  never  be  executed  di‐
49       rectly.   The  Install and Remove scripts notify pmcd(1) when the agent
50       is installed or removed.
51

FILES

53       $PCP_PMCDCONF_PATH
54                 command line options used to launch pmdapodman
55       $PCP_PMDAS_DIR/podman/help
56                 default help text file for the podman metrics
57       $PCP_PMDAS_DIR/podman/Install
58                 installation script for the pmdapodman agent
59       $PCP_PMDAS_DIR/podman/Remove
60                 undo installation script for the pmdapodman agent
61       $PCP_LOG_DIR/pmcd/podman.log
62                 default log file for error  messages  and  other  information
63                 from pmdapodman
64

PCP ENVIRONMENT

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

SEE ALSO

73       PCPIntro(1), pmcd(1), podman(1), pcp.conf(5) and pcp.env(5).
74
75
76
77Performance Co-Pilot                  PCP                        PMDAPODMAN(1)
Impressum