Repository
Munin (master)
Last change
2018-03-24
Graph Categories
Family
contrib
Language
Perl

mailscanner

Name

mailscanner - Plugin to show statistics for e-mails passing through a MailScanner filter

Configuration

The following environment variables are used by this plugin:

  • logfile

    The file where MailScanner logs its action (Default: /var/log/mail.log)

  • logtail

    The location of the logtail command (Default: /usr/sbin/logtail)

  • offsetfile

    The location of the offset file (Default: /tmp/munin-mailscanner.offset)

Usage

Requires the logtail command somewhere in path

Magic Markers

#%# family=contrib
#%# capabilities=
#!/usr/bin/perl -w

=head1 NAME

mailscanner - Plugin to show statistics for e-mails passing through a
MailScanner filter

=head1 CONFIGURATION

The following environment variables are used by this plugin:

=over 4

=item logfile

The file where MailScanner logs its action (Default:
/var/log/mail.log)

=item logtail

The location of the logtail command (Default: /usr/sbin/logtail)

=item offsetfile

The location of the offset file (Default:
/tmp/munin-mailscanner.offset)

=back

=head1 USAGE

Requires the logtail command somewhere in path

=head1 MAGIC MARKERS

 #%# family=contrib
 #%# capabilities=

=cut

use strict;

my $logfile = '/var/log/mail.log';
my $logtail = '/usr/sbin/logtail';
my $offsetfile = "$ENV{MUNIN_PLUGSTATE}/munin-mailscanner.offset";
my ($clean, $viruses, $spams, $others, $total) = (0, 0, 0, 0, 0);
my $cmd = (defined($ARGV[0])) ? $ARGV[0] : '';

(defined($ENV{'logfile'})) and $logfile = $ENV{'logfile'};
(defined($ENV{'logtail'})) and $logtail = $ENV{'logtail'};
(defined($ENV{'offsetfile'})) and $offsetfile = $ENV{'offsetfile'};

if ($cmd eq 'config') {
	print("graph_title MailScanner statistics\n");
	print("graph_args --lower-limit 0\n");
	print("graph_vlabel messages\n");
	print("graph_category spamfilter\n");
	print("clean.label clean\n");
	print("clean.type GAUGE\n");
	print("clean.draw LINE2\n");
	print("viruses.label viruses\n");
	print("viruses.type GAUGE\n");
	print("viruses.draw LINE2\n");
	print("spams.label spams\n");
	print("spams.type GAUGE\n");
	print("spams.draw LINE2\n");
	print("others.label others\n");
	print("others.type GAUGE\n");
	print("others.draw LINE2\n");
	print("total.label total\n");
	print("total.type GAUGE\n");
	print("total.draw LINE2\n");

	exit(0);
}

my @lines = split(/\n/, qx($logtail -f $logfile -o $offsetfile));

# sometimes the logtail syntax is:
#my @lines = split(/\n/, qx($logtail $logfile $offsetfile));

foreach (@lines) {
    if (s/.*New Batch: Scanning ([0-9]+) messages.*/$1/) {
	$total += $_;
	next;
    }
    if (s/.*Virus Scanning: Found ([0-9]+) viruses.*/$1/g) {
	$viruses += $_;
	next;
    }
    if (s/.*Spam Checks: Found ([0-9]+) spam.*/$1/g) {
	$spams += $_;
	next;
    }
    if (s/.*Other Checks: Found ([0-9]+) problems.*/$1/g) {
	$others += $_;
	next;
    }
}

$clean = $total - ($viruses + $spams + $others);

print("clean.value $clean\n");
print("viruses.value $viruses\n");
print("spams.value $spams\n");
print("others.value $others\n");
print("total.value $total\n");

exit(0);