Docs - Supervisor

Supervisor 是基于 Python 的进程管理工具,是一种 client/server 系统,只能运行在类Unix的系统上.

Supervisor 适用场景,执行一些需要以守护进程方式执行的程序,比如一个后台任务.

Supervisor 有两个主要的组成部分:

[1] - supervisord

运行 Supervisor 时会启动一个进程 supervisord,它负责启动所管理的进程,并将所管理的进程作为自己的子进程来启动,而且可以在所管理的进程出现崩溃时自动重启。

[2] - supervisorctl

命令行管理工具,可以用来执行 stop、start、restart 等命令,来对这些子进程进行管理

1. 安装配置

pip install supervisor

安装后,运行:

echo_supervieor_config > /etc/supervisord.conf

#若遇到权限问题,
sudo su - root -c "echo_supervisord_conf > /etc/supervisord.conf"

生成配置文件supervisord.conf. (该配置文件中有具体的注释信息)

1.1. conf配置文件

[unix_http_server]
file=/tmp/supervisor.sock ; UNIX socket 文件,supervisorctl 会使用
;chmod=0700 ; socket 文件的 mode,默认是 0700
;chown=nobody:nogroup ; socket 文件的 owner,格式: uid:gid

;[inet_http_server] ; HTTP 服务器,提供 web 管理界面
;port=127.0.0.1:9001 ; Web 管理后台运行的 IP 和端口,如果开放到公网,需要注意安全性
;username=user ; 登录管理后台的用户名
;password=123 ; 登录管理后台的密码

[supervisord]
logfile=/tmp/supervisord.log ; 日志文件,默认是 $CWD/supervisord.log
logfile_maxbytes=50MB ; 日志文件大小,超出会 rotate,默认 50MB
logfile_backups=10 ; 日志文件保留备份数量默认 10
loglevel=info ; 日志级别,默认 info,其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ; pid 文件
nodaemon=false ; 是否在前台启动,默认是 false,即以 daemon 的方式启动
minfds=1024 ; 可以打开的文件描述符的最小值,默认 1024
minprocs=200 ; 可以打开的进程数的最小值,默认 200

; 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 ; 通过 UNIX socket 连接 supervisord,路径与 unix_http_server 部分的 file 一致
;serverurl=http://127.0.0.1:9001 ; 通过 HTTP 的方式连接 supervisord

