Supervisor 是用 Python 开发的一个 client/server 服务,是 Linux 系统的进程管理工具,不支持 Windows 系统。
它可以很方便的监听、启动、停止、重启一个或多个进程。用 Supervisor 管理的进程,当一个进程意外被杀死,supervisort 监听到进程死后,会自动将它重新拉起,很方便的做到进程自动恢复的功能,不再需要自己写 shell 脚本来控制。
安装
下面介绍下 Debian 中安装 Supervisor 服务:
检测系统是否安装Python2.4以上版本
# 查看python信息
python
# 退出python
quit()
安装supervisor
apt-get install supervisor
Supervisor 安装完成后会生成三个执行程序:
- supervisord:supervisor的守护进程服务(用于接收进程管理命令)
- supervisorctl:客户端(用于和守护进程通信,发送管理进程的指令)
- echo_supervisord_conf:生成初始配置文件程序。
配置和启动
运行 supervisord 服务的时候,需要指定 supervisor 配置文件。
默认配置文件位置 /etc/supervisor/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=0.0.0.0:9001 ; Web 管理后台运行的 IP 和端口,如果开放到公网,需要注意安全性
;username=user ; 登录管理后台的用户名
;password=123 ; 登录管理后台的密码
[supervisord]
logfile=/tmp/supervisord.log ; 日志文件,默认是 $CWD/supervisord.loglog
file_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 = /etc/supervisor/conf.d/*.conf
注意: 如果配置了 inet_http_server 项内容,可以通过外网访问管理进程。
服务启动和停止
# 启动supervisor时,需要指定配置文件
supervisord -c /etc/supervisor/supervisord.conf
# 停止supervisord,直接kill进程
ps -aux | grep supervisor
kill -9 pid
Program 配置
以上将 supervisord 运行起来了,然后可以添加我们要管理的进程的配置文件。
在以下目录中创建conf文件:/etc/supervisor/conf.d
配置文件格式如下:如创建一个min_doc进程管理文件 min_doc.conf
[program:min_doc]
directory = /home/min_doc ;程序的启动目录
command = /home/min_doc/mindoc_linux_amd64 ;启动命令,可以看出与手动启动命令相同
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 = /data/logs/min_doc_stdout.log
; 可以通过 environment 来添加需要的环境变量,一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere
Supervisorctl 客户端
Supervisorctl 是 supervisord 的一个命令行客户端工具,启动时需要指定与 supervisord 使用同一份配置文件。
启动 supervisorctl
supervisorctl -c /etc/supervisor/supervisord.conf
进入 supervisorctl 的 shell 界面,然后可以执行不同的命令:
> status #查看程序状态
> stop <ide> #关闭程序
> start <ide> #启动程序
> restart <ide> #重启程序
> reread # 读取有更新(增加)的配置文件,不会启动新添加的程序
> update # 重启配置文件修改过的程序
其中的