Ubuntu下Supervisor安装、配置和使用

本文基本上步骤在Ubuntu 16.04下验证经过

一、认识supervisor

Supervisor（http://supervisord.org/）是用Python开发的一个client/server服务，是Linux/Unix系统下的一个进程管理工具，不支持Windows系统。它能够很方便的监听、启动、中止、重启一个或多个进程。用Supervisor管理的进程，当一个进程意外被杀死，supervisort监听到进程死后，会自动将它从新拉起，很方便的作到进程自动恢复的功能，再也不须要本身写shell脚原本控制。

二、安装supervisor

apt-get install supervisor

supervisor安装完成后会生成三个执行程序：supervisortd、supervisorctl、echo_supervisord_conf，分别是supervisor的守护进程服务（用于接收进程管理命令）、客户端（用于和守护进程通讯，发送管理进程的指令）、生成初始配置文件程序。

三、配置

使用echo_supervisord_conf生成默认的配置文件

echo_supervisord_conf > /etc/supervisor/supervisord.conf

 

四、配置文件参数说明

supervisor的配置参数较多，下面介绍一下经常使用的参数配置，详细的配置及说明，请参考官方文档介绍。 
注：分号（;）开头的配置表示注释

[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 = relative/directory/*.ini    ;能够指定一个或多个以.ini结束的配置文件

 

五、配置管理进程

进程管理配置参数，不建议全都写在supervisord.conf文件中，应该每一个进程写一个配置文件放在include指定的目录下包含进supervisord.conf文件中。 
 修改/etc/supervisor/supervisord.conf中的include参数，将/etc/supervisor/conf.d目录添加到include中（关于*.ini，大部分资料用的都是*.conf格式做为配置文件。这个地方建议你们也都用*.conf不要用*.ini）

[include]
files = /etc/supervisor/config.d/*.ini

 

下面是配置Tomcat进程的一个例子：

[program:tomcat]
command=/bin/bash -c 'source /var/ftp_root/program/blog/startall.sh'
user=root
autostart=true
autorestart=true
redirect_stderr=True
stdout_logfile=/tmp/blog.log
stderr_logfile=/tmp/blog.err

 

五、启动Supervisor服务

supervisord -c /etc/supervisor/supervisord.conf

 

六、控制进程

6.1 交互终端

supervisord启动成功后，能够经过supervisorctl客户端控制进程，启动、中止、重启。运行supervisorctl命令，不加参数，会进入supervisor客户端的交互终端，并会列出当前所管理的全部进程。 

上图中的tomcat就是咱们在配置文件中[program:tomcat]指定的名字。

 

输入help能够查看能够执行的命令列表，若是想看某个命令的做用，运行help 命令名称，如：help stop

stop tomcat  // 表示中止tomcat进程
stop all     // 表示中止全部进程
// ...

 

6.2 bash终端

supervisorctl status
supervisorctl stop tomcat
supervisorctl start tomcat
supervisorctl restart tomcat
supervisorctl reread
supervisorctl update

 

6.3 Web管理界面

 
出于安全考虑，默认配置是没有开启web管理界面，须要修改supervisord.conf配置文件打开http访权限，将下面的配置：

;[inet_http_server]         ; inet (TCP) server disabled by default
;port=127.0.0.1:9001        ; (ip_address:port specifier, *:port for all iface)
;username=user              ; (default is no username (open server))
;password=123               ; (default is no password (open server))

修改为：

[inet_http_server]         ; inet (TCP) server disabled by default
port=0.0.0.0:9001          ; (ip_address:port specifier, *:port for all iface)
username=user              ; (default is no username (open server))
password=123               ; (default is no password (open server))

port：绑定访问IP和端口，这里是绑定的是本地IP和9001端口 ,注意要把127.0.0.1修改为0.0.0.0,不然外网访问不了。
username：登陆管理后台的用户名 
password：登陆管理后台的密码

七、开机启动Supervisor服务

7.1 配置systemctl服务

1> 进入/lib/systemd/system目录，查看是否有supervisor.service文件,若没有建立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

 

2> 设置开机启动

chmod 766 supervisor.service
systemctl enable supervisor.service
systemctl daemon-reload

 

七、注意点：

1>关于在command中，执行.sh脚本
请参照此配置文件中command的写法，直接写command=source xxx，会报source不认识：

[program:blog]
command=/bin/bash -c 'source /var/ftp_root/program/blog/startall.sh'
user=root
autostart=true
autorestart=true
redirect_stderr=True
stdout_logfile=/tmp/blog.log
stderr_logfile=/tmp/blog.err
stopasgroup=true
killasgroup=true

2.关于supervisorctl的使用

1)、修改好配置文件后

supervisorctl reread
supervisorctl update

 

2)、更新新的配置到supervisord    

supervisorctl update  

3)、从新启动配置中的全部程序

supervisorctl reload  

4)、启动某个进程(program_name=你配置中写的程序名称)

supervisorctl start program_name  

5)、查看正在守候的进程

supervisorctl  

6)、中止某一进程 (program_name=你配置中写的程序名称)

pervisorctl stop program_name  

7)、重启某一进程 (program_name=你配置中写的程序名称)

supervisorctl restart program_name  

8)、中止所有进程

supervisorctl stop all  

注意：显示用stop中止掉的进程，用reload或者update都不会自动重启。

3）错误 - Error no log file
检查本身增长的程序配置文件中，是否增长了log的配置，没有的话，要加上。

stdout_logfile=/tmp/blog.log
stderr_logfile=/tmp/blog.err

再介绍两个配置项 stopasgroup 和 killasgroup

stopasgroup; 默认为 false，若是设置为 true，当进程收到 stop 信号时，会自动将该信号发给该进程的子进程。若是这个配置项为 true，那么也隐含 killasgroup 为 true。例如在 Debug 模式使用 Flask 时，Flask 不会将接收到的 stop 信号也传递给它的子进程，所以就须要设置这个配置项。
stopasgroup=false       ; send stop signal to the UNIX process 

killasgroup; 默认为 false，若是设置为 true，当进程收到 kill 信号时，会自动将该信号发给该进程的子进程。若是这个程序使用了 python 的 multiprocessing 时，就能自动中止它的子线程。
killasgroup=false       ; SIGKILL the UNIX process group (def false)

参考引用：

http://blog.csdn.net/xyang81/article/details/51555473

http://blog.csdn.net/shudaqi2010/article/details/51153961

每一个选项详细设置：http://www.jb51.net/article/92792.htm