Skip to main content

Supervisor 开始

Supervisor 是 Linux/Unix 操作系统上的进程管理工具。本文介绍了于 Ubuntu 18 上如何使用 Supervisor 开机启动、保活守护自己的服务进程。

安装#

建议系统方式安装,可开机启动。

sudo apt install supervisor -y

Systemd 查看服务状态:

$ sudo systemctl status supervisor● supervisor.service - Supervisor process control system for UNIX   Loaded: loaded (/lib/systemd/system/supervisor.service; enabled; vendor preset: enabled)   Active: active (running) since Tue 2021-06-08 18:00:00 CST; 4min 0s ago     Docs: http://supervisord.org Main PID: 26297 (supervisord)    Tasks: 1 (limit: 4915)   CGroup: /system.slice/supervisor.service           └─26297 /usr/bin/python /usr/bin/supervisord -n -c /etc/supervisor/supervisord.conf
6月 08 18:00:00 john-ubuntu18 systemd[1]: Started Supervisor process control system for UNIX.6月 08 18:00:00 john-ubuntu18 supervisord[26297]: 2021-06-08 18:00:00,422 CRIT Supervisor running as root (no user in config file)6月 08 18:00:00 john-ubuntu18 supervisord[26297]: 2021-06-08 18:00:00,422 WARN No file matches via include "/etc/supervisor/conf.d/*.conf"6月 08 18:00:00 john-ubuntu18 supervisord[26297]: 2021-06-08 18:00:00,428 INFO RPC interface 'supervisor' initialized6月 08 18:00:00 john-ubuntu18 supervisord[26297]: 2021-06-08 18:00:00,428 CRIT Server 'unix_http_server' running without any HTTP authentication checki6月 08 18:00:00 john-ubuntu18 supervisord[26297]: 2021-06-08 18:00:00,428 INFO supervisord started with pid 26297
  • Loaded: 配置路径; 开机启动状态
  • Active: 活动状态
  • Main PID: 主进程 ID
  • Tasks: 任务数量
  • CGroup: 子进程树

Systemd 的服务配置:

$ cat /lib/systemd/system/supervisor.service[Unit]Description=Supervisor process control system for UNIXDocumentation=http://supervisord.orgAfter=network.target
[Service]ExecStart=/usr/bin/supervisord -n -c /etc/supervisor/supervisord.confExecStop=/usr/bin/supervisorctl $OPTIONS shutdownExecReload=/usr/bin/supervisorctl -c /etc/supervisor/supervisord.conf $OPTIONS reloadKillMode=processRestart=on-failureRestartSec=50s
[Install]WantedBy=multi-user.target

如果 pip 安装 Supervisor,可如上添加 Systemd 服务配置:

pip install supervisor
# 添加配置sudo -icat <<-EOF > /etc/systemd/system/supervisord.service[Unit]Description=Supervisor process control system for UNIXDocumentation=http://supervisord.orgAfter=network.target
[Service]ExecStart=/home/john/anaconda3/bin/supervisord/supervisord -n -c /etc/supervisor/supervisord.confExecStop=/home/john/anaconda3/bin/supervisord/supervisorctl $OPTIONS shutdownExecReload=/home/john/anaconda3/bin/supervisord/supervisorctl -c /etc/supervisor/supervisord.conf $OPTIONS reloadKillMode=processRestart=on-failureRestartSec=50s
[Install]WantedBy=multi-user.targetEOF
# 重载配置systemctl daemon-reload
# 开机启动sudo systemctl enable supervisord.service

Systemd 管理服务:

# 启用开机启动sudo systemctl enable supervisor# 关闭开机启动sudo systemctl disable supervisor
# 启用服务systemctl start supervisor# 关闭服务systemctl stop supervisor

配置#

查看配置#

