Supervisor安裝與配置

Supervisor（http://supervisord.org/）是用Python開發(fā)的一個(gè)client/server服務(wù)，是Linux/Unix系統(tǒng)下的一個(gè)進(jìn)程管理工具，不支持Windows系統(tǒng)。它可以很方便的監(jiān)聽、啟動(dòng)、停止、重啟一個(gè)或多個(gè)進(jìn)程。用Supervisor管理的進(jìn)程，當(dāng)一個(gè)進(jìn)程意外被殺死，supervisort監(jiān)聽到進(jìn)程死后，會(huì)自動(dòng)將它重新拉起，很方便的做到進(jìn)程自動(dòng)恢復(fù)的功能，不再需要自己寫shell腳本來(lái)控制。

因?yàn)镾upervisor是Python開發(fā)的，安裝前先檢查一下系統(tǒng)否安裝了Python2.4以上版本。下面以CentOS7，Python2.7版本環(huán)境下，介紹Supervisor的安裝與配置步聚：
1、安裝Python包管理工具（easy_install）

easy_install是setuptools包里帶的一個(gè)命令，使用easy_install實(shí)際上是在調(diào)用setuptools來(lái)完成安裝模塊的工作,所以安裝setuptools即可。

wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python

2、安裝supervisor

easy_install supervisor

supervisor安裝完成后會(huì)生成三個(gè)執(zhí)行程序：supervisortd、supervisorctl、echo_supervisord_conf，分別是supervisor的守護(hù)進(jìn)程服務(wù)（用于接收進(jìn)程管理命令）、客戶端（用于和守護(hù)進(jìn)程通信，發(fā)送管理進(jìn)程的指令）、生成初始配置文件程序。
3、配置

運(yùn)行supervisord服務(wù)的時(shí)候，需要指定supervisor配置文件，如果沒(méi)有顯示指定，默認(rèn)在以下目錄查找：

$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表示運(yùn)行supervisord程序的目錄。

可以通過(guò)運(yùn)行echo_supervisord_conf程序生成supervisor的初始化配置文件，如下所示：

mkdir /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf

4、配置文件參數(shù)說(shuō)明

supervisor的配置參數(shù)較多，下面介紹一下常用的參數(shù)配置，詳細(xì)的配置及說(shuō)明，請(qǐng)參考官方文檔介紹。
注：分號(hào)（;）開頭的配置表示注釋

[unix_http_server]
file=/tmp/supervisor.sock   ;UNIX socket 文件，supervisorctl 會(huì)使用
;chmod=0700                 ;socket文件的mode，默認(rèn)是0700
;chown=nobody:nogroup       ;socket文件的owner，格式：uid:gid

;[inet_http_server]         ;HTTP服務(wù)器，提供web管理界面
;port=127.0.0.1:9001        ;Web管理后臺(tái)運(yùn)行的IP和端口，如果開放到公網(wǎng)，需要注意安全性
;username=user              ;登錄管理后臺(tái)的用戶名
;password=123               ;登錄管理后臺(tái)的密碼

[supervisord]
logfile=/tmp/supervisord.log ;日志文件，默認(rèn)是 $CWD/supervisord.log
logfile_maxbytes=50MB        ;日志文件大小，超出會(huì)rotate，默認(rèn) 50MB，如果設(shè)成0，表示不限制大小
logfile_backups=10           ;日志文件保留備份數(shù)量默認(rèn)10，設(shè)為0表示不備份
loglevel=info                ;日志級(jí)別，默認(rèn)info，其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false               ;是否在前臺(tái)啟動(dòng)，默認(rèn)是false，即以 daemon 的方式啟動(dòng)
minfds=1024                  ;可以打開的文件描述符的最小值，默認(rèn) 1024
minprocs=200                 ;可以打開的進(jìn)程數(shù)的最小值，默認(rèn) 200

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通過(guò)UNIX socket連接supervisord，路徑與unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通過(guò)HTTP的方式連接supervisord

