00-supervisor命令的安装使用

supervisor命令的安装使用

参考资料

• 官方文档：
  • https://pypi.org/project/supervisor/4.2.0/#modal-close
  • http://supervisord.org/index.html
• https://www.cnblogs.com/zhangjpn/p/7056324.html
• https://cloud.tencent.com/developer/article/1725966

Supervisor简介

• Supervisord 是用 Python 实现的一款的进程管理工具，supervisord 要求管理的程序是非 daemon 程序，supervisord 会帮你把它转成 daemon 程序，因此如果用 supervisord 来管理进程，进程需要以非daemon的方式启动。

例如：管理nginx 的话，必须在 nginx 的配置文件里添加一行设置 daemon off 让 nginx 以非 daemon 方式启动。

• supervisor包括两个命令：supervisord和supervisorctl，分别是后台的守护进程以及命令行管理命令。supervisord只会启动一个supervisord守护进程，剩下的管理工作都交给supervisorctl命令来完成。

两个命令共用一个配置文件，默认是：/etc/supervisor/supervisor.conf，而supervisor.conf 通过[include] 这个section来引入其它配置文件，一般放在/etc/supervisor/conf.d目录，所以我们可以将需要的文件放到这个目录之下，并将后缀改为.conf。

• 除了默认的配置之外，一个常用的配置方式是在使用启动的时候指定特定的配置文件，配置方式为：  sudo  supervisord  -c  /path/to/supervisor.conf；注意：这时候的配置文件要使用绝对路径，并且配置文件要完整，否则可能会报错。

• Supervisor4.2.0依赖于python3.4及以上版本或python2.7，详见官方文档：https://pypi.org/project/supervisor/4.2.0/#modal-close

Supervisor有四个组件

• supervisord 运行Supervisor的后台服务，它用来启动和管理那些你需要Supervisor管理的子进程，响应客户端发来的请求，重启意外退出的子进程，将子进程的stdout和stderr写入日志，响应事件等。它是Supervisor最核心的部分。
• supervisorctl 相当于supervisord的客户端，它是一个命令行工具，用户可以通过它向supervisord服务发指令，比如查看子进程状态，启动或关闭子进程。它可以连接不同的supervisord服务，包括远程机上的服务。
• Web服务器 这是supervisord的Web客户端，用户可以在Web页面上完成类似于supervisorctl的功能。
• XML-RPC接口 这是留给第三方集成的接口，你的服务可以在远程调用这些XML-RPC接口来控制supervisord管理的子进程。上面的Web服务器其实也是通过这个XML-RPC接口实现的。

Supervisor安装

yum install 的方式

yum install -y supervisor

easy_install的方式

easy_install是setuptools包里带的一个命令，使用easy_install实际上是在调用setuptools来完成安装模块的工作,所以安装setuptools即可。

yum install -y python-setuptools && easy_install supervisor
echo_supervisord_conf >/etc/supervisord.conf 

编译方式安装 

cd /home/oldboy/tools/ && wget https://files.pythonhosted.org/packages/4f/39/a84d5350e4db6737c74bf5162b1eba4c7e3c4c9e9a46c7b198797f8f54aa/supervisor-4.2.0.tar.gz
tar -zxf supervisor-4.2.0.tar.gz
cd /home/oldboy/tools/supervisor-4.2.0/ && python3 setup.py install

Supervisord.conf的配置

• 如果安装后，没有/etc/supervisord.conf这个配置文件，则用命令生成：

echo_supervisord_conf > /etc/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，如果设成0，表示不限制大小
logfile_backups=10   ;日志文件保留备份数量默认10，设为0表示不备份
loglevel=info    ;日志级别，默认info，其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false    ;是否在前台启动，默认是false，即以 daemon 的方式启动
minfds=1024     ;可以打开的文件描述符的最小值，默认 1024
minprocs=200     ;可以打开的进程数的最小值，默认 200

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
; [program:xx]是被管理的进程配置参数，xx是进程的名称

