1. 程式人生 > >Supervisor 安裝與配置 (Linux 程序管理工具)

Supervisor 安裝與配置 (Linux 程序管理工具)

Supervisor 安裝與配置 (Linux 程序管理工具)

Supervisor(http://supervisord.org/)是用 Python 開發的一個 client/server 服務,是 Linux/Unix 系統下的一個程序管理工具,不支援 Windows 系統。它可以很方便的監聽、啟動、停止、重啟一個或多個程序。用 Supervisor 管理的程序,當一個程序意外被殺死, supervisorctl 監聽到程序死後,會自動將它重新拉起,很方便的做到程序自動恢復的功能,不再需要自己寫 shell 指令碼來控制。

因為 Supervisor 是 Python 開發的,安裝前先檢查一下系統否安裝了 Python2.4 以上版本。下面以 CentOS7,Python2.7 版本環境下,介紹 Supervisor 的安裝與配置步聚:

一、安裝 Python 包管理工具(easy_install)

easy_install 是 setuptools 包裡帶的一個命令,使用 easy_install 實際上是在呼叫 setuptools 來完成安裝模組的工作,所以安裝 setuptools 即可。

二、安裝 Supervisor

easy_install supervisor

supervisor 安裝完成後會生成三個執行程式: supervisortd 、 supervisorctl 、 echo_supervisord_conf ,分別是 supervisor 的守護程序服務(用於接收程序管理命令)、客戶端(用於和守護程序通訊,傳送管理程序的指令)、生成初始配置檔案程式。

三、配置

執行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

四、配置檔案引數說明

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

五、配置管理程序

程序管理配置引數,不建議全都寫在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

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

六、啟動 Supervisor 服務

supervisord -c /etc/supervisor/supervisord.conf

七、控制程序

1、互動終端

supervisord 啟動成功後,可以通過 supervisorctl 客戶端控制程序,啟動、停止、重啟。執行 supervisorctl 命令,不加引數,會進入 supervisor 客戶端的互動終端,並會列出當前所管理的所有程序。

supervisorctl -c /etc/supervisor/supervisord.conf

會出現:

# ps -ef | grep php
root     16647     1  0 13:37 ?        00:00:00 php-fpm: master process (/usr/local/php71/etc/php-fpm.conf)
www      16648 16647  0 13:37 ?        00:00:49 php-fpm: pool www
www      16649 16647  0 13:37 ?        00:00:49 php-fpm: pool www
www      18456 18455  0 14:42 ?        00:00:02 php /data/www/student/artisan queue:work --queue=exam-sign --daemon --quiet --delay=3 --sleep=3 --tries=3
www      18457 18455  0 14:42 ?        00:00:02 php /data/www/student/artisan queue:work --queue=exam-sign --daemon --quiet --delay=3 --sleep=3 --tries=3
www      18458 18455  0 14:42 ?        00:00:02 php /data/www/student/artisan queue:work --queue=exam-sign --daemon --quiet --delay=3 --sleep=3 --tries=3
www      18459 18455  0 14:42 ?        00:00:02 php /data/www/student/artisan queue:work --queue=exam-submit --daemon --quiet --delay=3 --sleep=3 --tries=3
www      18460 18455  0 14:42 ?        00:00:02 php /data/www/student/artisan queue:work --queue=exam-submit --daemon --quiet --delay=3 --sleep=3 --tries=3
www      18461 18455  0 14:42 ?        00:00:02 php /data/www/student/artisan queue:work --queue=exam-submit --daemon --quiet --delay=3 --sleep=3 --tries=3

2、bash 終端

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

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埠
username:登入管理後臺的使用者名稱
password:登入管理後臺的密碼

Notice:記得修改防火牆配置。

八、開機啟動 Supervisor 服務

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

設定開機自啟

systemctl enable supervisor.service
systemctl daemon-reload

配置 service 型別服務

#!/bin/bash
#
# 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 "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,並設定開機啟動

或者 個人管理工具

SUPERVISORD=supervisord
SUPERVISORCTL=supervisorctl
case $1 in
start)
        echo -n "Starting supervisord: "
        $SUPERVISORD -c /home/webben/supervisord.conf
        echo
        ;;
stop)
        echo -n "Stopping supervisord: "
        $SUPERVISORCTL -c /home/webben/supervisord.conf shutdown
        echo
        ;;
restart)
        echo -n "Stopping supervisord: "
        $SUPERVISORCTL -c /home/webben/supervisord.conf shutdown
        echo
        echo -n "Starting supervisord: "
        $SUPERVISORD -c /home/webben/supervisord.conf
        echo
        ;;
esac
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/目錄下即可

預設日誌檔案:/tmp/supervisord.log ,可以檢視程序的啟動資訊