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

NAME

6       pmdadocker - docker performance metrics domain agent (PMDA)
7

SYNOPSIS

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

DESCRIPTION

12       pmdadocker  is  a  docker Performance Metrics Domain Agent (PMDA) which
13       exposes performance metrics as reported from the Docker Remote API.
14
15       A brief description of the pmdadocker command line options follows:
16
17       -d   It is absolutely crucial that the performance metrics domain  num‐
18            ber  specified  here  is  unique  and consistent.  That is, domain
19            should be different for every PMDA on the one host, and  the  same
20            domain number should be used for the same PMDA on all hosts.
21
22       -l   Location of the log file.  By default, a log file named docker.log
23            is written in the current directory of pmcd(1) when pmdadocker  is
24            started,  i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be cre‐
25            ated or is not writable, output is written to the  standard  error
26            instead.
27
28       Remote  API metric requests are activated automatically and are fetched
29       on a timer.  This timer is represented  as  a  by  pmdadocker  via  the
30       docker.control.timing.   By default, pmdadocker will be set to fetch on
31       a 1 second interval.
32
33       pmdadocker will iterate over three different docker remote API calls:
34
35       /containers/$ID/json
36              Container metrics regarding the current state of the  container.
37              Such as PID, name or if the container is running.
38
39       /version
40              Basic version metrics about the current docker deamon in use.
41
42       /containers/$ID/stats?stream=0
43              More in depth memory and cpu metrics of the container.
44

INSTALLATION

46       If  you  want  access to the names, help text and values for the docker
47       performance metrics, do the following as root:
48
49            # cd $PCP_PMDAS_DIR/docker
50            # ./Install
51
52       If you want to undo the installation (and remove both  PMDAs),  do  the
53       following as root:
54
55            # cd $PCP_PMDAS_DIR/docker
56            # ./Remove
57
58       pmdadocker  is  launched  by  pmcd(1)  and  should  never  be  executed
59       directly.  The Install and Remove scripts notify pmcd(1) when the agent
60       is installed or removed.
61

FILES

63       $PCP_PMCDCONF_PATH
64                 command line options used to launch pmdadocker
65       $PCP_PMDAS_DIR/docker/help
66                 default help text file for the docker metrics
67       $PCP_PMDAS_DIR/docker/Install
68                 installation script for the pmdadocker agent
69       $PCP_PMDAS_DIR/docker/Remove
70                 undo installation script for the pmdadocker agent
71       $PCP_LOG_DIR/pmcd/docker.log
72                 default  log  file  for  error messages and other information
73                 from pmdadocker
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).  In particular, the  $PCP_DOCKER_DIR
81       may be set to change the default directory from /var/lib/docker.
82

SEE ALSO

84       PCPIntro(1), pmcd(1), pcp.conf(5), pcp.env(5) and docker(1).
85
86
87
88Performance Co-Pilot                  PCP                        PMDADOCKER(1)
Impressum