[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run ; 程序启动命令
autostart=true  ; 在supervisord启动的时候也自动启动
startsecs=10   ; 启动10秒后没有异常退出，就表示进程正常启动了，默认为1秒
autorestart=true  ; 程序退出后自动重启,可选值：[unexpected,true,false]，默认为unexpected，表示进程意外杀死后才重启
startretries=3  ; 启动失败自动重试次数，默认是3
user=tomcat   ; 用哪个用户启动进程，默认是root
priority=999   ; 进程启动优先级，默认999，值小的优先启动
redirect_stderr=true ; 把stderr重定向到stdout，默认false
stdout_logfile_maxbytes=20MB ; stdout 日志文件大小，默认50MB
stdout_logfile_backups = 20 ; stdout 日志文件备份数，默认是10
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false  ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false  ;默认为false，向进程组发送kill信号，包括子进程
;包含其它配置文件
[include]
files =/etc/supervisord.d/*.ini ;可以指定一个或多个以.ini结束的配置文件；也可以是.conf结尾的配置文件

ini配置文件举例说明

[program:MysqlToRedis]
directory = /data/py/SmartServerModel/SmartServerModel/ModelManagerServer/
command= python3 -u mysql2redis_robot_config.py cs
autostart = true
autorestart=true
startsecs = 5
user =root
redirect_stderr = true
stdout_logfile = /data/logs/supervisord/mysqltoredis.log
[program:SmartBinLog]
command= /data/go/src/SmartBinLog/SmartBinLog
autostart = true
autorestart=true
startsecs = 5
user =root
redirect_stderr = true
stdout_logfile = /data/logs/supervisord/smartbinlog.log
[group:nlp]
programs=MysqlToRedis,SmartBinLog ;server,progname2 each refers to 'x' in [program:x] definitions
priority=999     ; the relative start priority (default 999)

• supervisor配置文件举例

  • 假设有个用 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

• • 对应的supervisor配置文件可能是：

[program:usercenter]
directory = /home/leon/projects/usercenter ; 程序的启动目录
command = gunicorn -w 8 -b 0.0.0.0:17510 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

其中[program:usercenter] 中的 usercenter 是应用程序的唯一标识，不能重复。对该程序的所有操作（start, restart 等）都通过名字来实现。

• Tomcat配置文件举例

[program:tomcat]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
autostart=true
autorestart=true
startsecs=5
priority=1
stopasgroup=true
killasgroup=true

启动supervisor

supervisord -c /etc/supervisord/supervisord.conf  && echo "supervisor-4.2.0 启动成功"

设置开机启动

• 进入/usr/lib/systemd/system/目录，并创建supervisor.service文件

[root@linux-node1 ~]#vim /usr/lib/systemd/system/supervisor.service
[Unit]
Description=supervisor
After=network.target

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown
ExecReload=/usr/bin/supervisorctl $OPTIONS reload
KillMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target

• 设置开机启动

systemctl daemon-reload
systemctl enable supervisord.service
ps aux|grep supervisord

开启web页面管理程序

• 在conf配置文件中把注释的这几行代码全部解除注释，然后更改端口，用户名和密码

[inet_http_server]   ;HTTP服务器，提供web管理界面
port=127.0.0.1:9001  ;Web管理后台运行的IP和端口，如果开放到公网，需要注意安全性
username=user    ;登录管理后台的用户名
password=123    ;登录管理后台的密码

supervisor常用命令

#指定配置文件启动supervisor
supervisorctl -c /path/to/supervisord.conf

#关闭 nginx
supervisorctl stop nginx

#启动 nginx
supervisorctl start nginx

#重启 nginx
supervisorctl restart nginx

#查看状态
supervisorctl status

#读取有更新的配置文件和检查语法问题
supervisorctl reread

#重启全部
supervisorctl reload

#更新配置
supervisorctl update

子进程配置文件示例

• supervisord.conf主配置文件

[nameke@VirBox01 ~]$ mkdir -p /home/nameke/conf/supervisor/
[nameke@VirBox01 ~]$ mkdir -p /home/nameke/logs/supervisor/
[nameke@VirBox01 ~]$ sudo egrep -v ";|^$" /etc/supervisor/supervisord.conf 
[unix_http_server]
[supervisord]
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]
[include]
files = /home/nameke/conf/supervisor/*.conf

• curl.conf子进程配置文件

[nameke@VirBox01 ~]$ cat /home/nameke/conf/supervisor/10.0.2.15.curl.conf  
[program:print_date]
directory = /home/nameke/conf/supervisor
command = /bin/bash /home/nameke/scripts/print_date.sh
process_name=%(program_name)s_%(process_num)02d
user = nameke
numprocs = 3
autostart = true
startsecs = 15
autorestart = true
startretries = 3
stopwaitsecs=10
killasgroup=true
priority=999
stopsignal=QUIT
redirect_stderr = false
stdout_logfile_maxbytes = 50MB
stdout_logfile_backups = 10
stdout_logfile = /home/nameke/logs/supervisor/%(program_name)s_%(process_num)02d_stdout.log
stderr_logfile = /home/nameke/logs/supervisor/%(program_name)s_%(process_num)02d_stderr.log
loglevel=info

• 业务进程命令示例

[nameke@VirBox01 ~]$ cat /home/nameke/scripts/print_date.sh                
#!/bin/bash
while true
do
    date
    /usr/bin/curl --head -s "http://www.shinebook.org:82/index.html"|grep "200 OK"
    sleep 10
done

• 测试结果

Tips

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