安装Supervisord
pip install supervisor 或者 apt install supervisor
自身配置
从模板生成
echo_supervisord_conf > 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 = /etc/supervisor/*.conf
守护进程的配置
假设有个java应用包web.jar, 项目代码位于 /home/user/projects/
创建/etc/supervisor/web.conf文件,写入:
[program:web]
directory = /home/user/projects ; 程序的启动目录
command = java -jar web.jar ; 启动命令可以根据实际情况加入相应的参数
;进程名称
process_name = %(program_name)s_%(process_num)02d
;启动设置
numprocs = 1 ;进程数
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/usercenter_stdout.log
;停止信号,默认TERM
;中断:INT (类似于Ctrl+C)(kill -INT pid),退出后会将写文件或日志(推荐)
;终止:TERM (kill -TERM pid)
;挂起:HUP (kill -HUP pid),注意与Ctrl+Z/kill -stop pid不同
;从容停止:QUIT (kill -QUIT pid)
stopsignal=INT
操作
启动supervisord进程
supervisord -c supervisord.conf
关闭supervisord进程(并不会使supervisord守护的进程关闭)
supervisorctl -c supervisord.conf shutdown
重启supervisord进程
supervisorctl -c supervisord.conf reload
进入 supervisorctl 交互终端
supervisorctl
查看进程状态
supervisorctl status
停止指定的守护程序
supervisorctl stop <programname>
启动指定的守护程序
supervisorctl start <programname>
重启指定的守护程序
supervisorctl restart <programname>
读取有更新(增加)的配置文件,不会启动新添加的程序
supervisorctl reread
重启配置文件修改过的程序
supervisorctl update
如果项目使用了python的pyenv模块来设置环境,则supervisord配置文件中需要指定python环境的路径。其中有两种方式指定程序使用的Python环境:
command使用绝对路径。 通过environment配置PYTHONPATH。
Tips
-
Tips 1: Python 程序环境变量
如果项目使用了python的pyenv模块来设置环境,则supervisord配置文件中需要指定python环境的路径 有两种方式指定程序使用的 Python 环境:- command 使用绝对路径。这种方式一目了然。
- environment 配置PYTHONPATH。这种方式可以用来给程序传入环境变量。
environment=PYTHONPATH=$PYTHONPATH:/home/leon/.pyenv/versions/usercenter/bin/. environment -
Tips 2: 后台进程
supervisor 只能管理在前台运行的程序。 -
Tips 3: 防止子进程变成孤儿进程
有时候用 Supervisor 托管的程序还会有子进程(如 Tornado),如果只杀死主进程,子进程就可能变成孤儿进程。通过这两项配置来确保所有子进程都能正确停止:stopasgroup=true killasgroup=true
systemd
- Systemd 默认从目录/etc/systemd/system/读取配置文件。但是,里面存放的大部分文件都是符号链接,指向目录/usr/lib/systemd/system/,真正的配置文件存放在那个目录。
systemctl enable somesvc.service等同于ln -s '/usr/lib/systemd/system/somesvc.service' '/etc/systemd/system/multi-user.target.wants/somesvc.service' - 修改配置文件后,要运行
systemctl daemon-reload就要让 systemd 重新加载配置文件,然后重新启动,否则修改不会生效。 - 查看某个 Unit 的日志
journalctl -u nginx.service - 可以在单元文件的[Service] 部分中指定指令 User= 和 Group= 来指定运行服务的用户和用户组
supervisord对比systemd
节选自参考2,完整对比见参考2
重启策略 supervisord 提供了单独的 startretries 配置项,用来配置 STARTING 阶段的重启次数。 systemd 对此没有特殊处理。
一个程序,从 RUNNING 到 EXITED,有两种可能:正常退出或异常退出… 这两种情况,是通过配置的退出码来区分的。对于 supervisord,这个配置项是 exitcodes。systemd 则通过 SuccessExitStatus > 来控制。 有趣的是,exitcodes 的默认值是 0,2,不知道为何它会认为 2 也是正常的退出码。
如果配置了 autorestart = true,只要程序退出,supervisord 都会把它启动起来。相对的,如果配置的是 autorestart = > unexpected,则只有 异常退出才会重启。这两个选项,在 systemd 里对应 Restart=always 和 Restart=on-failure。systemd 还提供了 > Restart=on-success(只有正常 退出才重启)和 Restart=on-abort(只有收到异常信号才重启)。
对于重启次数,supervisord 没有作限定。因为重启一个程序时,supervisord 会先让它处于 STARTING > 状态。这个状态的持续时间,是由配置项 中的 startsecs 决定的,默认 1 秒。如果是不可恢复的错误,程序就不可能成功进入到 RUNNING > 状态。当然也许存在这样的情况,程序运行 1 秒 后,就会崩溃。那么它就会陷于不停重启的无间地狱。
systemd 对此一如既往,提供了 N 多选项以供采用。你可以用 RestartSec 控制每次重启的间隔,可以用 StartLimitInterval 和 > StartLimitBurst 设定 给定周期内能够重启的次数。比如指定 StartLimitInterval=1s,StartLimitBurst=3,就可以实现跟 supervisord > 一致的默认重启策略。
参考