1PMDAMAILQ(1) General Commands Manual PMDAMAILQ(1)
2
6 pmdamailq - mail queue performance metrics domain agent (PMDA)
7
9 $PCP_PMDAS_DIR/mailq/pmdamailq [-b binlist] [-d domain] [-l logfile]
10 [-r regex] [-U username] [queuedir]
11
13 pmdamailq is a Performance Metrics Domain Agent (PMDA) which extracts
14 performance metrics describing the state of the e-mail queues managed
15 by sendmail(1) and other mail transfer agents.
16 The mailq PMDA exports metrics that measure the total number of entries
18 in the mail queue, and the subtotals for entries that have been queued
19 for various time periods.
20 A brief description of the pmdamailq command line options follows:
22 -b The binlist argument specifies a list of delay thresholds used to
24 ``bin'' the entries in the queue into a a histogram based on how
25 long the entry has been in the mail queue. The default thresholds
26 are: 1 hour, 4 hours, 8 hours, 1 day, 3 days and 7 days. The
27 entries in binlist are comma separated time intervals, using the
28 syntax described in PCPIntro(1) for an update or reporting inter‐
29 val, e.g. the default list could be specified using the value
30 1hr,4hrs,8hrs,1day,3days,7days.
31 Values in binlist are assumed to be in ascending order, and mail
33 items in the queue less than the first threshold are binned into a
34 special bin labeled ``recent''.
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 -l Location of the log file. By default, a log file named mailq.log
42 is written in the current directory of pmcd(1) when pmdamailq is
43 started, i.e. $PCP_LOG_DIR/pmcd . If the log file cannot be cre‐
44 ated or is not writable, output is written to the standard error
45 instead.
46 -r Use an extended regular expression to match file names in the mail
48 queue directory, rather than assuming all "df" prefixed files in
49 the directory are mail files (the "df" prefix is the sendmail con‐
50 vention, but this convention is not followed by other mail dae‐
51 mons). The regex pattern specified should conform to the POSIX
52 format described in regex(3), and it describes file names that
53 should be considered mail.
54 -U User account under which to run the agent. The default is the
56 unprivileged "pcp" account in current versions of PCP, but in
57 older versions the superuser account ("root") was used by default.
58 The optional queuedir argument defines the directory in which pmdamailq
60 expects to find the mail queue. The default is /var/spool/mqueue.
61
63 If you want access to the names, help text and values for the mailq
64 performance metrics, do the following as root:
65 # cd $PCP_PMDAS_DIR/mailq
67 # ./Install
68 If you want to undo the installation, do the following as root:
70 # cd $PCP_PMDAS_DIR/mailq
72 # ./Remove
73 pmdamailq is launched by pmcd(1) and should never be executed directly.
75 The Install and Remove scripts notify pmcd(1) when the agent is
76 installed or removed.
77
79 $PCP_PMCDCONF_PATH
80 command line options used to launch pmdamailq
81 $PCP_PMDAS_DIR/mailq/help
82 default help text file for the mailq metrics
83 $PCP_PMDAS_DIR/mailq/Install
84 installation script for the pmdamailq agent
85 $PCP_PMDAS_DIR/mailq/Remove
86 undo installation script for the pmdamailq agent
87 $PCP_LOG_DIR/pmcd/mailq.log
88 default log file for error messages and other information
89 from pmdamailq
90
92 Environment variables with the prefix PCP_ are used to parameterize the
93 file and directory names used by PCP. On each installation, the file
94 /etc/pcp.conf contains the local values for these variables. The
95 $PCP_CONF variable may be used to specify an alternative configuration
96 file, as described in pcp.conf(5).
97
99 PCPIntro(1), pmcd(1), pcp.conf(5) and pcp.env(5).
100Performance Co-Pilot PCP PMDAMAILQ(1)