; 包含其他的配置文件
[include]
files = relative/directory/*.ini ; 可以是 *.conf 或 *.ini

为了便于进程的配置文件管理,推荐将各个进程配置放到单独的conf文件中,以相互隔离,然后通过[include]配置项引用,如:

#mkdir /etc/supervisord.d/
files = /etc/supervisord.d/*.conf

1.2. /tmp 存放问题

/etc/supervisord.conf 中,将 supervisord.pidsupervisor.sock 存放在 /tmp 目录下,但该目录主要是用于存放临时文件,会被 Linux 系统删除. 而一旦这些文件丢失,则 supervisorctl 无法再执行 restart 和 stop 命令,会报 unix:///tmp/supervisor.sock 不存在的错误.

对此,修改对应的存放路径:

[unix_http_server]
;file=/tmp/supervisor.sock   ; (the path to the socket file)
;修改为 /var/run 目录,避免被系统删除
file=/var/run/supervisor.sock   ; (the path to the socket file)

[supervisord]
;logfile=/tmp/supervisord.log ; (main log file;default $CWD/supervisord.log)
;修改为 /var/log 目录,避免被系统删除
logfile=/var/log/supervisor/supervisord.log ; (main log file;default $CWD/supervisord.log)

;pidfile=/tmp/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
;修改为 /var/run 目录,避免被系统删除
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)

;设置启动supervisord的用户,一般情况下不要轻易用root用户来启动
;user=chrism                 ; (default is current user, required if root)


[supervisorctl]
; 必须和'unix_http_server'里面的设定匹配
;serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
;修改为 /var/run 目录,避免被系统删除
serverurl=unix:///var/run/supervisor.sock ; use a unix:// URL  for a unix socket

其中,默认情况下,进程的日志文件达到50MB时,将进行分割,最多保留10个文件;这些配置也可以对每个进程单独配置。

1.3. 监控进程配置

如,在/etc/supervisord.d/目录下新增一个.conf文件,模板内容如:

[program:project_name]   // project_name 必须是唯一的
directory = /path/to/workspace/  // 启动脚本时的工作目录,如果你使用脚本的绝对目录,那么directory可以不设置
command = 脚本的启动命令. // 执行脚本的命令
autostart = true  // 配置为True, supervisor 启动时,任务跟随启动
autorestart = true  // 配置为True, 进程不存在时会自动重启, 默认重启3次,想修改重启次数,可以配置startretries, 设置最多重启的次数
user = loanward. // 设置启动任务时所用的用户, 建议使用root
stdout_logfile = /var/log/pro_stdout.log. // 配置输出日志

实例如,soc_server.conf

[program:soc_server]
directory = /var/www/html/ichat ; 程序的启动目录
command =  php soc_server.php start ; 启动命令,可以看出与手动在命令行启动的命令是一样的
autostart = true ; 在 supervisord 启动的时候也自动启动
startsecs = 5 ; 启动 5 秒后没有异常退出,就当作已经正常启动了
autorestart = true ; 程序异常退出后自动重启
startretries = 3 ; 启动失败自动重试次数,默认是 3
user = root ; 用哪个用户启动
redirect_stderr = true ; 把 stderr 重定向到 stdout,默认 false
stdout_logfile_maxbytes = 20MB ; stdout 日志文件大小,默认 50MB
stdout_logfile_backups = 20 ; stdout 日志文件备份数
; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)
stdout_logfile = /var/logs/soc_server_stdout.log

; 可以通过 environment 来添加需要的环境变量,一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

1.4. 进程配置样例

简单示例如:

; 设置进程的名称,使用 supervisorctl 来管理进程时需要使用该进程名
[program:your_program_name] 
command=python server.py --port=9000
;numprocs=1                 ; 默认为1
;process_name=%(program_name)s   ; 默认为 %(program_name)s,即 [program:x] 中的 x
directory=/home/python/tornado_server ; 执行 command 之前,先切换到工作目录
user=oxygen                 ; 使用 oxygen 用户来启动该进程
autorestart=true
startretries = 3 ; 程序崩溃时自动重启,重启次数是有限制的,默认为3次
redirect_stderr=true        ; 重定向输出的日志
stdout_logfile = /var/log/supervisord/tornado_server.log
loglevel=info

其中,loglevel 设定日志级别,print 打印的内容不会记录在日志文件中,需要搭配 logging 库来输出指定级别的日志.

2. Supervisor 服务启动与管理

2.1. supervisord 进程启动

supervisord -c /etc/supervisord.conf

如果启动出错,

Starting supervisor: Error: Another program is already listening on a port that one of our HTTP servers is configured to use.  Shut this program down first before starting supervisord.

解决方案:

#获取所有supervisord正在运行的pid
ps -ef | grep supervisord

#kill 正在运行的pid

#重新启动
supervisord -c /etc/supervisord.conf

2.2. supervisorctl 进程管理

supervisorctl status //查看状态

supervisorctl start web_server //开启一个进程
supervisorctl stop web_server //停止一个进程
supervisorctl restart web_server //重启一个进程

supervisorctl stop all
supervisorctl reload //重新加载配置,停止原有进程并按新的配置启动、管理所有进程
supervisorctl update //更新启动列表,启动新配置或有改动的进程,配置没有改动的进程不会受影响而重启

2.3. 浏览器管理进程

/etc/supervisord.conf 配置文件中,注释掉如下内容,即可通过浏览器来管理进程:

;[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))

[supervisorctl]
;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

在浏览器中输入http://127.0.0.1:9001,可进入web管理界面

3. 配置Supervisor开机自启动

Ubuntu 系统,将 Supervisord 安装为服务:

#下载脚本
sudo su - root -c "sudo curl https://gist.githubusercontent.com/howthebodyworks/176149/raw/d60b505a585dda836fadecca8f6b03884153196b/supervisord.sh > /etc/init.d/supervisord"

# 设置该脚本为可以执行
sudo chmod +x /etc/init.d/supervisord

# 设置为开机自动运行
sudo update-rc.d supervisord defaults

# 测试确认supervisord
service supervisord stop
service supervisord start

另一种方法,设置 /etc/rc.local 添加如下命令:

#sudo find / -name supervisord
/usr/local/bin/supervisord -c /etc/supervisord.conf

参考

[1] - Python进程管理Supervisor浅析

[2] - supervisor安装、使用详解

[3] - python多进程管理工具supervisor

[4] - Supervisor on Debian Wheezy: another program is already listening on a port that one of our HTTP ser

[5] - 使用daphne部署django channles websocket 项目

Last modification:June 16th, 2022 at 11:20 am