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

NAME

6       pmdasummary - summary performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/summary/pmdasummary  [-d  domain] [-h helpfile] [-l log‐
10       file] [-U username] pmie-command-line
11

DESCRIPTION

13       pmdasummary is a Performance Metrics Domain Agent (PMDA) which  derives
14       performance  metrics  values from values made available by other PMDAs.
15       pmdasummary consists of two processes:
16
17       pmie process
18              The inference engine for performance values pmie(1) is  used  to
19              periodically  sample values for the base metrics and compute the
20              derived values.  This process is launched with the  given  pmie-
21              command-line arguments by the main process, described below.
22
23       main process
24              The  main  process  reads  and  buffers  the  values computed by
25              pmie(1) and makes them available to the performance metrics col‐
26              lector daemon pmcd(1).
27
28       A brief description of the pmdasummary command line options follows:
29
30       -d   It  is absolutely crucial that the performance metrics domain num‐
31            ber specified here is unique  and  consistent.   That  is,  domain
32            should  be  different for every PMDA on the one host, and the same
33            domain number should be used for the same PMDA on all hosts.
34
35       -h   This option specifies an alternative help text file  helpfile  for
36            describing the metrics that pmdasummary represents.
37
38       -l   Location  of  the  log  file.   By  default, a log file named sum‐
39            mary.log is written in the current directory of pmcd(1) when pmda‐
40            summary is started, i.e.  $PCP_LOG_DIR/pmcd.  If the log file can‐
41            not be created or is not writable, output is written to the  stan‐
42            dard error instead.
43
44       -U   User  account  under  which  to run the agent.  The default is the
45            unprivileged "pcp" account in current  versions  of  PCP,  but  in
46            older versions the superuser account ("root") was used by default.
47

INSTALLATION

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

FILES

65       $PCP_PMCDCONF_PATH
66                 command line options used to launch pmdasummary
67       $PCP_PMDAS_DIR/summary/expr.pmie
68                 default pmie(1) expressions defining the summary metrics
69       $PCP_PMDAS_DIR/summary/help
70                 default help text for the summary metrics
71       $PCP_PMDAS_DIR/summary/Install
72                 installation script for the pmdasummary agent
73       $PCP_PMDAS_DIR/summary/Remove
74                 undo installation script for the pmdasummary agent
75       $PCP_LOG_DIR/pmcd/summary.log
76                 default log file for error  messages  and  other  information
77                 from pmdasummary
78

PCP ENVIRONMENT

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

SEE ALSO

87       pmcd(1) and pmie(1).
88
89
90
91Performance Co-Pilot                  PCP                       PMDASUMMARY(1)
Impressum