1PMLOGGER_DAILY_REPORT(1) General Commands Manual PMLOGGER_DAILY_REPORT(1)
2
6 pmlogger_daily_report - write Performance Co-Pilot daily summary
7 reports
8
10 $PCP_BINADM_DIR/pmlogger_daily_report [-a archivefile] [-f outputfile]
11 [-h hostname] [-l logfile] [-o directory] [-p] [-t interval] [-A] [-V]
12 [--help]
13
15 pmlogger_daily_report and the associated systemd(1) services write
16 daily performance summary reports, much like those produced by sadc(1)
17 and the sa2(8) utility.
18 All of the command line arguments are optional and intended to be self
20 explanatory. The service is not enabled by default. If the service is
21 enabled and no arguments are specified, pmlogger_daily_report will be
22 run by systemd at 2am each morning and write a performance summary
23 report named sarXX (where XX is yesterdays day-of-the-month, wrapping
24 to the previous month if today is the 1st). The outputfile may be
25 changed with the -f option. The report will be written to the
26 $PCP_LOG_DIR/sa directory by default, but this may be changed with the
27 -o option to a different directory.
28 If the -a option is not given, the default input archivefile is
30 $PCP_LOG_DIR/pmlogger/HOSTNAME/YYYYMMDD, where HOSTNAME defaults to the
31 local hostname (may be changed with the -h option) and YYYYMMDD is the
32 base name of yesterdays merged archive, as produced by pmlogger(1) and
33 the pmlogger_daily(1) scripts. If archivefile is a directory, then
34 pmlogger_daily_report will use all PCP archives found in that directory
35 to write the report (this is known as multi-archive mode, and may be
36 considerably slower than specifying a single archive as the input).
37 Note that there are suffciently flexible command line options for
39 pmlogger_daily_report to be used to read any archivefile and write the
40 report to any output directory.
41 If the -p option is specified then the status of the daily processing
43 is polled and if the report has not been done in the last 24 hours then
44 it is done now. The intent is to have pmlogger_daily_report called
45 regularly with the -p option (at 30 mins past the hour, every hour in
46 the default cron(8) set up) to ensure daily processing happens as soon
47 as possible if it was missed at the regularly scheduled time (which is
48 02:00 by default), e.g. if the system was down or suspended at that
49 time.
50 With the -p option, pmlogger_daily_report simply exits if the previous
52 day's processing has already been done.
53 The reports themselves are created by the pmrep(1) utility using its
55 default configuration file, see pmrep.conf(5). The pmrep(1) configura‐
56 tion entries used to write the reports is currently hardwired into the
57 pmlogger_daily_report script.
58 Finally, the input archives must contain sufficient metrics as needed
60 by pmrep(1) to write the report. On platforms that support it, the
61 pcp-zeroconf package configures PCP logging as required for this -
62 hence pmlogger_daily_report should be used with the pmlogger(1) config‐
63 uration that is set up by pcp-zeroconf. As the name suggests, pcp-
64 zeroconf requires no additional configuration after installation in
65 order to capture the required archives needed by pmlogger_daily_report.
66 In order to ensure that mail is not unintentionally sent when this
68 script is run by systemd(1), diagnostics are always sent to a log file.
69 By default, this file is $PCP_LOG_DIR/pmlogger/pmlog‐
70 ger_daily_report.log but this can be changed using the -l option. If
71 this log file already exists when the script starts, it will be renamed
72 with a .prev suffix (overwriting any log file saved earlier) before
73 diagnostics are generated to the log file.
74 The output from the execution of the script may be extended using the
76 -V option which enables verbose tracing of activity. By default the
77 script generates no log output unless some error or warning condition
78 is encountered.
79
81 Environment variables with the prefix PCP_ are used to parameterize the
82 file and directory names used by PCP. On each installation, the file
83 /etc/pcp.conf contains the local values for these variables. The
84 $PCP_CONF variable may be used to specify an alternative configuration
85 file, as described in pcp.conf(5).
86
88 PCPIntro(1), pmlogger_daily(1), pmlogger(1), pmrep(1), sadc(1), sa2(8)
89 and systemd(1).
90Performance Co-Pilot PCP PMLOGGER_DAILY_REPORT(1)