Supervisor的配置

2023-03-08

安装

推荐使用pip进行安装。项目环境若为python3,可直接安装在python3下

pip3 install supervisor

生成配置并修改配置文件引入多个配置

生成

通过以下命令生成配置,一般放置在/etc/路径下

echo_supervisord_conf > supervisord.conf

引入多个配置

在原始配置文件末尾添加多个配置文件的目录

[include]
; add your conf in conf.d dir
files = /etc/supervisor/conf.d/*.conf

启动supervisor与supervisor常用命令

启动时指明配置文件

cd /etc/  # 进入配置文件所在目录或是直接在-c中指明文件位置
supervisord -c supervisord.conf

常用命令

# 进入控制台
supervisorctl
# 启动进程
start process1
# 停止进程
stop process1
# 重启进程(停起过快,容易端口冲突)
restart process1
# 启动组内所有进程
start group1:*

自定义管理目录存放配置文件与进程文件

  • 在目标位置创建文件。例如:在根目录创建文件夹/data/etc/supervisor/用于管理super相关配置文件,或者在/etc/supervisor/
  • 生成配置文件后修改相关文件的位置,以下配置以/data/etc/supervisor/为例,修改了的filepidfileserverurlfiles。可不修改pidfileserverurl以方便进入控制台。
; Warning:
;  Paths throughout this example file use /tmp because it is available on most
;  systems.  You will likely need to change these to locations more appropriate
;  for your system.  Some systems periodically delete older files in /tmp.
;  Notably, if the socket file defined in the [unix_http_server] section below
;  is deleted, supervisorctl will be unable to connect to supervisord.

[unix_http_server]
file=/data/etc/supervisor/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)

; Security Warning:
;  The inet HTTP server is not enabled by default.  The inet HTTP server is

;[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=/data/logs/supervisor/supervisord.log ; main log file; default $CWD/supervisord.log
logfile_maxbytes=50MB        ; max main logfile bytes b4 rotation; default 50MB
logfile_backups=10           ; # of main logfile backups; 0 means none, default 10
loglevel=info                ; log level; default info; others: debug,warn,trace
pidfile=/data/etc/supervisor/supervisord.pid ; supervisord pidfile; default supervisord.pid
nodaemon=false               ; start in foreground if true; default false
silent=false                 ; no logs to stdout 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=supervisord            ; setuid to this UNIX account at startup; recommended 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 rpcinterface:supervisor 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:x] sections.

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

; The supervisorctl section configures how supervisorctl will connect to
; supervisord.  configure it match the settings in either the unix_http_server
; or inet_http_server section.

[supervisorctl]
serverurl=unix:///data/etc/supervisor/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 in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

[include]
; add your conf in conf.d dir
files = /data/etc/supervisor/conf.d/*.conf
  • 每次进入控制台时需指明配置文件supervisorctl -c /data/etc/supervisor/supervisord.conf。可通过.zshrc中设置别名方便启动
alias superctl="/usr/local/bin/supervisorctl -c /data/etc/supervisor/supervisord.conf"

常见问题

  • 9001连接拒绝
    在自定义存放目录时,如果启动控制台不指明配置文件,会出现9001连接拒绝。是由于修改了配置文件的pid,sock文件位置但启动ctl时未加载配置文件,而出现在默认目录下查找时查找不到进程。

  • Unlinking stale socket /path/to/supervisor.sock
    由于sock残留导致的启动异常,使用cd /supervisor/sock/path/ && unlink supervisord.sock