'\" t
.\"     Title: mailping-success
.\"    Author: Tommi Virtanen <tv@havoc.fi>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 
      2004-04-16
    
.\"    Manual: Mailping
.\"    Source: 
      mailping
     
      0.0.4
    
.\"  Language: English
.\"
.TH "MAILPING\-SUCCESS" "1" "2004\-04\-16" "mailping 0." "Mailping"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
mailping-success \- Munin plugin to graph time since last mail delivery
.SH "SYNOPSIS"
.HP \w'\fB/usr/share/mailping/munin\-plugins/mailping\-success\fR\ 'u
\fB/usr/share/mailping/munin\-plugins/mailping\-success\fR {[config] | [\*(Aq\*(Aq]}
.SH "DESCRIPTION"
.PP
 \fBmailping\-success\fR is a Munin plugin that monitors time passed since last successful email probe\&.
.SS "Configuration output"
.PP
When passed \fBconfig\fP, it outputs Munin configuration information\&. If there are no circuits defined (no subdirectories in \fI/etc/mailping\fP), it specifies that Munin should draw no graph either\&.
.PP
If configuration files \fI/etc/mailping/\fBcircuit\fP/warntime\fP and \fI/etc/mailping/\fBcircuit\fP/failtime\fP exist, the values in them are passed on to Munin, for use in Nagios alert integration\&.
.SS "Value output"
.PP
When passed an empty string \fB\*(Aq\*(Aq\fP, \fBmailping\-success\fR outputs the difference between current time and last successful probe, for each configured circuit\&.
.SH "FILES"
.PP
\fI/etc/mailping/\fP
.RS 4
List of circuits that exist; each subdirectory is a circuit\&.
.RE
.PP
\fI/etc/mailping/\fBcircuit\fP/warntime\fP
.RS 4
If more than this many seconds have passed since last successful probe, a Nagios warning is triggered by Munin (assuming it has been configured to do that)\&. Default: no warnings\&.
.RE
.PP
\fI/etc/mailping/\fBcircuit\fP/failtime\fP
.RS 4
If more than this many seconds have passed since last successful probe, a Nagios alert is triggered by Munin (assuming it has been configured to do that)\&. Default: no alerts\&.
.RE
.PP
\fI/var/lib/mailping/state/\fBcircuit\fP/success\fP
.RS 4
Timestamp in seconds of the last successful probe for
\fBcircuit\fP\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBMAILPING_CONFIGDIR\fP
.RS 4
Override the location of the configuration directory\&. Default:
\fI/etc/mailping\fP
.RE
.PP
\fBMAILPING_STATEDIR\fP
.RS 4
Override the location of the state directory\&. Circuit states are stored in the
\fIstate\fP
subdirectory of this directory, in subdirectories named after the circuit name\&. Default:
\fI/var/lib/mailping\fP
.RE
.SH "SEE ALSO"
.PP
 mailping\-latency(1), mailping\-cron(1), mailping\-store(1), \fImunin\-run(8)\fR, \fImunin\-node(8)\fR 
.SH "AUTHOR"
.PP
\fBTommi Virtanen\fR <\&tv@havoc\&.fi\&>
.br
Havoc Consulting
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2004 Havoc Consulting
.br