Python编程：supervisor模块管理进程实例

Supervisor是进程管理程序，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启。

单纯的讲理论比较难懂，下面通过一个监控flask程序的实例来探究

文档：http://supervisord.org/index.html

安装

$ pip install supervisor

新建一个flask项目

新建server.py作为被监控的程序

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello World!'

if __name__ == '__main__':
    app.run()

新建log文件夹用于存放日志

配置

新建文件夹supervisor_demo，用来作为工作目录，并切换到该文件夹下 生成配置文件

$ echo_supervisord_conf > supervisord.conf

推荐线上使用默认路径：

echo_supervisord_conf > /etc/supervisor/supervisord.conf

打开supervisord.conf文件，在最下面找到：

;[include]
;files = relative/directory/*.ini

此处是需要监控程序的配置文件，修改为：

[include]
files = conf/*.ini   ;需手动新建conf文件夹

新建文件conf/server.ini, 并打开编辑(重点关注黑色字就行)

; 设置进程的名称，使用 supervisorctl 来管理进程时需要使用该进程名
[program: myweb] 
command=python server.py   ; 添加刚刚新建的server.py文件名
;numprocs=1                 ; 默认为1
;process_name=%(program_name)s   ; 默认为 %(program_name)s，即 [program:x] 中的 x
;directory=/home/python/tornado_server ; 执行 command 之前，先切换到工作目录
;user=oxygen                 ; 使用 oxygen 用户来启动该进程
;程序崩溃时自动重启，重启次数是有限制的，默认为3次
autorestart=true            
redirect_stderr=true        ; 重定向输出的日志
stdout_logfile =log/server.log   ; 新建log文件夹
loglevel=info   ;日志级别

启动

二选其一即可

$ supervisord   # 不指定配置文件启动
$ supervisord -c supervisord.conf  # 指定配置文件路径启动

查看是否启动

ps aux | grep supervisord

打开log/server.log 看到已经打印出如下记录

 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

访问 http://127.0.0.1:5000/

可以看到

Hello World!

下面试着修改下flask项目

def hello_world():
    return 'New Hello World!' # 修改这里

查看状态

$ supervisorctl status

myweb                            RUNNING   pid 20266, uptime 0:05:58

我们将这个被监控的进程杀掉

kill 20266

稍等片刻，查看log下面的日志，发现flask服务器重启了 再访问下http://127.0.0.1:5000/

New Hello World!

说明这个进程又被重启了，这就是supervisor的作用

开机启动：https://github.com/Supervisor/initscripts

关闭

先关闭supervisor启动脚本，之后再关闭supervisord服务

$ supervisorctl stop all
$ ps aux | grep supervisord
$ kill pid

下面是此项目的目录结构

supervisor_demo         # 项目目录
├── conf              # 需要监控程序的 配置文件夹
│   └── server.ini   # 需要监控程序的 单个配置文件
├── log               # 日志文件夹
│   └── server.log   # 自动生成的日志文件 
├── server.py         # 被监控的程序
└── supervisord.conf  # 配置文件

用浏览器来管理

打开配置文件supervisord.conf， 找到如下配置项并编辑

[inet_http_server]         
port=127.0.0.1:9001        
username=user              
password=123 

更改了supervisor配置文件，需要重启

$ supervisorctl reload

访问http://127.0.0.1:9001/ 进入后台管理

管理命令

# 启动supervisor
supervisord

# 修改完配置文件后重新启动supervisor
supervisorctl reload

# 查看supervisor监管的进程状态
supervisorctl status

# 启动XXX进程
supervisorctl start 进程名

# 停止XXX进程
supervisorctl stop 进程名

# 停止全部进程，注：start、restart、stop都不会载入最新的配置文件。
supervisorctl stop all

# 根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启
supervisorctl update

如果需要监控redis，可以参考： 使用 Supervisor 来管理 Redis 进程

备注： 由于 Supervisor 管理的进程不能设置为 daemon 模式，故如果 Redis 无法正常启动，可以查看一下 Redis 的配置，并将daemonize选项设置为 no

平滑启动

supervisorctl reload并不像nginx -s reload是平滑启动，而是会重启所有的进程

用下面的命令监测被改动的文件，然后平滑启动

supervisorctl  reread
supervisorctl  update

# 整合成一条指令，方便复制
supervisorctl reread && supervisorctl update

报错及解决

1、报错

error: , : 
file: /usr/lib64/python2.7/xmlrpclib.py line: 794

supervisord正在执行reload，还没有加载完成，紧接着执行supervisorctl restart XXX导致的，已经将reload过程修改为supervisorctl reread && supervisorctl update all）

参考 https://www.cnblogs.com/lijiaocn/p/9979256.html

2、报错

error: , [Errno 2] 
No such file or directory: file: /usr/lib64/python2.7/socket.py line: 224

上面报错的意思是没有启动服务端，就是说启动的客户端找不到服务端地址，需要增加参数

# 启动服务端
supervisord -c /etc/supervisor/supervisord.conf

# 启动客户端
supervisorctl -c /etc/supervisor/supervisord.conf

参考： https://stackoverflow.com/questions/18859063/supervisor-socket-error-issue

3、多命令启动

多条命令需要使用bash来启动 例如：

bash -c "source ~/.bash_profile && workon py3 && scrapyd"

参考: https://stackoverflow.com/questions/42443259/supervisorctl-always-reports-error-error-no-such-file

4、报错

unix:///tmp/supervisor.sock no such file

原因：supervisor 默认配置会把 socket 文件和 pid 守护进程生成在/tmp/目录下，/tmp/目录是缓存目录，Linux 会根据不同情况自动删除其下面的文件。

修改配置文件

vim /etc/supervisor/supervisord.conf

[unix_http_server]
;file=/tmp/supervisor.sock   ; (the path to the socket file)
file=/var/run/supervisor.sock   ; 修改为 /var/run 目录，避免被系统删除

[supervisord]
;logfile=/tmp/supervisord.log ; (main log file;default $CWD/supervisord.log)
logfile=/var/log/supervisor.log ; 修改为 /var/log 目录，避免被系统删除
pidfile=/var/run/supervisord.pid ; 修改为 /var/run 目录，避免被系统删除
...

[supervisorctl]
; 必须和'unix_http_server'里面的设定匹配
;serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
serverurl=unix:///var/run/supervisor.sock ; 修改为 /var/run 目录，避免被系统删除

最后更新配置

supervisorctl update

参考 “unix:///tmp/supervisor.sock no such file” 错误处理 (亲测)

5、报错

spider_admin_pro BACKOFF   unknown error making dispatchers for 'spider_admin_pro': EISDIR

很多文章说，有可能是权限问题，首先看下是不是权限问题。

再看一下是不是有同名文件

官网文档给出的示例：

[program:cat]
command=/bin/cat
numprocs=1
directory=/tmp
stdout_logfile=/a/path
stderr_logfile=/a/path

看到path，我以为是一个文件夹路径，新建了一个同名文件夹，然后就报错了，

其实写成下面的参数更直观，需要配置一个文件名

[program:cat]
command=/bin/cat
numprocs=1
directory=/tmp
stdout_logfile=/a/path/out.log
stderr_logfile=/a/path/err.log

参考 supervisor使用笔记

centos配置开机自启

1、新建文件supervisord.service

#supervisord.service

[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

2、 将文件拷贝到/usr/lib/systemd/system/

cp supervisord.service /usr/lib/systemd/system/

3、启动服务

systemctl enable supervisord      # 启动服务

systemctl is-enabled supervisord  # 验证一下是否为开机启动

systemctl start supervisord

systemctl status supervisord

systemctl stop supervisord

参考: Supervisor进程管理&开机自启

完整示例

来自官网: http://supervisord.org/configuration.html#program-x-section-example

[program:cat]
command=/bin/cat
process_name=%(program_name)s
numprocs=1
directory=/tmp
umask=022
priority=999
autostart=true
autorestart=unexpected
startsecs=10
startretries=3
exitcodes=0
stopsignal=TERM
stopwaitsecs=10
stopasgroup=false
killasgroup=false
user=chrism
redirect_stderr=false
stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB
stdout_events_enabled=false
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_capture_maxbytes=1MB
stderr_events_enabled=false
environment=A="1",B="2"
serverurl=AUTO

经验总结

一个好的做法是：

1. 将配置文件放在项目中，可以跟随项目一起管理

2. 通过软连接的方式，将/etc/supervisor/config下的配置文件，指向当前项目的配置文件，避免文件拷贝出多份

# 例如：项目demo-project中的配置文件做软链

# 添加软连接
ln -s /data/wwwroot/demo-project/supervisor-demo.conf /etc/supervisor/config/supervisor-demo.conf

参考：

1. supervisor 从安装到使用
2. 进程管理supervisor的简单说明
3. supervisord安装，启动/关闭，添加开机自启动服务
4. 进程管理工具supervisor的使用注意事项