NAME
NetSNMP::Sendmail - NetSNMP plugin for Sendmail statistics
SYNOPSIS
perl use NetSNMP::Sendmail qw (:config bindir /usr/bin/sm.bin);
DESCRIPTION
A perl plugin for net-snmp that provides access to Sendmail statistics information obtained by mailq and mailstats.
In most cases adding
perl use NetSNMP::Sendmail;to snmpd.conf(5) is enough to get the plugin working. You may however need to tune it. For example, Debian-based distributions override default Sendmail binaries with homemade scripts that have somewhat different output format, which can confuse this module. The binaries are then located in the /usr/lib/sm.bin directory. To have the plugin use the right binaries, load it as follows:
perl use NetSNMP::Sendmail qw(:config bindir /usr/lib/sm.bin);Another way to do so would be to export the Configure method and call it right after requiring the module:
perl use NetSNMP::Sendmail qw(Configure);
perl NetSNMP::Sendmail::Configure(bindir => '/usr/lib/sm.bin');In general, configuration options and corresponding values are either passed as a hash to the Configure function, or passed with the use statement following the :config marker. The following options are defined:
- bindir
-
Directory where to look for mailq and mailstats. It is unset by default, which means that both binaries will be looked up using the PATH environment variable, unless they are set to absolute pathname using mailq and mailstats keywords.
- cf
-
Absolute name of the Sendmail configuaration file. Defaults to /etc/mail/sendmail.cf.
- mailstats
-
Name of the mailstats binary. Default is mailstats.
- mailq
-
Name of the mailq binary. Default is mailq.
- mailstats_ttl
-
Time in seconds during which the result of the recent invocation of mailstats(8) is cached. Default is 10.
- mailq_ttl
-
Time in seconds during which the result of the recent invocation of mailq(1) is cached. Default is 10.
OIDS
The MIB is defined in file SENDMAIL-STATS.txt, which is distributed along with this module. The following OIDs are defined:
- queueTotal.0
-
Total number of messages in the queue.
- queueTable
-
This OID provides a conceptual table of Sendmail queue groups. Each row has the following elements (N stands for the row index):
- mailerTable
-
This OID provides a conceptual table of mailers with the corresponding statistics. Each row has the following elements (N stands for the row index):
- mailerName.N
-
Name of the mailer, as set in its definition in sendmail.cf.
- mailerMessagesFrom.N
-
Number of outgoing messages sent using this mailer.
- mailerKBytesFrom.N
-
Number of kilobytes in outgoing messages sent using this mailer.
- mailerMessagesTo.N
-
Number of messages received using this mailer.
- mailerKBytesTo.N
-
Number of kilobytes in messages received using this mailer.
- mailerMessagesRejected.N
-
Number of messages rejected by this mailer.
- mailerMessagesDiscarded.N
-
Number of messages discarded by this mailer.
- mailerMessagesQuarantined.N
-
Number of messages put in quarantine by this mailer.
- totalMessagesFrom.0
-
Total number of outgoing messages.
- totalKBytesFrom.0
-
Total number of outgoing kilobytes.
- totalMessagesTo.0
-
Total number of incoming messages.
- totalKBytesTo.0
-
Total number of incoming kilobytes.
- totalMessagesRejected.0
-
Total number of rejected messages.
- totalMessagesDiscarded.0
-
Total number of discarded messages.
- totalMessagesQuarantined.0
-
Total number of messages put in quarantine.
- connectionMessagesFrom.0
-
Number of messages sent over TCP connections.
- connectionMessagesTo.0
-
Number of messages received over TCP connections.
- connectionMessagesRejected.0
-
Number of messages that arrived over TCP connections and were rejected.
SEE ALSO
snmpd.conf(5), snmpd(8), mailq(1), mailstats(8).
LICENSE
GPLv3+: GNU GPL version 3 or later, see <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
AUTHOR
Sergey Poznyakoff <gray@gnu.org>.