From 1dfbc6be91ca3adc2d43d16cf32a9a01c1691e01 Mon Sep 17 00:00:00 2001 From: Mike Naberezny Date: Mon, 5 Sep 2016 15:38:14 -0700 Subject: [PATCH] Fix namespec examples. Refs #79 --- docs/crashmail.rst | 24 ++++++++++++------------ superlance/crashmail.py | 2 +- superlance/memmon.py | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/crashmail.rst b/docs/crashmail.rst index bcfa37f..ed847f9 100644 --- a/docs/crashmail.rst +++ b/docs/crashmail.rst @@ -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. @@ -25,38 +25,38 @@ Command-Line Syntax .. program:: crashmail .. cmdoption:: -p , --program= - + 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 , --optionalheader= - + Specify a parameter used as a prefix in the mail :mailheader:`Subject` header. .. cmdoption:: -s , --sendmail_program= - + 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= - + Specify an email address to which crash notification messages are sent. If no email address is specified, email will not be sent. diff --git a/superlance/crashmail.py b/superlance/crashmail.py index 7335887..6fe5fae 100644 --- a/superlance/crashmail.py +++ b/superlance/crashmail.py @@ -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 diff --git a/superlance/memmon.py b/superlance/memmon.py index d36c207..795ea7b 100644 --- a/superlance/memmon.py +++ b/superlance/memmon.py @@ -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.