.\" $Id$
.\""
.TH WATCH-MIMEDEFANG 8 "24 October 2002"
.UC 4
.SH NAME
watch-mimedefang \- Keep an eye on mimedefang-multiplexor
.SH SYNOPSIS
.B watch-mimedefang \fR[\fIoptions\fR]

.SH DESCRIPTION
\fBwatch-mimedefang\fR is a Tk script which graphically displays the status
of \fBmimedefang-multiplexor\fR(8).  Note that Tcl/Tk 8.0 or higher is
required to run \fBwatch-mimedefang\fR.

.SH DISPLAY

\fBwatch-mimedefang\fR's display is divided into three main areas, from
top to bottom:

.TP
.B o
The graph display shows six graphs representing various statistics about
the multiplexor.

.TP
.B o
The control area shows the maximum number of workers, number of busy workers,
and number of idle workers.  The "Control Command" text entry lets you
monitor remote MIMEDefang servers; see "REMOTE MONITORING" for details.

The "10s", "1m", "5m" and "10m" checkboxes allow you to enable or disable
the graphing of statistics averaged over the last 10 seconds, 1 minute,
5 minutes and 10 minutes.

The "Reread Filters" button forces the multiplexor to reread filter rules.
The "Quit" button terminates \fBwatch-mimedefang\fR.

.TP
.B o
The scale at the bottom lets you change the update interval (default 500ms).
Be aware that frequent updating may make \fBwatch-mimedefang\fR consume
a significant fraction of CPU time.

.SH THE GRAPH AREA

The graph area contains six graphs:

.TP
.B o Busy Workers
This graph shows the number of busy workers each time the statistics are
sampled.

.TP
.B o Workers/scan
This graph shows the average number of busy workers each time a message was
scanned.  The red plot shows the average over the last ten seconds, the
blue plot shows the average over the last minute, and the green and yellow
plots show the average over the last five and ten minutes, respectively.

.TP
.B o Latency (ms)
This graph shows the average time taken by each SCAN command over the
last ten seconds, one minute, five minutes and ten minutes.

.TP
.B o Messages/s
This graph shows the average number of messages per second that were scanned.

.TP
.B o Activations/s
This graph shows the average number of new workers activated per second.

.TP
.B o Reaps/s
This graph shows the average number of workers that have terminated per
second.

If the Activations and Reaps increase significantly, it could indicate
heavy load, or an error causing filters to terminate abnormally.

If only Activations increase, then it probably indicates a sudden increase
in e-mail volume.

If only Reaps increase, then it probably indicates a quiet time just after
a period of heavy mail volume.

.PP
You can enable or disable the ten second, one minute, five minute or
ten minute plots by clicking on the "10s", "1m", "5m" or "10m" checkbox.

.SH REMOTE MONITORING

Running \fBwatch-mimedefang\fR on your actual mail server poses two problems:
You need Tcl/Tk and the X client libraries installed, and the CPU consumption
of \fBwatch-mimedefang\fR can be considerable.

A better method is to run \fBwatch-mimedefang\fR on a desktop machine,
but have it monitor the mail server with a remote session.

The best way to establish a remote session is via SSH.  For example,
if you are running MIMEDefang on "mail.mydomain.net", you can type
the following into the \fBControl Command\fR entry box and press enter:

.nf
	ssh root@mail.mydomain.net md-mx-ctrl
.fi

You \fImust\fR have a public/private key for the target machine and you
must be running ssh-agent or equivalent; you cannot use an ssh command
that requires entry of a password or passphrase.

Assuming your SSH setup is correct, \fBwatch-mimedefang\fR will open
an SSH connection to mail.mydomain.net and exchange low-bandwith information
over that session for monitoring purposes.

.SH COMMAND-LINE OPTIONS

\fBwatch-mimedefang\fR accepts the following command-line options:

.TP
.B -command \fIcmd\fR
Use \fIcmd\fR as the control command.  You may need to quote \fIcmd\fR

.TP
.B -interval \fImsec\fR
Set the update interval to \fImsec\fR milliseconds.

.TP
.B -10s \fIflag\fR
Enable the "10s" graph plot if \fIflag\fR is 1, or disable it if
\fIflag\fR is 0.

.TP
.B -1m \fIflag\fR
Enable the "1m" graph plot if \fIflag\fR is 1, or disable it if
\fIflag\fR is 0.

.TP
.B -5m \fIflag\fR
Enable the "5m" graph plot if \fIflag\fR is 1, or disable it if
\fIflag\fR is 0.

.TP
.B -10m \fIflag\fR
Enable the "10m" graph plot if \fIflag\fR is 1, or disable it if
\fIflag\fR is 0.

.TP
.B -title \fIstring\fR
Add \fIstring\fR to the title of the main window.

.TP
.B -help
Print usage information.

.SH EXAMPLE

As an example, to monitor MIMEDefang on the machine "mail.mydomain.net"
updating once a second, with the 5m and 10m plots turned off, use:

.nf
    watch-mimedefang -command 'ssh root@mail.mydomain.net md-mx-ctrl' \\
                     -interval 1000 -5m 0 -10m 0 -title "mail"
.fi

.SH AUTHOR
\fBwatch-mimedefang\fR was written by Dianne Skoll <dfs@roaringpenguin.com>.
The \fBmimedefang\fR home page is \fIhttps://www.mimedefang.org/\fR.

.SH PERMISSIONS
\fBwatch-mimedefang\fR uses \fBmd-mx-ctrl\fR; therefore, it probably
needs to be run as \fIroot\fR or the same user as \fBmimedefang-multiplexor\fR,
or (if you are monitoring a remote machine), the SSH connection must be done
as root or the MIMEDefang user.


.SH SEE ALSO
mimedefang.pl(8), mimedefang-filter(5), mimedefang(8), mimedefang-protocol(7),
md-mx-ctrl(8), watch-multiple-mimedefangs(8)