Skip to content

supervisorctl Facts

See also: operations/supervisorctl.

supervisorctl.SupervisorctlPid

host.get_fact(SupervisorctlPid, process=None, config_file=None, server_url=None, username=None, password=None)

Returns the PID of supervisord itself, or of a single supervisor managed process when process is given.

A PID of 0 means the process exists but is not running. None means no PID could be read (eg unknown process or supervisord not reachable).

  • process: optional name of the process, defaults to supervisord itself
  • config_file: configuration file to pass to supervisorctl (-c)
  • server_url: URL on which supervisord listens (-s)
  • username: username to authenticate with (-u)
  • password: password to authenticate with (-p)

supervisorctl.SupervisorctlPids

host.get_fact(SupervisorctlPids, config_file=None, server_url=None, username=None, password=None)

Returns a list of the PIDs of all supervisor managed processes (supervisorctl pid all). A PID of 0 means a process is not running. The output of pid all carries no process names; use SupervisorctlStatus to map names to states.

  • config_file: configuration file to pass to supervisorctl (-c)
  • server_url: URL on which supervisord listens (-s)
  • username: username to authenticate with (-u)
  • password: password to authenticate with (-p)

supervisorctl.SupervisorctlStatus

host.get_fact(SupervisorctlStatus, config_file=None, server_url=None, username=None, password=None)

Returns a dict of supervisor process names to their running state.

Processes inside a group are keyed by their full group:name name.

  • config_file: configuration file to pass to supervisorctl (-c)
  • server_url: URL on which supervisord listens (-s)
  • username: username to authenticate with (-u)
  • password: password to authenticate with (-p)
{
    "web": True,             # RUNNING or STARTING
    "workers:worker_0": False,  # STOPPED, STOPPING or EXITED
    "broken": None,          # BACKOFF, FATAL or UNKNOWN
}