Supervisor安裝與配置

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.pypa.io/ez_setup.py -O - | sudo python

2、安裝supervisor

easy_install 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 /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf

4、配置文件參數說明

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結束的配置文件

include示例：

[include]
files = /opt/absolute/filename.ini /opt/absolute/*.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中

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

supervisor配置文件目錄結構

下面是配置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

5、啟動Supervisor服務

supervisord -c /etc/supervisor/supervisord.conf

6、控制進程
6.1 交互終端

supervisord啟動成功后，可以通過supervisorctl客戶端控制進程，啟動、停止、重啟。運行supervisorctl命令，不加參數，會進入supervisor客戶端的交互終端，并會列出當前所管理的所有進程。
supervisorctl

上圖中的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管理界面

Supervisor 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端口
username：登錄管理后臺的用戶名
password：登錄管理后臺的密碼
7、開機啟動Supervisor服務
7.1 配置systemctl服務

1> 進入/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

2> 設置開機啟動

systemctl enable supervisor.service
systemctl daemon-reload

3、修改文件權限為766

chmod 766 supervisor.service

7.2 配置service類型服務

    #!/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

將上述腳本內容保存到/etc/rc.d/init.d/supervisor文件中，修改文件權限為755，并設置開機啟動

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

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

其它Linux發行版開機啟動腳本：https://github.com/Supervisor/initscripts
注意：

Supervisor只能管理非daemon的進程，也就是說Supervisor不能管理守護進程。否則提示Exited too quickly (process log may have details)異常。例子中的Tomcat默認是以守護進程啟動的，所以我們改成了catalina.sh run，以前臺進程的方式運行。

yum方式安裝

yum install epel-release
yum install -y supervisor

supervisor沒有發布在標準的CentOS源在，需要安裝epel源。這種方式安裝的可能不是最新版本，但比較方便，安裝完成之后，配置文件會自動幫你生成。
默認配置文件：/etc/supervisord.conf
進程管理配置文件放到：/etc/supervisord.d/目錄下即可