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

NAME

6       pmlogger_daily_report  -  write  Performance Co-Pilot daily summary re‐
7       ports
8

SYNOPSIS

10       $PCP_BINADM_DIR/pmlogger_daily_report  [-ApV?]   [-a  archivefile]  [-f
11       outputfile] [-h hostname] [-l logfile] [-o directory] [-t interval]
12

DESCRIPTION

14       pmlogger_daily_report  writes  daily  performance summary reports, much
15       like those produced by sadc(1) and the sa2(8) utility.
16
17       All of the command line arguments are optional and intended to be  self
18       explanatory.
19
20       By  default,  the  reports  are  not generated, but if the pcp-zeroconf
21       package has been installed (there will be  files  in  $PCP_VAR_DIR/con‐
22       fig/pmlogconf/zeroconf)  then  the necessary metrics will have been in‐
23       cluded in the default pmlogger(1) configuration file  and  the  reports
24       will be generated.
25
26       The reports are generated (by default) soon after midnight, once pmlog‐
27       ger_daily(1) has completed the merging of any partal archives to gener‐
28       ate one archive for yesterday's activity.
29
30       Each  performance summary report is named sarXX (where XX is yesterdays
31       day-of-the-month).  The outputfile may be changed with the  -f  option.
32       The report will be written to the $PCP_LOG_DIR/sa directory by default,
33       but this may be changed with the -o option to a different directory.
34
35       Note that there are suffciently flexible command line options  for  pm‐
36       logger_daily_report  to  be  used to read any archivefile and write the
37       report to any output directory.
38
39       If the -a option  is  not  given,  the  default  input  archivefile  is
40       $PCP_ARCHIVE_DIR/HOSTNAME/YYYYMMDD,  where HOSTNAME defaults to the lo‐
41       cal hostname (unless changed with the -h option) and  YYYYMMDD  is  the
42       base  name of yesterdays merged archive, as produced by pmlogger(1) and
43       pmlogger_daily(1).   If  archivefile  is  a  directory,   then   pmlog‐
44       ger_daily_report  will  use all PCP archives found in that directory to
45       write the report (this is known as multi-archive mode, and may be  con‐
46       siderably slower than specifying a single archive as the input).
47
48       The  reports  themselves  are created by the pmrep(1) utility using its
49       default configuration file, see pmrep.conf(5).  The pmrep(1) configura‐
50       tion  entries used to write the reports is currently hardwired into the
51       pmlogger_daily_report script.
52
53       Finally, the input archives must contain sufficient metrics  as  needed
54       by  pmrep(1)  to  write  the report.  On platforms that support it, the
55       pcp-zeroconf package configures PCP logging  as  required  for  this  -
56       hence pmlogger_daily_report should be used with the pmlogger(1) config‐
57       uration that is set up by pcp-zeroconf.  As the name suggests,  pcp-ze‐
58       roconf requires no additional configuration after installation in order
59       to capture the required archives needed by pmlogger_daily_report.
60

OPTIONS

62       The available command line options are:
63
64       -a archive
65            Specifies an alternate input archive file  basename  or  directory
66            path.
67
68       -A   Use  the  start  and end times of input archive for the report, as
69            opposed to the default behaviour of 24 hours from midnight yester‐
70            day.
71
72       -f filename
73            Specifies  an alternate output filename.  -h hostname Specifies an
74            alternateA hostname to use within the default input  archive  file
75            path.
76
77       -l file, --logfile=file
78            In order to ensure that mail is not unintentionally sent when this
79            script is run from pmlogger_daily(1) diagnostics are  always  sent
80            to a log file.  By default, this file is $PCP_LOG_DIR/pmlogger/pm‐
81            logger_daily_report.log but this can be changed using the  -l  op‐
82            tion.   If this log file already exists when the script starts, it
83            will be renamed with a .prev  suffix  (overwriting  any  log  file
84            saved earlier) before diagnostics are generated to the log file.
85
86       -p   If  this option is specified then the status of the daily process‐
87            ing is polled and if the report has not been done in the  last  24
88            hours  then  it is done now.  With this option, pmlogger_daily_re‐
89            port simply exits if the previous  day's  processing  has  already
90            been done.
91
92            This  option  is  no  longer  required  as  the  polling of pmlog‐
93            ger_daily(1) will ensure the report will be generated, however the
94            option is retained for backwards compatibility.
95
96       -t interval
97            Specifies  the  sampling interval used when generating the report,
98            in the format described in PCPIntro(1).  The default is  every  10
99            minutes.
100
101       -V, --verbose
102            The  output from the execution of the script may be extended using
103            this option which enables verbose tracing of activity.  By default
104            the  script  generates  no log output unless some error or warning
105            condition is encountered.
106
107       -?, --help
108            Display usage message and exit.
109

PCP ENVIRONMENT

111       Environment variables with the prefix PCP_ are used to parameterize the
112       file  and  directory names used by PCP.  On each installation, the file
113       /etc/pcp.conf contains the  local  values  for  these  variables.   The
114       $PCP_CONF  variable may be used to specify an alternative configuration
115       file, as described in pcp.conf(5).
116

SEE ALSO

118       PCPIntro(1),  pmlogger_daily(1),  pmlogger(1),  pmrep(1),  sadc(1)  and
119       sa2(8).
120
121
122
123Performance Co-Pilot                  PCP             PMLOGGER_DAILY_REPORT(1)
Impressum