Supervisor(http://supervisord.org/)是用Python开发的一个client/server服务,是Linux/Unix系统下的一个进程管理工具,不支持Windows系统。它可以很方便的监听、启动、停止、重启一个或多个进程。用Supervisor管理的进程,当一个进程意外被杀死,supervisort监听到进程死后,会自动将它重新拉起,很方便的做到进程自动恢复的功能,不再需要自己写shell脚本来控制。
因为Supervisor是Python开发的,安装前先检查一下系统否安装了Python2.4以上版本。下面以CentOS7,Python2.7版本环境下,介绍Supervisor的安装与配置步聚:
1、安装Python包管理工具(easy_install)
easy_install是setuptools包里带的一个命令,使用easy_install实际上是在调用setuptools来完成安装模块的工作,所以安装setuptools即可。
wget --no-check-certificate https://bootstrap<span class="hljs-preprocessor">.pypa</span><span class="hljs-preprocessor">.io</span>/ez_setup<span class="hljs-preprocessor">.py</span> -O - | sudo python
2、安装supervisor
easy_install supervisor
supervisor安装完成后会生成三个执行程序:supervisortd、supervisorctl、echo_supervisord_conf,分别是supervisor的守护进程服务(用于接收进程管理命令)、客户端(用于和守护进程通信,发送管理进程的指令)、生成初始配置文件程序。
3、配置
运行supervisord服务的时候,需要指定supervisor配置文件,如果没有显示指定,默认在以下目录查找:
$CWD/supervisord<span class="hljs-preprocessor">.conf</span>
$CWD/etc/supervisord<span class="hljs-preprocessor">.conf</span>
/etc/supervisord<span class="hljs-preprocessor">.conf</span>
/etc/supervisor/supervisord<span class="hljs-preprocessor">.conf</span> (since Supervisor <span class="hljs-number">3.3</span><span class="hljs-number">.0</span>)
../etc/supervisord<span class="hljs-preprocessor">.conf</span> (Relative to the executable)
../supervisord<span class="hljs-preprocessor">.conf</span> (Relative to the executable)
$CWD表示运行supervisord程序的目录。
可以通过运行echo_supervisord_conf程序生成supervisor的初始化配置文件,如下所示:
mkdir /etc/supervisor
<span class="hljs-built_in">echo</span>_supervisord_conf > /etc/supervisor/supervisord.conf
4、配置文件参数说明
supervisor的配置参数较多,下面介绍一下常用的参数配置,详细的配置及说明,请参考官方文档介绍。 注:分号(;)开头的配置表示注释
<span class="hljs-title">[unix_http_server]</span>
<span class="hljs-setting">file=<span class="hljs-value">/tmp/supervisor.sock ;UNIX socket 文件,supervisorctl 会使用</span></span>
<span class="hljs-comment">;chmod=0700 ;socket文件的mode,默认是0700</span>
<span class="hljs-comment">;chown=nobody:nogroup ;socket文件的owner,格式:uid:gid</span>
<span class="hljs-comment">;[inet_http_server] ;HTTP服务器,提供web管理界面</span>
<span class="hljs-comment">;port=127.0.0.1:9001 ;Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性</span>
<span class="hljs-comment">;username=user ;登录管理后台的用户名</span>
<span class="hljs-comment">;password=123 ;登录管理后台的密码</span>
<span class="hljs-title">[supervisord]</span>
<span class="hljs-setting">logfile=<span class="hljs-value">/tmp/supervisord.log ;日志文件,默认是 $CWD/supervisord.log</span></span>
<span class="hljs-setting">logfile_maxbytes=<span class="hljs-value"><span class="hljs-number">50</span>MB ;日志文件大小,超出会rotate,默认 <span class="hljs-number">50</span>MB,如果设成<span class="hljs-number">0</span>,表示不限制大小</span></span>
<span class="hljs-setting">logfile_backups=<span class="hljs-value"><span class="hljs-number">10</span> ;日志文件保留备份数量默认<span class="hljs-number">10</span>,设为<span class="hljs-number">0</span>表示不备份</span></span>
<span class="hljs-setting">loglevel=<span class="hljs-value">info ;日志级别,默认info,其它: debug,warn,trace</span></span>
<span class="hljs-setting">pidfile=<span class="hljs-value">/tmp/supervisord.pid ;pid 文件</span></span>
<span class="hljs-setting">nodaemon=<span class="hljs-value"><span class="hljs-keyword">false</span> ;是否在前台启动,默认是<span class="hljs-keyword">false</span>,即以 daemon 的方式启动</span></span>
<span class="hljs-setting">minfds=<span class="hljs-value"><span class="hljs-number">1024</span> ;可以打开的文件描述符的最小值,默认 <span class="hljs-number">1024</span></span></span>
<span class="hljs-setting">minprocs=<span class="hljs-value"><span class="hljs-number">200</span> ;可以打开的进程数的最小值,默认 <span class="hljs-number">200</span></span></span>
<span class="hljs-title">[supervisorctl]</span>
<span class="hljs-setting">serverurl=<span class="hljs-value">unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord,路径与unix_http_server部分的file一致</span></span>
<span class="hljs-comment">;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord</span>
<span class="hljs-comment">; [program:xx]是被管理的进程配置参数,xx是进程的名称</span>
<span class="hljs-title">[program:xx]</span>
<span class="hljs-setting">command=<span class="hljs-value">/opt/apache-tomcat-<span class="hljs-number">8.0</span>.<span class="hljs-number">35</span>/bin/catalina.sh run ; 程序启动命令</span></span>
<span class="hljs-setting">autostart=<span class="hljs-value"><span class="hljs-keyword">true</span> ; 在supervisord启动的时候也自动启动</span></span>
<span class="hljs-setting">startsecs=<span class="hljs-value"><span class="hljs-number">10</span> ; 启动<span class="hljs-number">10</span>秒后没有异常退出,就表示进程正常启动了,默认为<span class="hljs-number">1</span>秒</span></span>
<span class="hljs-setting">autorestart=<span class="hljs-value"><span class="hljs-keyword">true</span> ; 程序退出后自动重启,可选值:[unexpected,<span class="hljs-keyword">true</span>,<span class="hljs-keyword">false</span>],默认为unexpected,表示进程意外杀死后才重启</span></span>
<span class="hljs-setting">startretries=<span class="hljs-value"><span class="hljs-number">3</span> ; 启动失败自动重试次数,默认是<span class="hljs-number">3</span></span></span>
<span class="hljs-setting">user=<span class="hljs-value">tomcat ; 用哪个用户启动进程,默认是root</span></span>
<span class="hljs-setting">priority=<span class="hljs-value"><span class="hljs-number">999</span> ; 进程启动优先级,默认<span class="hljs-number">999</span>,值小的优先启动</span></span>
<span class="hljs-setting">redirect_stderr=<span class="hljs-value"><span class="hljs-keyword">true</span> ; 把stderr重定向到stdout,默认<span class="hljs-keyword">false</span></span></span>
<span class="hljs-setting">stdout_logfile_maxbytes=<span class="hljs-value"><span class="hljs-number">20</span>MB ; stdout 日志文件大小,默认<span class="hljs-number">50</span>MB</span></span>
<span class="hljs-setting">stdout_logfile_backups = <span class="hljs-value"><span class="hljs-number">20</span> ; stdout 日志文件备份数,默认是<span class="hljs-number">10</span></span></span>
<span class="hljs-comment">; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)</span>
<span class="hljs-setting">stdout_logfile=<span class="hljs-value">/opt/apache-tomcat-<span class="hljs-number">8.0</span>.<span class="hljs-number">35</span>/logs/catalina.out</span></span>
<span class="hljs-setting">stopasgroup=<span class="hljs-value"><span class="hljs-keyword">false</span> ;默认为<span class="hljs-keyword">false</span>,进程被杀死时,是否向这个进程组发送stop信号,包括子进程</span></span>
<span class="hljs-setting">killasgroup=<span class="hljs-value"><span class="hljs-keyword">false</span> ;默认为<span class="hljs-keyword">false</span>,向进程组发送kill信号,包括子进程</span></span>
<span class="hljs-comment">;包含其它配置文件</span>
<span class="hljs-title">[include]</span>
<span class="hljs-setting">files = <span class="hljs-value">relative/directory/*.ini ;可以指定一个或多个以.ini结束的配置文件</span></span>
include示例:
[<span class="hljs-keyword">include</span>]
files = <span class="hljs-regexp">/opt/absolute</span><span class="hljs-regexp">/filename.ini /opt</span><span class="hljs-regexp">/absolute/</span>*.ini foo.conf config??.ini
5、配置管理进程
进程管理配置参数,不建议全都写在supervisord.conf文件中,应该每个进程写一个配置文件放在include指定的目录下包含进supervisord.conf文件中。 1> 创建/etc/supervisor/config.d目录,用于存放进程管理的配置文件 2> 修改/etc/supervisor/supervisord.conf中的include参数,将/etc/supervisor/conf.d目录添加到include中
[<span class="hljs-keyword">include</span>]
files = <span class="hljs-regexp">/etc/supervisor</span><span class="hljs-regexp">/config.d/</span>*.ini

下面是配置Tomcat进程的一个例子:
<span class="hljs-title">[program:tomcat]</span>
<span class="hljs-setting">command=<span class="hljs-value">/opt/apache-tomcat-<span class="hljs-number">8.0</span>.<span class="hljs-number">35</span>/bin/catalina.sh run</span></span>
<span class="hljs-setting">stdout_logfile=<span class="hljs-value">/opt/apache-tomcat-<span class="hljs-number">8.0</span>.<span class="hljs-number">35</span>/logs/catalina.out</span></span>
<span class="hljs-setting">autostart=<span class="hljs-value"><span class="hljs-keyword">true</span></span></span>
<span class="hljs-setting">autorestart=<span class="hljs-value"><span class="hljs-keyword">true</span></span></span>
<span class="hljs-setting">startsecs=<span class="hljs-value"><span class="hljs-number">5</span></span></span>
<span class="hljs-setting">priority=<span class="hljs-value"><span class="hljs-number">1</span></span></span>
<span class="hljs-setting">stopasgroup=<span class="hljs-value"><span class="hljs-keyword">true</span></span></span>
<span class="hljs-setting">killasgroup=<span class="hljs-value"><span class="hljs-keyword">true</span></span></span>
5、启动Supervisor服务
6、控制进程
6.1 交互终端
supervisord启动成功后,可以通过supervisorctl客户端控制进程,启动、停止、重启。运行supervisorctl命令,不加参数,会进入supervisor客户端的交互终端,并会列出当前所管理的所有进程。

上图中的tomcat就是我们在配置文件中[program:tomcat]指定的名字。
输入help可以查看可以执行的命令列表,如果想看某个命令的作用,运行help 命令名称,如:help stop
<span class="hljs-keyword">stop</span> tomcat // 表示停止tomcat进程
<span class="hljs-keyword">stop</span> all // 表示停止所有进程
// <span class="hljs-keyword">...</span>
6.2 bash终端
supervisorctl status
supervisorctl stop tomcat
supervisorctl <span class="hljs-operator"><span class="hljs-keyword">start</span> tomcat
supervisorctl restart tomcat
supervisorctl reread
supervisorctl <span class="hljs-keyword">update</span></span>
6.3 Web管理界面

出于安全考虑,默认配置是没有开启web管理界面,需要修改supervisord.conf配置文件打开http访权限,将下面的配置:
;[inet_http_server] ; inet (TCP) server disabled by <span class="hljs-keyword">default</span>
;<span class="hljs-keyword">port</span>=<span class="hljs-number">127.0</span><span class="hljs-number">.0</span><span class="hljs-number">.1</span>:<span class="hljs-number">9001</span> ; (ip_address:<span class="hljs-keyword">port</span> specifier, *:<span class="hljs-keyword">port</span> <span class="hljs-keyword">for</span> <span class="hljs-keyword">all</span> iface)
;username=user ; (<span class="hljs-keyword">default</span> <span class="hljs-keyword">is</span> no username (<span class="hljs-keyword">open</span> server))
;password=<span class="hljs-number">123</span> ; (<span class="hljs-keyword">default</span> <span class="hljs-keyword">is</span> no password (<span class="hljs-keyword">open</span> server))
修改成:
[inet_http_server] ; inet (TCP) server disabled by <span class="hljs-keyword">default</span>
<span class="hljs-keyword">port</span>=<span class="hljs-number">0.0</span><span class="hljs-number">.0</span><span class="hljs-number">.0</span>:<span class="hljs-number">9001</span> ; (ip_address:<span class="hljs-keyword">port</span> specifier, *:<span class="hljs-keyword">port</span> <span class="hljs-keyword">for</span> <span class="hljs-keyword">all</span> iface)
username=user ; (<span class="hljs-keyword">default</span> <span class="hljs-keyword">is</span> no username (<span class="hljs-keyword">open</span> server))
password=<span class="hljs-number">123</span> ; (<span class="hljs-keyword">default</span> <span class="hljs-keyword">is</span> no password (<span class="hljs-keyword">open</span> server))
port:绑定访问IP和端口,这里是绑定的是本地IP和9001端口 username:登录管理后台的用户名 password:登录管理后台的密码
7、开机启动Supervisor服务
7.1 配置systemctl服务
1> 进入/lib/systemd/system目录,并创建supervisor.service文件
<span class="hljs-title">[Unit]</span>
<span class="hljs-setting">Description=<span class="hljs-value">supervisor</span></span>
<span class="hljs-setting">After=<span class="hljs-value">network.target</span></span>
<span class="hljs-title">[Service]</span>
<span class="hljs-setting">Type=<span class="hljs-value">forking</span></span>
<span class="hljs-setting">ExecStart=<span class="hljs-value">/usr/bin/supervisord -c /etc/supervisor/supervisord.conf</span></span>
<span class="hljs-setting">ExecStop=<span class="hljs-value">/usr/bin/supervisorctl OPTIONS shutdown</span></span>
<span class="hljs-setting">ExecReload=<span class="hljs-value">/usr/bin/supervisorctlOPTIONS reload</span></span>
<span class="hljs-setting">KillMode=<span class="hljs-value">process</span></span>
<span class="hljs-setting">Restart=<span class="hljs-value"><span class="hljs-keyword">on</span>-failure</span></span>
<span class="hljs-setting">RestartSec=<span class="hljs-value"><span class="hljs-number">42</span>s</span></span>
<span class="hljs-title">[Install]</span>
<span class="hljs-setting">WantedBy=<span class="hljs-value">multi-user.target</span></span>
2> 设置开机启动
systemctl enable supervisor<span class="hljs-preprocessor">.service</span>
systemctl daemon-reload
3、修改文件权限为766
<span class="hljs-keyword">chmod</span> <span class="hljs-number">766</span> supervisor.service
7.2 配置service类型服务
<span class="hljs-shebang">#!/bin/bash</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># supervisord This scripts turns supervisord on</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Author: Mike McGrath <mmcgrath@<a title="RedHat" href="http://www.linuxidc.com/topicnews.aspx?tid=10" target="_blank" rel="noopener">RedHat</a>.com> (based off yumupdatesd)</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># chkconfig: - 95 04</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># description: supervisor is a process control utility. It has a web based</span>
<span class="hljs-comment"># xmlrpc interface as well as a few other nifty features.</span>
<span class="hljs-comment"># processname: supervisord</span>
<span class="hljs-comment"># config: /etc/supervisor/supervisord.conf</span>
<span class="hljs-comment"># pidfile: /var/run/supervisord.pid</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># source function library</span>
. /etc/rc.d/init.d/functions
RETVAL=<span class="hljs-number">0</span>
<span class="hljs-function"><span class="hljs-title">start</span></span>() {
<span class="hljs-built_in">echo</span> -n <span class="hljs-string">"Starting supervisord: "</span>
daemon <span class="hljs-string">"supervisord -c /etc/supervisor/supervisord.conf "</span>
RETVAL=?
<span class="hljs-built_in">echo</span>
[ <span class="hljs-variable">RETVAL</span> <span class="hljs-operator">-eq</span> <span class="hljs-number">0</span> ] && touch /var/lock/subsys/supervisord
}
<span class="hljs-function"><span class="hljs-title">stop</span></span>() {
<span class="hljs-built_in">echo</span> -n<span class="hljs-string">"Stopping supervisord: "</span>
killproc supervisord
<span class="hljs-built_in">echo</span>
[ <span class="hljs-variable">RETVAL</span> <span class="hljs-operator">-eq</span> <span class="hljs-number">0</span> ] && rm <span class="hljs-operator">-f</span> /var/lock/subsys/supervisord
}
<span class="hljs-function"><span class="hljs-title">restart</span></span>() {
stop
start
}
<span class="hljs-keyword">case</span> <span class="hljs-string">"<span class="hljs-variable">1</span>"</span> <span class="hljs-keyword">in</span>
start)
start
;;
stop)
stop
;;
restart|force-reload|reload)
restart
;;
condrestart)
[ <span class="hljs-operator">-f</span> /var/lock/subsys/supervisord ] && restart
;;
status)
status supervisord
RETVAL=?
;;
*)
<span class="hljs-built_in">echo</span><span class="hljs-string">"Usage: <span class="hljs-variable">0</span> {start|stop|status|restart|reload|force-reload|condrestart}"</span>
<span class="hljs-keyword">exit</span> <span class="hljs-number">1</span>
<span class="hljs-keyword">esac</span>
<span class="hljs-keyword">exit</span> <span class="hljs-variable">RETVAL</span>
将上述脚本内容保存到/etc/rc.d/init.d/supervisor文件中,修改文件权限为755,并设置开机启动
chmod <span class="hljs-number">755</span> /etc/rc.d/init.d/supervisor
chkconfig supervisor <span class="hljs-command"><span class="hljs-keyword">on</span></span>
注意:修改脚本中supervisor配置文件路径为你的supervisor的配置文件路径
其它Linux发行版开机启动脚本:https://github.com/Supervisor/initscripts
supervisor安装配置与使用 http://www.linuxidc.com/Linux/2015-04/116701.htm
注意:
Supervisor只能管理非daemon的进程,也就是说Supervisor不能管理守护进程。否则提示Exited too quickly (process log may have details)异常。例子中的Tomcat默认是以守护进程启动的,所以我们改成了catalina.sh run,以前台进程的方式运行。
yum方式安装
yum <span class="hljs-keyword">install</span> epel-release
yum <span class="hljs-keyword">install</span> -y supervisor
supervisor没有发布在标准的CentOS源在,需要安装epel源。这种方式安装的可能不是最新版本,但比较方便,安装完成之后,配置文件会自动帮你生成。 默认配置文件:/etc/supervisord.conf 进程管理配置文件放到:/etc/supervisord.d/目录下即可
默认日志文件:/tmp/supervisord.log,可以查看进程的启动信息