Supervisor是用Python开发的一个client/server服务,是Linux/Unix系统下的一个进程管理工具,不支持Windows系统。它可以很方便的监听、启动、停止、重启一个或多个进程。用Supervisor管理的进程,当一个进程意外被杀死,supervisort监听到进程死后,会自动将它重新拉起,很方便的做到进程自动恢复的功能,不再需要自己写shell脚本来控制。
1、supervisor组件
- supervisord(server 部分):主要负责管理子进程,响应客户端命令以及日志的输出等;
- supervisorctl(client 部分):命令行客户端,用户可以通过它与不同的 supervisord 进程联系,获取子进程的状态等。
- Web Server主要可以在界面上管理进程,Web Server其实是通过XML_RPC来实现的,可以向supervisor请求数据,也可以控制supervisor及子进程。配置在[inet_http_server]块里面;
- XML_RPC接口
提供了与webserver中相同的用于查询和控制进程的http接口;
2、安装
python版本要求2.4以上, 且不能是python3, supervisor不能运行在任何python3版本上。(但是可以用py2运行 supervisor, supervisor启动py3的程序,也就是linux自带py2所以不用纠结py版本问题)
可以直接用pip安装:
sudo pip install supervisor
Centos安装:
yum install supervisor
Ubuntu安装(下面两行任意一种即可):
wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
easy_install supervisor
supervisor安装完成后会生成三个执行程序:supervisortd、supervisorctl、echo_supervisord_conf,分别是supervisor的守护进程服务(用于接收进程管理命令)、客户端(用于和守护进程通信,发送管理进程的指令)、生成初始配置文件程序。
3、配置
运行supervisord服务的时候,需要指定supervisor配置文件,如果没有显示指定,默认在以下目录查找:
$CWD/supervisord.conf
$CWD/etc/supervisord.conf
/etc/supervisord.conf
/etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
../etc/supervisord.conf (Relative to the executable)
../supervisord.conf (Relative to the executable)
$CWD表示运行supervisord程序的目录。
可以通过运行echo_supervisord_conf程序生成supervisor的初始化配置文件,如下所示:
mkdir /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf
3.1、 启动
然后可以通过 supervisord 命令启动 supervisord.
$ supervisord
查看supervisor进程信息
$ ps aux | grep super
root 1405 0.0 0.2 60956 7032 ? Ss 10:34 0:01 /usr/bin/python /usr/bin/supervisord -n -c /etc/supervisor/supervisord.conf
此时supervisord已经启动,可以通过supervisorctl进入shell管理界面:
$ supervisorctl
supervisor>status
supervisor>
由于目前没有添加任何需要管理的进程,所以 status 没有输出人和结果。
3.2、 program配置
上面我们已经把 supervisrod 运行起来了,现在可以添加我们要管理的进程的配置文件。可以把所有配置项都写到 supervisord.conf 文件里,但并不推荐这样做,而是通过 include 的方式把不同的程序(组)写到不同的配置文件里。
为了举例,我们新建一个目录 /etc/supervisor/ 用于存放这些配置文件,相应的,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:
[include]
files = /etc/supervisor/*.conf
上面这个要注意一下是.conf还是.ini,以及这个路径。决定着你一会创建的配置管理文件在哪和名字以什么结尾!
假设有个用 Python 和 Flask 框架编写的用户中心系统,取名 usercenter,用 gunicorn做 web 服务器。项目代码位于 /home/leon/projects/usercenter,gunicorn 配置文件为 gunicorn.py,WSGI callable 是 wsgi.py 里的 app 属性。所以直接在命令行启动的方式可能是这样的:
cd /home/tudou/projects/usercenter
gunicorn -c gunicorn.py wsgi:app
现在编写一份配置文件来管理这个进程(需要注意:用 supervisord 管理时,gunicorn 的 daemon 选项需要设置为 False),文件地址和后缀名跟刚才的files 有关比如/etc/supervisor/usercenter.conf:
[program:usercenter]
directory = /home/leon/projects/usercenter ; 程序的启动目录
command = gunicorn -c gunicorn.py wsgi:app ; 启动命令,可以看出与手动在命令行启动的命令是一样的
autostart = true ; 在 supervisord 启动的时候也自动启动
startsecs = 5 ; 启动 5 秒后没有异常退出,就当作已经正常启动了
autorestart = true ; 程序异常退出后自动重启
startretries = 3 ; 启动失败自动重试次数,默认是 3
user = leon ; 用哪个用户启动
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
; 可以通过 environment 来添加需要的环境变量,一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere
一份配置文件至少需要一个 [program:x] 部分的配置,来告诉 supervisord 需要管理那个进程。[program:x] 语法中的 x 表示 program name,会在客户端(supervisorctl 或 web 界面)显示,在 supervisorctl 中通过这个值来对程序进行 start、restart、stop 等操作。
3.3、 管理命令
可以使用以下命令更新配置、更新进程、查看状态
# 读取有更新(增加)的配置文件,不会启动新添加的程序
$ supervisorctl reread
# 重启配置文件修改过的程序
$ supervisorctl update
# 查看程序状态
$ supervisorctl status
# 启动程序 App_name
$ supervisorctl start App_name
# 关闭程序 App_name
$ supervisorctl stop App_name
# 重启程序 App_name
$ supervisorctl restart App_name
以上命令也可以在supervisorctl Shell中执行:
$ supervisorctl
supervisor> reread
supervisor> update
supervisor> status
supervisor> start App_name
supervisor> stop App_name
supervisor> restart App_name
3.4、web管理界面
除了 supervisorctl 之外,还可以配置 supervisrod 启动 web 管理界面,这个 web 后台使用 Basic Auth 的方式进行身份认证。
除了单个进程的控制,还可以配置 group,进行分组管理。
经常查看日志文件,包括 supervisord 的日志和各个 pragram 的日志文件,程序 crash 或抛出异常的信息一半会输出到 stderr,可以查看相应的日志文件来查找问题。
3.4.1、配置
编辑配置文件/etc/supervisor/supervisord.conf,添加inet_http_server节点,如下(注:这里每一行前面都带个;号,他是注释要去掉才行):
[inet_http_server]
port = 0.0.0.0:9001
username = username
password = password
其中,port是服务监听端口信息,username是管理员用户名,password是管理员密码。
权限报错
本人直接root用户运行了,如果没有权限则像下面这样修改
1、日志权限错误
IOError: [Errno 13] Permission denied: '/var/log/supervisor/supervisord.log'
原因,/var/log/supervisor/supervisord.log没有写权限,赋予权限即可:
sudo chmod -R 777 /var/log/supervisor/supervisord.log
2、开启HTTP Server错误
Error: Cannot open an HTTP server: socket.error reported errno.EACCES (13)
配置文件中 /var/run 文件夹,没有授予启动 supervisord 的相应用户的写权限。/var/run 文件夹实际上是链接到 /run,因此我们修改 /run 的权限。
sudo chmod 777 /run
一般情况下,我们可以用 root 用户启动 supervisord 进程,然后在其所管理的进程中,再具体指定需要以那个用户启动这些进程。
3、日志权限问题
'INFO spawnerr: unknown error making dispatchers for 'app_name': EACCES'
修改日志文件的权限
sudo chmod 777 /usr/log/supervisor/supervisor.log
sudo chmod 777 /usr/log/supervisor/youAppName.log
开机自启
配置Supervisor开机启动:
新建一个“supervisord.service”文件(如果/usr/lib/systemd/system/有该文件,就不用管了)
# dservice for systemd (CentOS 7.0+)
# by ET-CS (https://github.com/ET-CS)
[Unit]
Description=Supervisor daemon
[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisorctl shutdown
ExecReload=/usr/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
[Install]
WantedBy=multi-user.target
如果没有该文件则把这个新建的文件拷贝至:“/usr/lib/systemd/system/supervisord.service”
然后命令行输入
systemctl enable supervisord
验证一下是否为开机启动:
systemctl is-enabled supervisord
>>>enabled(返回这个就对了)