; [program:xx]是被管理的進(jìn)程配置參數(shù)，xx是進(jìn)程的名稱
[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run  ; 程序啟動(dòng)命令
autostart=true       ; 在supervisord啟動(dòng)的時(shí)候也自動(dòng)啟動(dòng)
startsecs=10         ; 啟動(dòng)10秒后沒(méi)有異常退出，就表示進(jìn)程正常啟動(dòng)了，默認(rèn)為1秒
autorestart=true     ; 程序退出后自動(dòng)重啟,可選值：[unexpected,true,false]，默認(rèn)為unexpected，表示進(jìn)程意外殺死后才重啟
startretries=3       ; 啟動(dòng)失敗自動(dòng)重試次數(shù)，默認(rèn)是3
user=tomcat          ; 用哪個(gè)用戶啟動(dòng)進(jìn)程，默認(rèn)是root
priority=999         ; 進(jìn)程啟動(dòng)優(yōu)先級(jí)，默認(rèn)999，值小的優(yōu)先啟動(dòng)
redirect_stderr=true ; 把stderr重定向到stdout，默認(rèn)false
stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小，默認(rèn)50MB
stdout_logfile_backups = 20   ; stdout 日志文件備份數(shù)，默認(rèn)是10
; stdout 日志文件，需要注意當(dāng)指定目錄不存在時(shí)無(wú)法正常啟動(dòng)，所以需要手動(dòng)創(chuàng)建目錄（supervisord 會(huì)自動(dòng)創(chuàng)建日志文件）
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false     ;默認(rèn)為false,進(jìn)程被殺死時(shí)，是否向這個(gè)進(jìn)程組發(fā)送stop信號(hào)，包括子進(jìn)程
killasgroup=false     ;默認(rèn)為false，向進(jìn)程組發(fā)送kill信號(hào)，包括子進(jìn)程

;包含其它配置文件
[include]
files = relative/directory/*.ini    ;可以指定一個(gè)或多個(gè)以.ini結(jié)束的配置文件

include示例：

[include]
files = /opt/absolute/filename.ini /opt/absolute/*.ini foo.conf config??.ini

5、配置管理進(jìn)程

進(jìn)程管理配置參數(shù)，不建議全都寫在supervisord.conf文件中，應(yīng)該每個(gè)進(jìn)程寫一個(gè)配置文件放在include指定的目錄下包含進(jìn)supervisord.conf文件中。
1> 創(chuàng)建/etc/supervisor/config.d目錄，用于存放進(jìn)程管理的配置文件
2> 修改/etc/supervisor/supervisord.conf中的include參數(shù)，將/etc/supervisor/conf.d目錄添加到include中

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

supervisor配置文件目錄結(jié)構(gòu)

下面是配置Tomcat進(jìn)程的一個(gè)例子：

[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

5、啟動(dòng)Supervisor服務(wù)

supervisord -c /etc/supervisor/supervisord.conf

6、控制進(jìn)程
6.1 交互終端

supervisord啟動(dòng)成功后，可以通過(guò)supervisorctl客戶端控制進(jìn)程，啟動(dòng)、停止、重啟。運(yùn)行supervisorctl命令，不加參數(shù)，會(huì)進(jìn)入supervisor客戶端的交互終端，并會(huì)列出當(dāng)前所管理的所有進(jìn)程。
supervisorctl

上圖中的tomcat就是我們?cè)谂渲梦募衃program:tomcat]指定的名字。

輸入help可以查看可以執(zhí)行的命令列表，如果想看某個(gè)命令的作用，運(yùn)行help 命令名稱，如：help stop

stop tomcat  // 表示停止tomcat進(jìn)程
stop all     // 表示停止所有進(jìn)程
// ...

6.2 bash終端

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

6.3 Web管理界面

Supervisor Web管理界面
出于安全考慮，默認(rèn)配置是沒(méi)有開啟web管理界面，需要修改supervisord.conf配置文件打開http訪權(quán)限，將下面的配置：

;[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：綁定訪問(wèn)IP和端口，這里是綁定的是本地IP和9001端口
username：登錄管理后臺(tái)的用戶名
password：登錄管理后臺(tái)的密碼
7、開機(jī)啟動(dòng)Supervisor服務(wù)
7.1 配置systemctl服務(wù)

1> 進(jìn)入/lib/systemd/system目錄，并創(chuàng)建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> 設(shè)置開機(jī)啟動(dòng)

systemctl enable supervisor.service
systemctl daemon-reload

3、修改文件權(quán)限為766

chmod 766 supervisor.service

7.2 配置service類型服務(wù)

    #!/bin/bash
#supervisord   This scripts turns supervisord on
#Author:       Mike McGrath <mmcgrath@redhat.com> (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 "supervisord -c /etc/supervisor/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

將上述腳本內(nèi)容保存到/etc/rc.d/init.d/supervisor文件中，修改文件權(quán)限為755，并設(shè)置開機(jī)啟動(dòng)

chmod 755 /etc/rc.d/init.d/supervisor
chkconfig supervisor on

注意：修改腳本中supervisor配置文件路徑為你的supervisor的配置文件路徑

其它Linux發(fā)行版開機(jī)啟動(dòng)腳本：https://github.com/Supervisor/initscripts
注意：

Supervisor只能管理非daemon的進(jìn)程，也就是說(shuō)Supervisor不能管理守護(hù)進(jìn)程。否則提示Exited too quickly (process log may have details)異常。例子中的Tomcat默認(rèn)是以守護(hù)進(jìn)程啟動(dòng)的，所以我們改成了catalina.sh run，以前臺(tái)進(jìn)程的方式運(yùn)行。

yum方式安裝

yum install epel-release
yum install -y supervisor

supervisor沒(méi)有發(fā)布在標(biāo)準(zhǔn)的CentOS源在，需要安裝epel源。這種方式安裝的可能不是最新版本，但比較方便，安裝完成之后，配置文件會(huì)自動(dòng)幫你生成。
默認(rèn)配置文件：/etc/supervisord.conf
進(jìn)程管理配置文件放到：/etc/supervisord.d/目錄下即可