$ cat /etc/supervisor/supervisord.conf; supervisor config file
[unix_http_server]file=/var/run/supervisor.sock   ; (the path to the socket file)chmod=0700                       ; sockef file mode (default 0700)
[supervisord]logfile=/var/log/supervisor/supervisord.log ; (main log file;default $CWD/supervisord.log)pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)childlogdir=/var/log/supervisor            ; ('AUTO' child log dir, default $TEMP)
; the below section must remain in the config file for RPC; (supervisorctl/web interface) to work, additional interfaces may be; added by defining them in separate rpcinterface: sections[rpcinterface:supervisor]supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]serverurl=unix:///var/run/supervisor.sock ; use a unix:// URL  for a unix socket
; The [include] section can just contain the "files" setting.  This; setting can list multiple files (separated by whitespace or; newlines).  It can also contain wildcards.  The filenames are; interpreted as relative to this file.  Included files *cannot*; include files themselves.
[include]files = /etc/supervisor/conf.d/*.conf

配置说明#

$ echo_supervisord_conf; Sample supervisor config file.;; For more information on the config file, please see:; http://supervisord.org/configuration.html;; Notes:;  - Shell expansion ("~" or "$HOME") is not supported.  Environment;    variables can be expanded using this syntax: "%(ENV_HOME)s".;  - Comments must have a leading space: "a=b ;comment" not "a=b;comment".
[unix_http_server]file=/tmp/supervisor.sock   ; (the path to the socket file);chmod=0700                 ; socket file mode (default 0700);chown=nobody:nogroup       ; socket file uid:gid owner;username=user              ; (default is no username (open server));password=123               ; (default is no password (open server))
;[inet_http_server]         ; inet (TCP) server disabled by default;port=127.0.0.1:9001        ; (ip_address:port specifier, *:port for all iface);username=user              ; (default is no username (open server));password=123               ; (default is no password (open server))
[supervisord]logfile=/tmp/supervisord.log ; (main log file;default $CWD/supervisord.log)logfile_maxbytes=50MB        ; (max main logfile bytes b4 rotation;default 50MB)logfile_backups=10           ; (num of main logfile rotation backups;default 10)loglevel=info                ; (log level;default info; others: debug,warn,trace)pidfile=/tmp/supervisord.pid ; (supervisord pidfile;default supervisord.pid)nodaemon=false               ; (start in foreground if true;default false)minfds=1024                  ; (min. avail startup file descriptors;default 1024)minprocs=200                 ; (min. avail process descriptors;default 200);umask=022                   ; (process file creation umask;default 022);user=chrism                 ; (default is current user, required if root);identifier=supervisor       ; (supervisord identifier, default is 'supervisor');directory=/tmp              ; (default is not to cd during start);nocleanup=true              ; (don't clean up tempfiles at start;default false);childlogdir=/tmp            ; ('AUTO' child log dir, default $TEMP);environment=KEY="value"     ; (key value pairs to add to environment);strip_ansi=false            ; (strip ansi escape codes in logs; def. false)
; the below section must remain in the config file for RPC; (supervisorctl/web interface) to work, additional interfaces may be; added by defining them in separate rpcinterface: sections[rpcinterface:supervisor]supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket;username=chris              ; should be same as http_username if set;password=123                ; should be same as http_password if set;prompt=mysupervisor         ; cmd line prompt (default "supervisor");history_file=~/.sc_history  ; use readline history if available
; The below sample program section shows all possible program subsection values,; create one or more 'real' program: sections to be able to control them under; supervisor.
;[program:theprogramname];command=/bin/cat              ; the program (relative uses PATH, can take args);process_name=%(program_name)s ; process_name expr (default %(program_name)s);numprocs=1                    ; number of processes copies to start (def 1);directory=/tmp                ; directory to cwd to before exec (def no cwd);umask=022                     ; umask for process (default None);priority=999                  ; the relative start priority (default 999);autostart=true                ; start at supervisord start (default: true);startsecs=1                   ; # of secs prog must stay up to be running (def. 1);startretries=3                ; max # of serial start failures when starting (default 3);autorestart=unexpected        ; when to restart if exited after running (def: unexpected);exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2);stopsignal=QUIT               ; signal used to kill process (default TERM);stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10);stopasgroup=false             ; send stop signal to the UNIX process group (default false);killasgroup=false             ; SIGKILL the UNIX process group (def false);user=chrism                   ; setuid to this UNIX account to run the program;redirect_stderr=true          ; redirect proc stderr to stdout (default false);stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB);stdout_logfile_backups=10     ; # of stdout logfile backups (default 10);stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0);stdout_events_enabled=false   ; emit events on stdout writes (default false);stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB);stderr_logfile_backups=10     ; # of stderr logfile backups (default 10);stderr_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0);stderr_events_enabled=false   ; emit events on stderr writes (default false);environment=A="1",B="2"       ; process environment additions (def no adds);serverurl=AUTO                ; override serverurl computation (childutils)
; The below sample eventlistener section shows all possible; eventlistener subsection values, create one or more 'real'; eventlistener: sections to be able to handle event notifications; sent by supervisor.
;[eventlistener:theeventlistenername];command=/bin/eventlistener    ; the program (relative uses PATH, can take args);process_name=%(program_name)s ; process_name expr (default %(program_name)s);numprocs=1                    ; number of processes copies to start (def 1);events=EVENT                  ; event notif. types to subscribe to (req'd);buffer_size=10                ; event buffer queue size (default 10);directory=/tmp                ; directory to cwd to before exec (def no cwd);umask=022                     ; umask for process (default None);priority=-1                   ; the relative start priority (default -1);autostart=true                ; start at supervisord start (default: true);startsecs=1                   ; # of secs prog must stay up to be running (def. 1);startretries=3                ; max # of serial start failures when starting (default 3);autorestart=unexpected        ; autorestart if exited after running (def: unexpected);exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2);stopsignal=QUIT               ; signal used to kill process (default TERM);stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10);stopasgroup=false             ; send stop signal to the UNIX process group (default false);killasgroup=false             ; SIGKILL the UNIX process group (def false);user=chrism                   ; setuid to this UNIX account to run the program;redirect_stderr=false         ; redirect_stderr=true is not allowed for eventlisteners;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB);stdout_logfile_backups=10     ; # of stdout logfile backups (default 10);stdout_events_enabled=false   ; emit events on stdout writes (default false);stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB);stderr_logfile_backups=10     ; # of stderr logfile backups (default 10);stderr_events_enabled=false   ; emit events on stderr writes (default false);environment=A="1",B="2"       ; process environment additions;serverurl=AUTO                ; override serverurl computation (childutils)
; The below sample group section shows all possible group values,; create one or more 'real' group: sections to create "heterogeneous"; process groups.
;[group:thegroupname];programs=progname1,progname2  ; each refers to 'x' in [program:x] definitions;priority=999                  ; the relative start priority (default 999)
; The [include] section can just contain the "files" setting.  This; setting can list multiple files (separated by whitespace or; newlines).  It can also contain wildcards.  The filenames are; interpreted as relative to this file.  Included files *cannot*; include files themselves.
;[include];files = relative/directory/*.ini
  • inet_http_server: Web 管理页面

添加配置#

sudo -icat <<-EOF > /etc/supervisor/conf.d/http_server.conf[program:HttpServer]directory=/home/johncommand=python3 -m http.server 9000 --bind 127.0.0.1priority=999autostart=trueautorestart=truestartsecs=10startretries=3stdout_logfile=/var/log/http_server_out.logstdout_logfile_maxbytes=1MBstdout_logfile_backups=10stdout_capture_maxbytes=1MBstderr_logfile=/var/log/http_server_err.logstderr_logfile_maxbytes=1MBstderr_logfile_backups=10stderr_capture_maxbytes=1MBenvironment=nocleanup=falseEOF

更新配置#

supervisorctl update all

查看状态#

# supervisorctl status allHttpServer                       RUNNING   pid 6826, uptime 0:00:15

访问 http://127.0.0.1:9000/ 可打开 HttpServer 页面。

参考#