supervisor/CHANGES.txt

Next Release

  - Supervisorctl now reports a better error message when the main
    supervisor XML-RPC namespace is not registered.  Thanks to
    Mike Orr for reporting this. (Mike Naberezny)

  - Create 'scripts' directory within supervisor package, move
    'pidproxy.py' there, and place sample event listener and comm
    event programs within the directory.

  - When an event notification is buffered (either because a listener
    rejected it or because all listeners were busy when we attempted
    to send it originally), we now rebuffer it in a way that will
    result in it being retried earlier than it used to be.

  - When a listener process exits (unexpectedly) before transitioning
    from the BUSY state, rebuffer the event that was being processed.

  - supervisorctl 'tail' command now accepts a trailing specifier:
    'stderr' or 'stdout', which respectively, allow a user to tail the
    stderr or stdout of the named process.  When this specifier is not
    provided, tail defaults to stdout.

  - supervisor 'clear' command now clears both stderr and stdout logs
    for the given process.

  - When a process encounters a spawn error as a result of a failed
    execve or when it cannot setuid to a given uid, it now puts this
    info into the process' stderr log rather than its stdout log.

  - The event listener protocol header now contains the 'server'
    identifier, the 'pool' that the event emanated from, and the
    'poolserial' as well as the values it previously contained
    (version, event name, serial, and length).  The server identifier
    is taken from the config file options value 'identifier', the
    'pool' value is the name of the listener pool that this event
    emanates from, and the 'poolserial' is a serial number assigned to
    the event local to the pool that is processing it.

  - The event listener protocol header is now a sequence of key-value
    pairs rather than a list of positional values.  Previously, a
    representative header looked like:

      SUPERVISOR3.0 PROCESS_COMMUNICATION_STDOUT 30 22\n

    Now it looks like:

      ver:3.0 server:supervisor serial:21 ... 

  - Specific event payload serializations have changed.  All event
    types that deal with processes now include the pid of the process
    that the event is describing.  In event serialization "header"
    values, we've removed the space between the header name and the
    value and headers are now separated by a space instead of a line
    feed.  The names of keys in all event types have had underscores
    removed.

  - Abandon the use of the Python stdlib 'logging' module for speed
    and cleanliness purposes.  We've rolled our own.

  - Fix crash on start if AUTO logging is used with a max_bytes of
    zero for a process.

  - Improve process communication event performance.

  - The process config parameters 'stdout_capturefile' and
    'stderr_capturefile' are no longer valid.  They have been replaced
    with the 'stdout_capture_maxbytes' and 'stderr_capture_maxbytes'
    parameters, which are meant to be suffix-multiplied integers.
    They both default to zero.  When they are zero, process
    communication event capturing is not performed.  When either is
    nonzero, the value represents the maximum number of bytes that
    will be captured between process event start and end tags.  This
    change was to support the fact that we no longer keep capture data
    in a separate file, we just use a FIFO in RAM to maintain capture
    info.  For users whom don't care about process communication
    events, or whom haven't changed the defaults for
    'stdout_capturefile' or 'stderr_capturefile', they needn't do
    anything to their configurations to deal with this change.

  - Log message levels have been normalized.  In particular, process
    stdin/stdout is now logged at 'debug' level rather than at 'trace'
    level ('trace' level is now reserved for output useful typically
    for debugging supervisor itself).  See 'Supervisor Log Levels' in
    README.txt for more info.

  - When an event is rebuffered (because all listeners are busy or a
    listener rejected the event), the rebuffered event is now inserted
    in the head of the listener event queue.  This doesn't guarantee
    event emission in natural ordering, because if a listener rejects
    an event or dies while it's processing an event, it can take an
    arbitrary amount of time for the event to be rebuffered, and other
    events may be processed in the meantime.  But if pool listeners
    never reject an event or don't die while processing an event, this
    guarantees that events will be emitted in the order that they were
    received because if all listeners are busy, the rebuffered event
    will be tried again "first" on the next go-around.

  - Removed EVENT_BUFFER_OVERFLOW event type.

  - The supervisorctl xmlrpc proxy can now communicate with
    supervisord using a persistent HTTP connection.

  - A new module, "supervisor.childutils" was added.  This module
    contains API functions useful for Python programs running under
    supervisord (header parsing, obtaining an RPC proxy).

  - A new envvar is added to child process environments:
    SUPERVISOR_SERVER_URL.  This contains the server URL for the
    supervisord running the child.

  - An 'OK' URL was added at /ok.html which just returns the string
    'OK' (can be used for up checks or speed checks via
    plain-old-HTTP).

  - An additional command-line option '--profile_options' is accepted
    by the supervisord script for developer use.  It accepts the same
    command line arguments as the 'supervisord' script.

      supervisord -n -c sample.conf --profile_options=cumulative,calls

    The values are sort_stats options that can be passed to the
    standard Python profiler's PStats sort_stats method.

    When you exit supervisor, it will print Python profiling output to
    stdout.

