Supervisor-守护进程工具
参考资料
http://liyangliang.me/posts/2015/06/using-supervisor/
https://www.jianshu.com/p/0b9054b33db3
一、supervisor简介
- Supervisor
是一个用 Python 写的进程管理工具,可以很方便的用来启动、重启、关闭进程(不仅仅是 Python 进程)。除了对单个进程的控制,还可以同时启动、关闭多个进程,比如很不幸的服务器出问题导致所有应用程序都被杀死,此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。 - Supervisor能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,可以选择是否自己启动和报警。supervisor还提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的user,这个user就可以管理它对应的进程。
二、安装
Supervisor 可以运行在 Linux、Mac OS X 上。如前所述,supervisor 是
1、Python 编写的,所以安装起来也很方便,可以直接用 pip :
1 | sudo pip install supervisor |
2、配置好yum源后,可以直接安装
1 | yum install supervisor |
3、如果是 Ubuntu 系统,还可以使用 apt-get 安装。
1 | apt-get install supervisor |
三、supervisor使用
supervisor配置文件:/etc/supervisord.conf
- 注:supervisor的配置文件默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足。
子进程配置文件路径:/etc/supervisord.d/
- 注:默认子进程配置文件为ini格式,可在supervisor主配置文件中修改。
四、supervisord 配置
Supervisor 相当强大,提供了很丰富的功能,不过我们可能只需要用到其中一小部分。安装完成之后,可以编写配置文件,来满足自己的需求。为了方便,我们把配置分成两部分:supervisord(supervisor 是一个 C/S 模型的程序,这是 server 端,对应的有 client 端:supervisorctl)和应用程序(即我们要管理的程序)。
supervisor.conf 配置文件说明
首先来看 supervisord 的配置文件。安装完 supervisor 之后,可以运行echo_supervisord_conf 命令输出默认的配置项,也可以重定向到一个配置文件里:
echo_supervisord_conf > /etc/supervisord.conf
去除里面大部分注释和“不相关”的部分,我们可以先看这些配置:
1 | [unix_http_server] |
我们把上面这部分配置保存到 /etc/supervisord.conf(或其他任意有权限访问的文件),然后启动 supervisord(通过 -c 选项指定配置文件路径,如果不指定会按照这个顺序查找配置文件:$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf):
supervisord -c /etc/supervisord.conf
查看 supervisord 是否在运行:
1 | ps aux | grep supervisord |
program 配置
上面我们已经把 supervisrod 运行起来了,现在可以添加我们要管理的进程的配置文件。这些配置可以都写到 supervisord.conf 文件里,如果应用程序很多,最好通过 include 的方式把不同的程序(组)写到不同的配置文件里。
为了举例,我们新建一个目录 /etc/supervisor/ 用于存放这些配置文件,相应的,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:
[include]
files = /etc/supervisor/*.conf
假设有个用 Flask 开发的用户系统 usercenter, 生产环境使用 gunicorn 运行。项目代码位于 /home/leon/projects/usercenter,WSGI 对象位于 wsgi.py。在命令行启动的方式是这样的:
cd /home/leon/projects/usercenter
gunicorn -w 8 -b 0.0.0.0:17510 wsgi:app
对应的配置文件可能是:
1 | [program:usercenter] |
其中 [program:usercenter] 中的 usercenter 是应用程序的唯一标识,不能重复。对该程序的所有操作(start, restart 等)都通过名字来实现。
五、注意事项
1、Python 环境
有两种方式指定程序使用的 Python 环境:
command 使用绝对路径。假设使用 pyenv 来管理 Python 环境,上面例子中的 gunicorn 路径可以替换为 /home/leon/.pyenv/versions/usercenter/bin/gunicorn. 这种方式一目了然,推荐。
通过 environment 配置 PYTHONPATH. environment=PYTHONPATH=$PYTHONPATH:/home/leon/.pyenv/versions/usercenter/bin/. environment 这个配置项非常有用,可以用来给程序传入环境变量。
2、后台进程
Supervisor 只能管理在前台运行的程序,所以如果应用程序有后台运行的选项,需要关闭。
3、子进程
有时候用 Supervisor 托管的程序还会有子进程(如 Tornado),如果只杀死主进程,子进程就可能变成孤儿进程。通过这两项配置来确保所有子进程都能正确停止:
stopasgroup=true
killasgroup=true
4、先启动supervisord
使用supervisor进程管理命令之前先启动supervisord,否则程序报错。
使用命令supervisord -c /etc/supervisord.conf启动。
若是centos7:
1 | systemctl start supervisord.service //启动supervisor并加载默认配置文件 |
六、使用 supervisorctl
Supervisorctl 是 supervisord 的一个命令行客户端工具,启动时需要指定与 supervisord 使用同一份配置文件,否则与 supervisord 一样按照顺序查找配置文件。
supervisorctl -c /etc/supervisord.conf
上面这个命令会进入 supervisorctl 的 shell 界面,然后可以执行不同的命令了:
status # 查看程序状态
stop usercenter # 关闭 usercenter 程序
start usercenter # 启动 usercenter 程序
restart usercenter # 重启 usercenter 程序
reread # 读取有更新(增加)的配置文件,不会启动新添加的程序
update # 重启配置文件修改过的程序
上面这些命令都有相应的输出,除了进入 supervisorctl 的 shell 界面,也可以直接在 bash 终端运行:
1 | $ supervisorctl status |
七、常见问题
1、unix:///var/run/supervisor/supervisor.sock no such file
- 问题描述:安装好supervisor没有开启服务直接使用supervisorctl报的错
- 解决办法:supervisord -c /etc/supervisord.conf
2、command中指定的进程已经起来,但supervisor还不断重启
- 问题描述:command中启动方式为后台启动,导致识别不到pid,然后不断重启,这里使用的是elasticsearch,command指定的是$path/bin/elasticsearch -d
- 解决办法:supervisor无法检测后台启动进程的pid,而supervisor本身就是后台启动守护进程,因此不用担心这个
3、启动了多个supervisord服务,导致无法正常关闭服务
- 问题描述:在运行supervisord -c /etc/supervisord.conf之前,直接运行过supervisord -c /etc/supervisord.d/xx.conf导致有些进程被多个superviord管理,无法正常关闭进程。
- 解决办法:使用ps -fe | grep supervisord查看所有启动过的supervisord服务,kill相关的进程。
4、<踩坑>supervisor中的minfds及minprocs参数用途
- 问题描述:程序报错
1
ConnectionError: Error 24 connecting to 127.0.0.1:6379. Too many open files.
- 第一反应系统参数配置不够
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19系统ulimit配置(红色部分为调整配置):
$ ulimit -a
core file size (blocks, -c) 0
data seg size (kbytes, -d) unlimited
scheduling priority (-e) 0
file size (blocks, -f) unlimited
pending signals (-i) 15060
max locked memory (kbytes, -l) 64
max memory size (kbytes, -m) unlimited
open files (-n) 65535 ###够了
pipe size (512 bytes, -p) 8
POSIX message queues (bytes, -q) 819200
real-time priority (-r) 0
stack size (kbytes, -s) 8192
cpu time (seconds, -t) unlimited
max user processes (-u) 65535 ###够了
virtual memory (kbytes, -v) unlimited
file locks (-x) unlimited - supervisor配置参数:
1
2minfds=1024 ; 可以打开的文件描述符的最小值,默认 1024
minprocs=200 ; 可以打开的进程数的最小值,默认 200 - 解决方案:
1
2minfds=65535 ; 可以打开的文件描述符的最小值,默认 1024
minprocs=65535 ; 可以打开的进程数的最小值,默认 200 - 重启
1
$ systemctl restart supervisord
八、其它
除了 supervisorctl 之外,还可以配置 supervisrod 启动 web 管理界面,这个 web 后台使用 Basic Auth 的方式进行身份认证。
除了单个进程的控制,还可以配置 group,进行分组管理。
经常查看日志文件,包括 supervisord 的日志和各个 pragram 的日志文件,程序 crash 或抛出异常的信息一半会输出到 stderr,可以查看相应的日志文件来查找问题。
Supervisor 有很丰富的功能,还有其他很多项配置,可以在官方文档获取更多信息:http://supervisord.org/index.html