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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
#
# Copyright (c) 2012,2014 Red Hat.
# Copyright (c) 2009-2010 Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
#
# 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.
#
use strict;
use warnings;
use PCP::PMDA;
use Time::HiRes qw ( time );
use vars qw( $pmda );
use vars qw( %caches );
use vars qw( %logstats );
my @logfiles = ( '/var/log/mail.log', '/var/log/maillog' );
my $logfile;
my $qshape = 'qshape -b 10 -t 5';
my $refresh = 5.0; # 5 seconds between qshape refreshes
my $cached = 0;
my $postfix_queues_indom = 0;
my @postfix_queues_dom = (
0 => 'total',
1 => '0-5 mins',
2 => '5-10 mins',
3 => '10-20 mins',
4 => '20-40 mins',
5 => '40-80 mins',
6 => '80-160 mins',
7 => '160-320 mins',
8 => '320-640 mins',
9 => '640-1280 mins',
10=> '1280+ mins',
);
my $postfix_sent_indom = 1;
my @postfix_sent_dom = (
0 => 'smtp',
1 => 'local',
);
my $postfix_received_indom = 2;
my @postfix_received_dom = (
0 => 'local',
1 => 'smtp',
);
sub postfix_do_refresh
{
QUEUE:
foreach my $qname ("maildrop", "incoming", "hold", "active", "deferred") {
unless (open(PIPE, "$qshape $qname |")) {
$pmda->log("couldn't execute '$qshape $qname'");
next QUEUE;
}
while(<PIPE>) {
last if (/^[\t ]*TOTAL /);
}
close PIPE;
unless (/^[\t ]*TOTAL /) {
$pmda->log("malformed output for '$qshape $qname': $_");
next QUEUE;
}
s/^[\t ]*//;
s/[\t ]+/ /g;
my @items = split(/ /);
$caches{$qname}{0} = $items[1];
$caches{$qname}{1} = $items[2];
$caches{$qname}{2} = $items[3];
$caches{$qname}{3} = $items[4];
$caches{$qname}{4} = $items[5];
$caches{$qname}{5} = $items[6];
$caches{$qname}{6} = $items[7];
$caches{$qname}{7} = $items[8];
$caches{$qname}{8} = $items[9];
$caches{$qname}{9} = $items[10];
$caches{$qname}{10} = $items[11];
}
}
sub postfix_log_parser
{
( undef, $_ ) = @_;
if (/status=sent/) {
return unless (/ postfix\//);
my $relay = "";
if (/relay=([^,]+)/o) {
$relay = $1;
}
if ($relay !~ /\[/o) {
# if we are about to define a new instance, let's add it to the
# domain as well
my $idx = 0;
my $key;
my %tmp = @postfix_sent_dom;
foreach $key (sort keys %tmp) {
last if ($relay eq $tmp{$key});
$idx += 1;
}
if ((2 * $idx) == @postfix_sent_dom) {
push(@postfix_sent_dom, $idx=>$relay);
$pmda->replace_indom($postfix_sent_indom, \@postfix_sent_dom);
}
$logstats{"sent"}{$idx} += 1;
} else {
$logstats{"sent"}{0} += 1;
}
} elsif (/smtpd.*client=/) {
$logstats{"received"}{1} += 1;
} elsif (/pickup.*(sender|uid)=/) {
$logstats{"received"}{0} += 1;
}
}
sub postfix_fetch_callback
{
my ($cluster, $item, $inst) = @_;
my $metric_name = pmda_pmid_name($cluster, $item);
my $now = time;
#$pmda->log("postfix_fetch_callback $metric_name $cluster:$item ($inst)\n");
if (!defined($metric_name)) { return (PM_ERR_PMID, 0); }
if ($cluster == 0) {
my $qname;
if ($now - $cached > $refresh) {
postfix_do_refresh();
$cached = $now;
}
$qname = $metric_name;
$qname =~ s/^postfix\.queues\.//;
return (PM_ERR_AGAIN, 0) unless defined($caches{$qname});
return ($caches{$qname}{$inst}, 1);
} elsif ($cluster == 1) {
my $dir = $metric_name;
$dir =~ s/^postfix\.//;
return (PM_ERR_AGAIN, 0) unless defined($logstats{$dir});
return (PM_ERR_AGAIN, 0) unless defined($logstats{$dir}{$inst});
return ($logstats{$dir}{$inst}, 1);
}
return (PM_ERR_PMID, 0);
}
$pmda = PCP::PMDA->new('postfix', 103);
$pmda->connect_pmcd;
$pmda->add_metric(pmda_pmid(0,0), PM_TYPE_U32, $postfix_queues_indom,
PM_SEM_INSTANT, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.queues.maildrop', '', '');
$pmda->add_metric(pmda_pmid(0,1), PM_TYPE_U32, $postfix_queues_indom,
PM_SEM_INSTANT, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.queues.incoming', '', '');
$pmda->add_metric(pmda_pmid(0,2), PM_TYPE_U32, $postfix_queues_indom,
PM_SEM_INSTANT, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.queues.hold', '', '');
$pmda->add_metric(pmda_pmid(0,3), PM_TYPE_U32, $postfix_queues_indom,
PM_SEM_INSTANT, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.queues.active', '', '');
$pmda->add_metric(pmda_pmid(0,4), PM_TYPE_U32, $postfix_queues_indom,
PM_SEM_INSTANT, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.queues.deferred', '', '');
$pmda->add_metric(pmda_pmid(1,0), PM_TYPE_U32, $postfix_sent_indom,
PM_SEM_COUNTER, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.sent', '', '');
$pmda->add_metric(pmda_pmid(1,1), PM_TYPE_U32, $postfix_received_indom,
PM_SEM_COUNTER, pmda_units(0,0,1,0,0,PM_COUNT_ONE),
'postfix.received', '', '');
$logstats{"sent"}{0} = 0;
$logstats{"received"}{0} = 0;
$logstats{"received"}{1} = 0;
foreach my $file ( @logfiles ) {
if ( -r $file ) {
$logfile = $file;
}
}
die 'No Postfix log file found' unless defined($logfile);
$pmda->add_indom($postfix_queues_indom, \@postfix_queues_dom, '', '');
$pmda->add_indom($postfix_sent_indom, \@postfix_sent_dom, '', '');
$pmda->add_indom($postfix_received_indom, \@postfix_received_dom, '', '');
$pmda->add_tail($logfile, \&postfix_log_parser, 0);
$pmda->set_fetch_callback(\&postfix_fetch_callback);
$pmda->set_user('postfix');
$pmda->run;
=pod
=head1 NAME
pmdapostfix - Postfix performance metrics domain agent (PMDA)
=head1 DESCRIPTION
B<pmdapostfix> is a Performance Metrics Domain Agent (PMDA) which exports
mail queue sizes as reported by qshape(1), as well as aggregate statistics
collected from mail.log.
=head1 INSTALLATION
If you want access to the names and values for the Postfix performance
metrics, do the following as root:
# cd $PCP_PMDAS_DIR/postfix
# ./Install
If you want to undo the installation, do the following as root:
# cd $PCP_PMDAS_DIR/postfix
# ./Remove
B<pmdapostfix> is launched by pmcd(1) and should never be executed
directly. The Install and Remove scripts notify pmcd(1) when
the agent is installed or removed.
=head1 FILES
=over
=item $PCP_PMDAS_DIR/postfix/Install
installation script for the B<pmdapostfix> agent
=item $PCP_PMDAS_DIR/postfix/Remove
undo installation script for the B<pmdapostfix> agent
=item $PCP_LOG_DIR/pmcd/postfix.log
default log file for error messages from B<pmdapostfix>
=back
=head1 SEE ALSO
pmcd(1) and qshape(1).
|
