1PMDASUMMARY(1) General Commands Manual PMDASUMMARY(1)
2
6 pmdasummary - summary performance metrics domain agent (PMDA)
7
9 $PCP_PMDAS_DIR/summary/pmdasummary [-c configfile] [-d domain] [-h
10 helpfile] [-l logfile] pmie-command-line
11
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 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 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 A brief description of the pmdasummary command line options follows:
29 -c When used to summarize metrics from multiple hosts, pmdasummary
31 reads host information from configfile. This is a binary file
32 produced by $PCP_PMDAS_DIR/array/mkconfig, and so this option may
33 only be used if the add-on PCP for Arrays product is also
34 installed.
35 -d It is absolutely crucial that the performance metrics domain num‐
37 ber specified here is unique and consistent. That is, domain
38 should be different for every PMDA on the one host, and the same
39 domain number should be used for the same PMDA on all hosts.
40 -h This option specifies an alternative help text file helpfile for
42 describing the metrics that pmdasummary represents.
43 -l Location of the log file. By default, a log file named sum‐
45 mary.log is written in the current directory of pmcd(1) when pmda‐
46 summary is started, i.e. $PCP_LOG_DIR/pmcd. If the log file can‐
47 not be created or is not writable, output is written to the stan‐
48 dard error instead.
49
51 If you want access to the names, help text and values for the summary
52 performance metrics, do the following as root:
53 # cd $PCP_PMDAS_DIR/summary
55 # ./Install
56 If you want to undo the installation, do the following as root:
58 # cd $PCP_PMDAS_DIR/summary
60 # ./Remove
61 pmdasummary is launched by pmcd(1) and should never be executed
63 directly. The Install and Remove scripts notify pmcd(1) when the agent
64 is installed or removed.
65
67 $PCP_PMCDCONF_PATH
68 command line options used to launch pmdasummary
69 $PCP_PMDAS_DIR/summary/expr.pmie
70 default pmie(1) expressions defining the summary metrics
71 $PCP_PMDAS_DIR/summary/help
72 default help text for the summary metrics
73 $PCP_PMDAS_DIR/summary/Install
74 installation script for the pmdasummary agent
75 $PCP_PMDAS_DIR/summary/Remove
76 undo installation script for the pmdasummary agent
77 $PCP_LOG_DIR/pmcd/summary.log
78 default log file for error messages and other information
79 from pmdasummary
80
82 Environment variables with the prefix PCP_ are used to parameterize the
83 file and directory names used by PCP. On each installation, the file
84 /etc/pcp.conf contains the local values for these variables. The
85 $PCP_CONF variable may be used to specify an alternative configuration
86 file, as described in pcp.conf(4).
87
89 pmcd(1) and pmie(1).
90Performance Co-Pilot SGI PMDASUMMARY(1)