Supervisor (http://supervisord.org) 是一个用 Python 写的进程管理工具,可以很方便的用来启动、重启、关闭进程(不仅仅是 Python 进程)。除了对单个进程的控制,还可以同时启动、关闭多个进程,比如很不幸的服务器出问题导致所有应用程序都被杀死,此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。
安装和配置
通过pip或apt-get可以直接安装。
supervisor 是一个 C/S 模型的程序
- server: supervisord
- client: supervisorctl
supervisord
服务的配置包括两部分:supervisord 和 应用程序。
安装后运行echo_supervisord_conf
命令,可以输出默认的配置项,我们可以将其重定向至一个配置文件中:
echo_supervisord_conf > /etc/supervisord.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
我们把上面这部分配置保存到/etc/supervisord.conf
(或其他任意有权限访问的文件),然后启动 supervisord(通过 -c 选项指定配置文件路径,如果不指定会按照这个顺序查找配置文件:$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf
)
supervisord -c /etc/supervisord.conf
program配置
要管理的进程的配置文件,可以都写到 supervisord.conf 文件里,比如:
[supervisord]
nodaemon=true
; ......
[program:app1]
command = uwsgi --http :9008 --wsgi-file testApp/wsgi.py
directory= /code/app1
; ......
[program:app2]
command = uwsgi --http :9008 --wsgi-file testApp/wsgi.py
directory= /code/app2
; ......
如果应用程序很多,最好通过 include 的方式把不同的程序(组)写到不同的配置文件里:
新建一个目录
/etc/supervisor/
,用于存放这些配置文件把
/etc/supervisord.conf
里 include 部分的的配置修改一下:[include] files = /etc/supervisor/*.conf
配置示例:
[program:appname]
; appname 是应用程序的唯一标识,命名不能重复
directory= /code/testApp
; 程序的启动目录
command = uwsgi --module testApp.wsgi --processes=10 --threads=2 --buffer-size=65535 --http :11111
; 启动命令
user = root
; 用哪个用户启动
stdout_logfile = /code/log/app_supervisor.log
; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)
redirect_stderr = true
; Save stderr in the same log
stdout_logfile_maxbytes = 20MB
; stdout 日志文件大小,默认 50MB
stdout_logfile_backups = 20
; stdout 日志文件备份数
environment=LANG=en_US.UTF-8,LC_ALL=en_US.UTF-8
; Set UTF-8 as default encoding
; 其他启动相关:
autostart = true ; 在 supervisord 启动的时候也自动启动
startsecs = 5 ; 启动 5 秒后没有异常退出,就当作已经正常启动了
autorestart = true ; 程序异常退出后自动重启
startretries = 3 ; 启动失败自动重试次数,默认是 3
注意事项:
Supervisor 只能管理在前台运行的程序,所以如果应用程序有后台运行的选项(比如,-d),需要关闭。
有时候用 Supervisor 托管的程序还会有子进程(如 Tornado),如果只杀死主进程,子进程就可能变成孤儿进程。通过这两项配置来确保所有子进程都能正确停止:
stopasgroup=true killasgroup=true
Supervisorctl 工具
Supervisorctl 是 supervisord 的一个命令行客户端工具,启动时需要指定与 supervisord 使用同一份配置文件,否则与 supervisord 一样按照顺序查找配置文件
supervisorctl -c /etc/supervisord.conf
以上命令,将进入交互式shell界面,可以执行一些命令:
> status # 查看程序状态
> stop appname # 关闭程序
> start appname # 启动程序
> restart appname # 重启程序
> reread # 读取有更新(增加)的配置文件,不会启动新添加的程序
> update # 重启配置文件修改过的程序