Skip to content

Commit

Permalink
Fix namespec examples. Refs #79
Browse files Browse the repository at this point in the history
  • Loading branch information
mnaberez committed Sep 5, 2016
1 parent 266636a commit 1dfbc6b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions docs/crashmail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

:command:`crashmail` is a supervisor "event listener", intended to be
subscribed to ``PROCESS_STATE_EXITED`` events. When :command:`crashmail`
receives that event, and the transition is "unexpected", :command:`crashmail``
sends an email notification to a configured address..
receives that event, and the transition is "unexpected", :command:`crashmail`
sends an email notification to a configured address.

:command:`crashmail` is incapable of monitoring the process status of processes
which are not :command:`supervisord` child processes.
Expand All @@ -25,38 +25,38 @@ Command-Line Syntax
.. program:: crashmail

.. cmdoption:: -p <process_name>, --program=<process_name>

Send mail when the specified :command:`supervisord` child process
transitions unexpectedly to the ``EXITED`` state.

This option can be provided more than once to have :command:`crashmail`
monitor more than one program.

To monitor a process which is part of a :command:`supervisord` group,
specify its name as ``process_name:group_name``.
specify its name as ``group_name:process_name``.

.. cmdoption:: -a, --any

Send mail when any :command:`supervisord` child process transitions
unexpectedly to the ``EXITED`` state.

Overrides any ``-p`` parameters passed in the same :command:`crashmail`
process invocation.

.. cmdoption:: -o <prefix>, --optionalheader=<prefix>

Specify a parameter used as a prefix in the mail :mailheader:`Subject`
header.

.. cmdoption:: -s <sendmail_command>, --sendmail_program=<sendmail_command>

Specify the sendmail command to use to send email.

Must be a command which accepts header and message data on stdin and
sends mail. Default is ``/usr/sbin/sendmail -t -i``.

.. cmdoption:: -m <email_address>, --email=<email_address>

Specify an email address to which crash notification messages are sent.
If no email address is specified, email will not be sent.

Expand Down
2 changes: 1 addition & 1 deletion superlance/crashmail.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
-p -- specify a supervisor process_name. Send mail when this process
transitions to the EXITED state unexpectedly. If this process is
part of a group, it can be specified using the
'process_name:group_name' syntax.
'group_name:process_name' syntax.
-a -- Send mail when any child of the supervisord transitions
unexpectedly to the EXITED state unexpectedly. Overrides any -p
Expand Down
2 changes: 1 addition & 1 deletion superlance/memmon.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
-p -- specify a process_name=byte_size pair. Restart the supervisor
process named 'process_name' when it uses more than byte_size
RSS. If this process is in a group, it can be specified using
the 'process_name:group_name' syntax.
the 'group_name:process_name' syntax.
-g -- specify a group_name=byte_size pair. Restart any process in this group
when it uses more than byte_size RSS.
Expand Down

0 comments on commit 1dfbc6b

Please sign in to comment.