Supervisor(http://supervisord.org/)是用Python开发的一个client/server服务,是Linux/Unix系统下的一个进程管理工具,不支持Windows系统。它可以很方便地监听、启动、停止、重启一个或多个进程。当一个进程意外终止时,supervisort监听到进程死亡,会自动将它重新启动,很方便地做到用户进程守护的功能,不需要自己再写shell脚本来控制。
由于Supervisor是用Python开发的程序,在安装前,请确保系统已安装Python,并确保python版本至少为2.4。下面在CentOS7操作系统和Python2.7版本环境下,介绍Supervisor的安装与配置步聚:
1、安装Python包管理工具easy_install
easy_install是setuptools包里带的一个命令。使用easy_install,实际上是在调用setuptools来完成模块的安装工作。
设置PYTHONPATH,在.bash_profile里添加如下内容:
export PYTHONPATH=$HOME/Python
注意:如果$HOME/Python目录不存在,请使用如下命令创建:
$ mkdir $HOME/Python
转到$HOME/Python目录,下载setuptools包:
-
$ cd $HOME/Python
-
$ wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
2、安装supervisor
在第1步中,获取到的setuptools包为setuptools-33.1.1.zip,对其进行解压缩,使用easy_install工具安装supervisor:
-
$ unzip setuptools- 33.1.1.zip
-
$ cd setuptools- 33.1.1
-
$ easy_install --install-dir=$HOME/Python 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 $HOME/Python/etc
-
$ echo_supervisord_conf > $HOME/Python/etc/supervisord.conf
4、配置文件参数说明
supervisor的配置参数较多,下面介绍一下常用的参数配置,详细的配置及说明,请参考官网文档介绍。
注:以分号(;)开头,表示该行已被注释
-
[unix_http_server]
-
file=/tmp/supervisor.sock ;UNIX socket 文件,supervisorctl会使用其与supervisord通信
-
;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结束的配置文件
include示例:
-
[ include]
-
files = foo.conf config??.ini /opt/absolute /*.ini
或者
-
[ include]
-
files = supervisord.d /*.ini
注意:对于include示例,在使用相对路径时,默认当前目录为supervisord.conf所在目录。
5、配置管理进程
进程管理配置参数,不建议全都写在supervisord.conf文件中,建议每个进程写一个配置文件,并放在include配置块中files指定的目录下,通过include包含进supervisord.conf文件中。
1. 创建$HOME/Python/etc/supervisord.d目录,用于存放“进程管理配置文件”。
2. 修改$HOME/Python/etc/supervisord.conf中的include参数,将$HOME/Python/etc/supervisord.d目录添加到include中。
下面是配置Tomcat进程的一个例子:
-
[program:tomcat]
-
command= /opt/apache-tomcat-8.0.35/bin/catalina.sh run
-
process_name=%(program_name)s
-
numprocs= 1
-
directory= /usr/local/bin
-
user=jack
-
stdout_logfile= /opt/apache-tomcat-8.0.35/logs/catalina.out
-
autostart= true
-
autorestart= true
-
startsecs= 5
-
priority= 1
-
stopasgroup= true
-
killasgroup= true
5、启动Supervisor服务
-
$ cd $HOME/Python
-
$ /usr/bin/python supervisord -c etc/supervisord.conf
6、管理用户进程
6.1 交互终端
supervisord启动成功后,通过supervisorctl客户端来管理用户进程:启动、停止、重启。运行supervisorctl命令,会进入supervisor客户端的交互终端,并会列出当前所管理的所有进程。
$ /usr/bin/python supervisorctl -c etc/supervisord.conf
上图中的tomcat就是我们在配置文件中[program:tomcat]指定的名字。
输入help,可以查看命令列表。如果想看某个命令的作用,运行“help 命令名称”,如:help stop。stop tomcat 表示停止tomcat进程, stop all 表示停止所有进程。
6.2 bash终端
-
/usr/bin/python supervisorctl - c etc/supervisord.conf status
-
/usr/bin/python supervisorctl - c etc/supervisord.conf start tomcat
-
/usr/bin/python supervisorctl - c etc/supervisord.conf stop tomcat
-
/usr/bin/python supervisorctl - c etc/supervisord.conf restart tomcat
-
/usr/bin/python supervisorctl - c etc/supervisord.conf udpate
-
/usr/bin/python supervisorctl - c etc/supervisord.conf reread
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= 127.0.0.1:9001 ; (ip_address:port specifier, *:port for all iface)
-
username=jack ; ( default is no username (open server))
-
password= 123abc ; (default is no password (open server))
7、开机启动Supervisor服务
7.1 配置systemctl服务
7.1.1. 进入/lib/systemd/system目录,并创建supervisor.service文件,该文件内容如下所示。
-
[
-
Description=supervisor
-
After=network.target
-
-
[
-
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
-
-
[
-
WantedBy=multi-user.target
7.1.2 设置开机启动
-
$ systemctl enable supervisor.service
-
$ systemctl daemon-reload
7.1.3 修改文件权限为766
$ chmod 766 supervisor.service
7.2 配置service类型服务
创建/etc/rc.d/init.d/supervisor文件,该文件内容如下所示:
-
-
#
-
# supervisord This scripts turns supervisord on
-
#
-
# Author: Mike McGrath <[email protected]> (based off yumupdatesd)
-
#
-
# chkconfig: - 95 04
-
#
-
# description: supervisor is a process control utility. It has a web based
-
# xmlrpc interface as well as a few other nifty features.
-
# processname: supervisord
-
# config: /etc/supervisor/supervisord.conf
-
# pidfile: /var/run/supervisord.pid
-
#
-
-
# source function library
-
. /etc/rc.d/init.d/ functions
-
-
RETVAL=0
-
-
start() {
-
echo -n $"Starting supervisord: "
-
daemon "/usr/bin/python supervisord -c /home/jack/Python/etc/supervisord.conf"
-
RETVAL=$?
-
echo
-
[ $RETVAL -eq 0 ] && touch /var/lock/subsys/supervisord
-
}
-
-
stop() {
-
echo -n $"Stopping supervisord: "
-
killproc supervisord
-
echo
-
[ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/supervisord
-
}
-
-
restart() {
-
stop
-
start
-
}
-
-
case "$1" in
-
start)
-
start
-
;;
-
stop)
-
stop
-
;;
-
restart|force-reload|reload)
-
restart
-
;;
-
condrestart)
-
[ -f /var/lock/subsys/supervisord ] && restart
-
;;
-
status)
-
status supervisord
-
RETVAL=$?
-
;;
-
*)
-
echo $"Usage: $0 {start|stop|status|restart|reload|force-reload|condrestart}"
-
exit 1
-
esac
-
-
exit $RETVAL
修改文件权限为755,并设置开机启动:
-
$ chmod 755 /etc/rc.d/init.d/supervisor
-
$ chkconfig supervisor on
注意:修改脚本中supervisor配置文件路径为你的supervisor的配置文件路径
其它Linux发行版开机启动脚本:https://github.com/Supervisor/initscripts
注意:Supervisor只能管理非daemon的进程,不能管理守护进程。否则,会提示Exited too quickly (process log may have details)异常。例子中的Tomcat默认是以守护进程启动的,所以我们改成了catalina.sh run,以前台进程的方式运行。
另附:在centos操作系统上,以yum方式安装,使用如下命令。
-
$ yum install epel-release
-
$ yum install -y supervisor
supervisor没有发布在标准的CentOS源上,需要安装epel源。这种方式安装的supervisor可能不是最新版本,但比较方便,安装完成之后,配置文件会自动帮你生成。
默认配置文件:/etc/supervisord.conf
进程管理配置文件放到:/etc/supervisord.d/目录下即可。