summaryrefslogtreecommitdiff
path: root/src/pmdas/mailq/help
blob: 29a1792d6dfdba1f710b74b55c921e37c9cfd1b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#
# Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
# 
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
# 
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# for more details.
# 
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
# mailq PMDA help file in the ASCII format
#
# lines beginning with a # are ignored
# lines beginning @ introduce a new entry of the form
#  @ metric_name oneline-text
#  help test goes
#  here over multiple lines
#  ...
#
# the metric_name is decoded against the default PMNS -- as a special case,
# a name of the form NNN.MM (for numeric NNN and MM) is interpreted as an
# instance domain identification, and the text describes the instance domain
#
# blank lines before the @ line are ignored
#

@ MAILQ.1 Instance domain used to "bin" messages based on how long they have been deferred


@ mailq.length Number of messages in the queue
The total number of messages in the mail queue.

@ mailq.deferred Histogram of pending messages based on how long they have been deferred
Counts of the number of messages in the sendmail queue grouped by
how long the mail delivery has been deferred.

The groups are based on the how long a message has been in the
queue:
    1-week	at least a week
    3-days	at least 3 days and less than a week
    1-day	at least one day and less than 3 days
    8-hours	more than 8 hours and less than one day
    4-hours	between 4 and 8 hours
    1-hour	between 1 and 4 hours
    recent	less than an hour