Supervisor: A Process Control System

Supervisor is a client/server system that allows its users to monitorand control a number of processes on UNIX-like operating systems.

It shares some of the same goals of programs like launchd,daemontools, and runit. Unlike some of these programs,it is not meant to be run as a substitute for init as “process id1”. Instead it is meant to be used to control processes related to aproject or a customer, and is meant to start like any other program atboot time.

Narrative Documentation

• Introduction
  • Overview
  • Features
  • Supervisor Components
  • Platform Requirements
• Installing
  • Installing to A System With Internet Access
  • Installing To A System Without Internet Access
  • Installing a Distribution Package
  • Creating a Configuration File
• Running Supervisor
  • Adding a Program
  • Running supervisord
  • Running supervisorctl
  • Signals
  • Runtime Security
  • Running supervisord automatically on startup
• Configuration File
  • File Format
  • [unix_http_server] Section Settings
  • [inet_http_server] Section Settings
  • [supervisord] Section Settings
  • [supervisorctl] Section Settings
  • [program:x] Section Settings
  • [include] Section Settings
  • [group:x] Section Settings
  • [fcgi-program:x] Section Settings
  • [eventlistener:x] Section Settings
  • [rpcinterface:x] Section Settings
• Subprocesses
  • Nondaemonizing of Subprocesses
  • pidproxy Program
  • Subprocess Environment
  • Process States
• Logging
  • Activity Log
  • Child Process Logs
• Events
  • Event Listeners and Event Notifications
    • Configuring an Event Listener
    • Writing an Event Listener
  • Event Types
    • EVENT Event Type
    • PROCESS_STATE Event Type
    • PROCESS_STATE_STARTING Event Type
    • PROCESS_STATE_RUNNING Event Type
    • PROCESS_STATE_BACKOFF Event Type
    • PROCESS_STATE_STOPPING Event Type
    • PROCESS_STATE_EXITED Event Type
    • PROCESS_STATE_STOPPED Event Type
    • PROCESS_STATE_FATAL Event Type
    • PROCESS_STATE_UNKNOWN Event Type
    • REMOTE_COMMUNICATION Event Type
    • PROCESS_LOG Event Type
    • PROCESS_LOG_STDOUT Event Type
    • PROCESS_LOG_STDERR Event Type
    • PROCESS_COMMUNICATION Event Type
    • PROCESS_COMMUNICATION_STDOUT Event Type
    • PROCESS_COMMUNICATION_STDERR Event Type
    • SUPERVISOR_STATE_CHANGE Event Type
    • SUPERVISOR_STATE_CHANGE_RUNNING Event Type
    • SUPERVISOR_STATE_CHANGE_STOPPING Event Type
    • TICK Event Type
    • TICK_5 Event Type
    • TICK_60 Event Type
    • TICK_3600 Event Type
    • PROCESS_GROUP Event Type
    • PROCESS_GROUP_ADDED Event Type
    • PROCESS_GROUP_REMOVED Event Type
• Extending Supervisor’s XML-RPC API
• Upgrading Supervisor 2 to 3
• Frequently Asked Questions
• Resources and Development
• Glossary

API Documentation

• XML-RPC API Documentation
  • Status and Control
  • Process Control
  • Process Logging
  • System Methods

Plugins

• Third Party Applications and Libraries
  • Dashboards and Tools for Multiple Supervisor Instances
  • Third Party Plugins and Libraries for Supervisor
  • Libraries that integrate Third Party Applications with Supervisor

Release History

• Changelog
  • 4.1.0 (2019-10-19)
  • 4.0.4 (2019-07-15)
  • 4.0.3 (2019-05-22)
  • 4.0.2 (2019-04-17)
  • 4.0.1 (2019-04-10)
  • 4.0.0 (2019-04-05)
  • 3.4.0 (2019-04-05)
  • 3.3.5 (2018-12-22)
  • 3.3.4 (2018-02-15)
  • 3.3.3 (2017-07-24)
  • 3.3.2 (2017-06-03)
  • 3.3.1 (2016-08-02)
  • 3.3.0 (2016-05-14)
  • 3.2.4 (2017-07-24)
  • 3.2.3 (2016-03-19)
  • 3.2.2 (2016-03-04)
  • 3.2.1 (2016-02-06)
  • 3.2.0 (2015-11-30)
  • 3.1.4 (2017-07-24)
  • 3.1.3 (2014-10-28)
  • 3.1.2 (2014-09-07)
  • 3.1.1 (2014-08-11)
  • 3.1.0 (2014-07-29)
  • 3.0.1 (2017-07-24)
  • 3.0 (2013-07-30)
  • 3.0b2 (2013-05-28)
  • 3.0b1 (2012-09-10)
  • 3.0a12 (2011-12-06)
  • 3.0a11 (2011-12-06)
  • 3.0a10 (2011-03-30)
  • 3.0a9 (2010-08-13)
  • 3.0a8 (2010-01-20)
  • 3.0a7 (2009-05-24)
  • 3.0a6 (2008-04-07)
  • 3.0a5 (2008-03-13)
  • 3.0a4 (2008-01-30)
  • 3.0a3 (2007-10-02)
  • 3.0a2 (2007-08-24)
  • 3.0a1 (2007-08-16)
  • 2.2b1 (2007-03-31)
  • 2.1 (2007-03-17)
  • 2.1b1 (2006-08-30)
  • 2.0 (2006-08-30)
  • 2.0b1 (2006-07-12)
  • 1.0.7 (2006-07-11)
  • 1.0.6 (2005-11-20)
  • 1.0.5 (2004-07-29)
  • 1.0.4 or “Alpha 4” (2004-06-30)
  • 1.0.3 or “Alpha 3” (2004-05-26)
  • 1.0.2 or “Alpha 2” (Unreleased)
  • 1.0.0 or “Alpha 1” (Unreleased)

Indices and tables

• Index
• Module Index
• Search Page