Ubuntu下Supervisor安裝、配置和使用

本文基本上步驟在Ubuntu 16.04下驗證經過

一、認識supervisor

Supervisor（http://supervisord.org/）是用Python開發的一個client/server服務，是Linux/Unix系統下的一個進程管理工具，不支持Windows系統。它能夠很方便的監聽、啓動、中止、重啓一個或多個進程。用Supervisor管理的進程，當一個進程意外被殺死，supervisort監聽到進程死後，會自動將它從新拉起，很方便的作到進程自動恢復的功能，再也不須要本身寫shell腳原本控制。

二、安裝supervisor

apt-get install supervisor

supervisor安裝完成後會生成三個執行程序：supervisortd、supervisorctl、echo_supervisord_conf，分別是supervisor的守護進程服務（用於接收進程管理命令）、客戶端（用於和守護進程通訊，發送管理進程的指令）、生成初始配置文件程序。

三、配置

使用echo_supervisord_conf生成默認的配置文件

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

 

五、配置管理進程

進程管理配置參數，不建議全都寫在supervisord.conf文件中，應該每一個進程寫一個配置文件放在include指定的目錄下包含進supervisord.conf文件中。 
 修改/etc/supervisor/supervisord.conf中的include參數，將/etc/supervisor/conf.d目錄添加到include中（關於*.ini，大部分資料用的都是*.conf格式做爲配置文件。這個地方建議你們也都用*.conf不要用*.ini）

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

 

下面是配置Tomcat進程的一個例子：

[program:tomcat]
command=/bin/bash -c 'source /var/ftp_root/program/blog/startall.sh'
user=root
autostart=true
autorestart=true
redirect_stderr=True
stdout_logfile=/tmp/blog.log
stderr_logfile=/tmp/blog.err

 

五、啓動Supervisor服務

supervisord -c /etc/supervisor/supervisord.conf

 

六、控制進程

6.1 交互終端

supervisord啓動成功後，能夠經過supervisorctl客戶端控制進程，啓動、中止、重啓。運行supervisorctl命令，不加參數，會進入supervisor客戶端的交互終端，並會列出當前所管理的全部進程。 

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

 
出於安全考慮，默認配置是沒有開啓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端口 ,注意要把127.0.0.1修改爲0.0.0.0,不然外網訪問不了。
username：登陸管理後臺的用戶名 
password：登陸管理後臺的密碼

七、開機啓動Supervisor服務

7.1 配置systemctl服務

1> 進入/lib/systemd/system目錄，查看是否有supervisor.service文件,若沒有建立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> 設置開機啓動

chmod 766 supervisor.service
systemctl enable supervisor.service
systemctl daemon-reload

 

七、注意點：

1>關於在command中，執行.sh腳本
請參照此配置文件中command的寫法，直接寫command=source xxx，會報source不認識：

[program:blog]
command=/bin/bash -c 'source /var/ftp_root/program/blog/startall.sh'
user=root
autostart=true
autorestart=true
redirect_stderr=True
stdout_logfile=/tmp/blog.log
stderr_logfile=/tmp/blog.err
stopasgroup=true
killasgroup=true

2.關於supervisorctl的使用

1)、修改好配置文件後

supervisorctl reread
supervisorctl update

 

2)、更新新的配置到supervisord    

supervisorctl update  

3)、從新啓動配置中的全部程序

supervisorctl reload  

4)、啓動某個進程(program_name=你配置中寫的程序名稱)

supervisorctl start program_name  

5)、查看正在守候的進程

supervisorctl  

6)、中止某一進程 (program_name=你配置中寫的程序名稱)

pervisorctl stop program_name  

7)、重啓某一進程 (program_name=你配置中寫的程序名稱)

supervisorctl restart program_name  

8)、中止所有進程

supervisorctl stop all  

注意：顯示用stop中止掉的進程，用reload或者update都不會自動重啓。

3）錯誤 - Error no log file
檢查本身增長的程序配置文件中，是否增長了log的配置，沒有的話，要加上。

stdout_logfile=/tmp/blog.log
stderr_logfile=/tmp/blog.err

再介紹兩個配置項 stopasgroup 和 killasgroup

stopasgroup; 默認爲 false，若是設置爲 true，當進程收到 stop 信號時，會自動將該信號發給該進程的子進程。若是這個配置項爲 true，那麼也隱含 killasgroup 爲 true。例如在 Debug 模式使用 Flask 時，Flask 不會將接收到的 stop 信號也傳遞給它的子進程，所以就須要設置這個配置項。
stopasgroup=false       ; send stop signal to the UNIX process 

killasgroup; 默認爲 false，若是設置爲 true，當進程收到 kill 信號時，會自動將該信號發給該進程的子進程。若是這個程序使用了 python 的 multiprocessing 時，就能自動中止它的子線程。
killasgroup=false       ; SIGKILL the UNIX process group (def false)

參考引用：

http://blog.csdn.net/xyang81/article/details/51555473

http://blog.csdn.net/shudaqi2010/article/details/51153961

每一個選項詳細設置：http://www.jb51.net/article/92792.htm