crashmailbatch Documentation¶
crashmailbatch is a supervisor “event listener”, intended to be
subscribed to PROCESS_STATE
and TICK_60
events. It monitors
all processes running under a given supervisord instance.
Similar to crashmail, crashmailbatch sends email alerts when processes die unexpectedly. The difference is that all alerts generated within the configured time interval are batched together to avoid sending too many emails.
crashmailbatch is a “console script” installed when you install
superlance
. Although crashmailbatch is an executable
program, it isn’t useful as a general-purpose script: it must be run as a
supervisor event listener to do anything useful.
Command-Line Syntax¶
$ crashmailbatch --toEmail=<email address> --fromEmail=<email address> \
[--interval=<batch interval in minutes>] [--subject=<email subject>] \
[--tickEvent=<event name>] [--smtpHost=<SMTP server>] \
[--userName=<SMTP username>] [--password=<STMP password>] \
[--tls]
-
-t
<destination email>
,
--toEmail
=<destination email>
¶ Specify comma separated email addresses to which crash notification messages are sent.
-
-f
<source email>
,
--fromEmail
=<source email>
¶ Specify an email address from which crash notification messages are sent.
-
-i
<interval>
,
--interval
=<interval>
¶ Specify the time interval in minutes to use for batching notifcations. Defaults to 1.0 minute.
-
-s
<email subject>
,
--subject
=<email subject>
¶ Override the email subject line. Defaults to “Crash alert from supervisord”
-
-e
<event name>
,
--tickEvent
=<event name>
¶ Override the TICK event name. Defaults to “TICK_60”
-
-H
<STMP server> --smtpHost <SMTP server>
¶ Specify STMP server for sending email
-
-u
<STMP username> --userName <SMTP username>
¶ Specify STMP username
-
-p
<STMP password> --password <SMTP password>
¶ Specify STMP password
-
--tls
¶
Use Transport Layer Security (TLS)
Configuring crashmailbatch Into the Supervisor Config¶
An [eventlistener:x]
section must be placed in supervisord.conf
in order for crashmailbatch to do its work. See the “Events” chapter in
the Supervisor manual for more information about event listeners.
The following example assumes that crashmailbatch is on your system
PATH
.
[eventlistener:crashmailbatch]
command=crashmailbatch --toEmail="alertme@fubar.com" --fromEmail="supervisord@fubar.com"
events=PROCESS_STATE,TICK_60