Supervisord Cheat Sheet

A cheat sheet in English by misterrabinhalder

9,619 views 2,029 downloads 28 Mar 2019 History

PRs

4.3 avg · 1 rating

Running supervisord

-c FILE	path to supervisord configuration file
-n	run supervisord in the foreground
-u USER	UNIX username or numeric user id
-l FILE	filename path to use as the supervisord activity log
-e LEVEL	Valid levels are trace, debug, info, warn, error, and critical
-j FILE	filename to which supervisord should write its pid file

Running supervisorctl

-c FILE	configuration file path
-u USER	username to use for authentication with server
-p PASSWORD	password to use for authentication with server
-r	keep a readline history

Supervisord Signal

SIGTERM	supervisord and all its subprocesses will shut down
SIGINT	supervisord and all its subprocesses will shut down
SIGQUIT	supervisord and all its subprocesses will shut down
SIGHUP	supervisord will stop all processes, reload the configuration from the first config file it finds, and start all processes
SIGUSR2	supervisord will close and reopen the main activity log and all child log files

Installing supervisord

Installing With Pip

pip install supervisor

Install On Debian

apt-get install supervisor

Install On Redhat

yum install supervisor

Install On Archlinux

pacman -S supervisor

Using Environment Variables

[program:example]
command=/usr/bin/example --loglevel=%(ENV_LOGLEVEL)s

Environment variables that are present in the environment at the time that supervisord is started can be used in the configuration file using the Python string expression syntax %(ENV_X)s

Using UNIX domain socket

[unix_http_server]
file = /tmp/supervisor.sock
chmod = 0777
chown= nobody:nogroup
username = user
password = 123

HTTP server that listens on a UNIX domain socket

Using process group

[group:foo]
programs=bar,baz
priority=999

Group “homogeneous” process groups (aka “programs”) together into a “heterogeneous” process group

Using TCP domain socket

[inet_http_server]
port = 127.0.0.1:9001
username = user
password = 123

HTTP server that listens on a TCP (internet) socket

Using supervisord

[supervisord]
logfile = /tmp/supervisord.log
logfile_maxbytes = 50MB
logfile_backups=10
loglevel = info
pidfile = /tmp/supervisord.pid
nodaemon = false
minfds = 1024
minprocs = 200
umask = 022
user = chrism
identifier = supervisor
directory = /tmp
nocleanup = true
childlogdir = /tmp
strip_ansi = false
environment = KEY1="value1",KEY2="value2"

Global settings related to the supervisord

Using supervisorctl

[supervisorctl]
serverurl = unix:///tmp/supervisor.sock
username = chris
password = 123
prompt = mysupervisor

Supervisorctl interactive shell program

Using program

[program:cat]
command=/bin/cat
process_name=%(program_name)s
numprocs=1
directory=/tmp
umask=022
priority=999
autostart=true
autorestart=unexpected
startsecs=10
startretries=3
exitcodes=0,2
stopsignal=TERM
stopwaitsecs=10
stopasgroup=false
killasgroup=false
user=chrism
redirect_stderr=false
stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB
stdout_events_enabled=false
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_capture_maxbytes=1MB
stderr_events_enabled=false
environment=A="1",B="2"
serverurl=AUTO

Supervisord to know which programs it should start and control

Using configuration directory

[include]
files = supervisord.d/*.conf

Include configuration files from drop in directory

Log Level

critical	CRIT
error	ERRO
warn	WARN
info	INFO
debug	DEBG
trace	TRAC
blather	BLAT

Supervisorctl actions

help	print a list of available actions
help <action>	print help for <action>
add <name> [...]	activates any updates in config for process/group
remove <name> [...]	removes process/group from active config
update	reload config and then add and remove as necessary
clear <name>	clear a process’ log files
clear <name> <name>	clear multiple process’ log files
clear all	clear all process’ log files
fg <process>	connect to a process in foreground mode Press Ctrl+C to exit foreground
pid	get the PID of supervisord
pid <name>	get the PID of a single child process by name
pid all	get the PID of every child process, one per line
reload	restarts the remote supervisord
reread	reload the daemon’s configuration files, without add/remove (no restarts)
restart <name>	restart a process
restart <gname>:*	restart all processes in a group
restart <name> <name>	restart multiple processes
restart all	restart all processes
signal	No help on signal
start <name>	start a process
start <gname>:*	start all processes in a group
start <name> <name>	start multiple processes
start all	start all processes
status	get all process status info
status <name>	get status on a single process by name
status <name> <name>	get status on multiple named processes
stop <name>	stop a process
stop <gname>:*	stop all processes in a group
stop <name> <name>	stop multiple processes or groups
stop all	stop all processes
tail [-f] <name> [stdout\|stderr]	output the last part of process logs

Badges

Nice Cheat Sheet Downloaded from Unusual Locations × 1

Comments

No comments yet.

Supervisord Cheat Sheet

Running superv­isord

Running superv­isorctl

Superv­isord Signal

Installing superv­isord

Using Enviro­nment Variables