3.0a2

  - Fixed the README.txt example for defining the supervisor RPC
    interface in the configuration file.  Thanks to Drew Perttula.

  - Fixed a bug where process communication events would not have the
    proper payload if the payload data was very short.

  - when supervisord attempted to kill a process with SIGKILL after
    the process was not killed within "stopwaitsecs" using a "normal"
    kill signal, supervisord would crash with an improper
    AssertionError.  Thanks to Calvin Hendryx-Parker.

  - On Linux, Supervisor would consume too much CPU in an effective
    "busywait" between the time a subprocess exited and the time at
    which supervisor was notified of its exit status.  Thanks to Drew
    Perttula.

  - RPC interface behavior change: if the RPC method
    "sendProcessStdin" is called against a process that has closed its
    stdin file descriptor (e.g. it has done the equivalent of
    "sys.stdin.close(); os.close(0)"), we return a NO_FILE fault
    instead of accepting the data.

  - Changed the semantics of the process configuration 'autorestart'
    parameter with respect to processes which move between the RUNNING
    and EXITED state.  'autorestart' was previously a boolean.  Now
    it's a trinary, accepting one of 'false', 'unexpected', or 'true'.
    If it's 'false', a process will never be automatically restarted
    from the EXITED state.  If it's 'unexpected', a process that
    enters the EXITED state will be automatically restarted if it
    exited with an exit code that was not named in the process
    config's 'exitcodes' list.  If it's 'true', a process that enters
    the EXITED state will be automatically restarted unconditionally.
    The default is now 'unexpected' (it was previously 'true').  The
    readdition of this feature is a reversion of the behavior change
    note in the changelog notes for 3.0a1 that asserted we never cared
    about the process' exit status when determining whether to restart
    it or not.

  - setup.py develop (and presumably setup.py install) would fail
    under Python 2.3.3, because setuptools attempted to import
    'splituser' from urllib2, and it didn't exist.

  - It's now possible to use 'setup.py install' and 'setup.py develop'
    on systems which do not have a C compiler if you set the
    environment variable "NO_MELD3_EXTENSION_MODULES=1" in the shell
    in which you invoke these commands (versions of meld3 > 0.6.1
    respect this envvar and do not try to compile optional C
    extensions when it's set).

  - The test suite would fail on Python versions <= 2.3.3 because
    the "assertTrue" and "assertFalse" methods of unittest.TestCase
    didn't exist in those versions.

  - The 'supervisorctl' and 'supervisord' wrapper scripts were disused
    in favor of using setuptools' 'console_scripts' entry point settings.

  - Documentation files and the sample configuration file are put into
    the generated supervisor egg's 'doc' directory.

  _ Using the web interface would cause fairly dramatic memory
    leakage.  We now require a version of meld3 that does not appear
    to leak memory from its C extensions (0.6.3).

3.0a1

  - Default config file comment documented 10 secs as default for
    'startsecs' value in process config, in reality it was 1 sec.
    Thanks to Christoph Zwerschke.

  - Make note of subprocess environment behavior in README.txt.
    Thanks to Christoph Zwerschke.

  - New "strip_ansi" config file option attempts to strip ANSI escape
    sequences from logs for smaller/more readable logs (submitted by
    Mike Naberezny).

  - The XML-RPC method supervisor.getVersion() has been renamed for 
    clarity to supervisor.getAPIVersion().  The old name is aliased 
    for compatibility but is deprecated and will be removed in a
    future version (Mike Naberezny).

  - Improved web interface styling (Mike Naberezny, Derek DeVries)

  - The XML-RPC method supervisor.startProcess() now checks that
    the file exists and is executable (Mike Naberezny).

  - Two environment variables, "SUPERVISOR_PROCESS_NAME" and
    "SUPERVISOR_PROCESS_GROUP" are set in the environment of child
    processes, representing the name of the process and group in
    supervisor's configuration.

  - Process state map change: a process may now move directly from the
    STARTING state to the STOPPING state (as a result of a stop
    request).

  - Behavior change: if 'autorestart' is true, even if a process exits
    with an "expected" exit code, it will still be restarted.  In the
    immediately prior release of supervisor, this was true anyway, and
    no one complained, so we're going to consider that the "officially
    correct" behavior from now on.

  - Supervisor now logs subprocess stdout and stderr independently.
    The old program config keys "logfile", "logfile_backups" and
    "logfile_maxbytes" are superseded by "stdout_logfile",
    "stdout_logfile_backups", and "stdout_logfile_maxbytes".  Added
    keys include "stderr_logfile", "stderr_logfile_backups", and
    "stderr_logfile_maxbytes".  An additional "redirect_stderr" key is
    used to cause program stderr output to be sent to its stdin
    channel.  The keys "log_stderr" and "log_stdout" have been
    removed.

  - '[program:x]' config file sections now represent "homgeneous
    process groups" instead of single processes.  A "numprocs" key in
    the section represents the number of processes that are in the
    group.  A "process_name" key in the section allows composition of
    the each process' name within the homogeneous group.

  - A new kind of config file section, '[group:x]' now exists,
    allowing users to group heterogeneous processes together into a
    process group that can be controlled as a unit from a client.

  - Supervisord now emits "events" at certain points in its normal
    operation.  These events include supervisor state change events,
    process state change events, and "process communication events".

  - A new kind of config file section '[eventlistener:x]' now exists.
    Each section represents an "event listener pool", which is a
    special kind of homogeneous process group.  Each process in the
    pool is meant to receive supervisor "events" via its stdin and
    perform some notification (e.g. send a mail, log, make an http
    request, etc.)

  - Supervisord can now capture data between special tokens in
    subprocess stdout/stderr output and emit a "process communications
    event" as a result.

  - Supervisor's XML-RPC interface may be extended arbitrarily by
    programmers.  Additional top-level namespace XML-RPC interfaces
    can be added using the '[rpcinterface:foo]' declaration in the
    configuration file.

  - New 'supervisor'-namespace XML-RPC methods have been added:
    getAPIVersion (returns the XML-RPC API version, the older
    "getVersion" is now deprecated), "startProcessGroup" (starts all
    processes in a supervisor process group), "stopProcessGroup"
    (stops all processes in a supervisor process group), and
    "sendProcessStdin" (sends data to a process' stdin file
    descriptor).

  - 'supervisor'-namespace XML-RPC methods which previously accepted
    ony a process name as "name" (startProcess, stopProcess,
    getProcessInfo, readProcessLog, tailProcessLog, and
    clearProcessLog) now accept a "name" which may contain both the
    process name and the process group name in the form
    'groupname:procname'.  For backwards compatibility purposes,
    "simple" names will also be accepted but will be expanded
    internally (e.g. if "foo" is sent as a name, it will be expanded
    to "foo:foo", representing the foo process within the foo process
    group).

  - 2.X versions of supervisorctl will work against supervisor 3.0
    servers in a degraded fashion, but 3.X versions of supervisorctl
    will not work at all against supervisor 2.X servers.

  Known issues:

    - supervisorctl and the web interface do not yet allow you to stop
      / start / restart a process group as a unit.

    - supervisorctl and the web interface do not allow you to tail or
      otherwise examine stderr log files of processes.

    - buffered event notifications may be lost at supervisor shutdown
      or restart time.

  Acknowledgements:

    Maintainable Software (http://www.maintainable.com) contracted
    Agendless Consulting to add the event notification features and
    extensible XML-RPC namespaces feature to supervisor.

2.2b1

  - Individual program configuration sections can now specify an
    environment.

  - Added a 'version' command to supervisorctl.  This returns the
    version of the supervisor2 package which the remote supervisord
    process is using.

2.1

  - When supervisord was invoked more than once, and its configuration
    was set up to use a UNIX domain socket as the HTTP server, the
    socket file would be erased in error.  The symptom of this was
    that a subsequent invocation of supervisorctl could not find the
    socket file, so the process could not be controlled (it and all of
    its subprocesses would need to be killed by hand).

  - Close subprocess file descriptors properly when a subprocess exits
    or otherwise dies.  This should result in fewer "too many open
    files to spawn foo" messages when supervisor is left up for long
    periods of time.

  - When a process was not killable with a "normal" signal at shutdown
    time, too many "INFO: waiting for x to die" messages would be sent
    to the log until we ended up killing the process with a SIGKILL.
    Now a maximum of one every three seconds is sent up until SIGKILL
    time.  Thanks to Ian Bicking.

  - Add an assertion: we never want to try to marshal None to XML-RPC
    callers.  Issue 223 in the collector from vgatto indicates that
    somehow a supervisor XML-RPC method is returning None (which
    should never happen), but I cannot identify how.  Maybe the
    assertion will give us more clues if it happens again.

  - Supervisor would crash when run under Python 2.5 because the
    xmlrpclib.Transport class in Python 2.5 changed in a
    backward-incompatible way.  Thanks to Eric Westra for the bug
    report and a fix.

  - Tests now pass under Python 2.5.

  - Better supervisorctl reporting on stop requests that have a FAILED
    status.

  - Removed duplicated code (readLog/readMainLog), thanks to Mike
    Naberezny.

  - Added tailProcessLog command to the XML-RPC API.  It provides a
    more efficient way to tail logs than readProcessLog().  Use
    readProcessLog() to read chunks and tailProcessLog() to tail.
    (thanks to Mike Naberezny).

2.1b2

  - Added new tailProcessLog() command to the XML-RPC API that
    is more efficient for just tailing than the existing
    readProcessLog() command (Mike Naberezny).

2.1b1

  - "supervisord -h" and "supervisorctl -h" did not work (traceback
    instead of showing help view (thanks to Damjan from Macedonia for
    the bug report).

  - Processes which started successfully after failing to start
    initially are no longer reported in BACKOFF state once they are
    started successfully (thanks to Damjan from Macdonia for the bug
    report).

  - Add new 'maintail' command to supervisorctl shell, which allows
    you to tail the 'main' supervisor log.  This uses a new
    readMainLog xmlrpc API.

  - Various process-state-transition related changes, all internal.
    README.txt updated with new state transition map.

  - startProcess and startAllProcesses xmlrpc APIs changed: instead of
    accepting a timeout integer, these accept a wait boolean (timeout
    is implied by process' "startsecs" configuration).  If wait is
    False, do not wait for startsecs.

  Known issues:

    Code does not match state transition map.  Processes which are
    configured as autorestarting which start "successfully" but
    subsequently die after 'startsecs' go through the transitions
    RUNNING -> BACKOFF -> STARTING instead of the correct transitions
    RUNNING -> EXITED -> STARTING.  This has no real negative effect,
    but should be fixed for correctness.

2.0

  - pidfile written in daemon mode had incorrect pid.

  - supervisorctl: tail (non -f) did not pass through proper error
    messages when supplied by the server.

  - Log signal name used to kill processes at debug level.

  - supervisorctl "tail -f" didn't work with supervisorctl sections
    configured with an absolute unix:// URL

  - New "environment" config file option allows you to add environment
    variable values to supervisord environment from config file.

2.0b1

  - fundamental rewrite based on 1.0.6, use distutils (only) for
    installation, use ConfigParser rather than ZConfig, use HTTP for
    wire protocol, web interface, less lies in supervisorctl.