Supervisor使用

1、supervisor簡介

Supervisor是用Python開發的一套通用的進程管理程序，能將一個普通的命令行進程變爲後臺daemon，並監控進程狀態，異常退出時能自動重啓。它是經過fork/exec的方式把這些被管理的進程看成supervisor的子進程來啓動，這樣只要在supervisor的配置文件中，把要管理的進程的可執行文件的路徑寫進去便可。也實現當子進程掛掉的時候，父進程能夠準確獲取子進程掛掉的信息的，能夠選擇是否本身啓動和報警。supervisor還提供了一個功能，能夠爲supervisord或者每一個子進程，設置一個非root的user，這個user就能夠管理它對應的進程。

注：本文以centos7爲例。

2、supervisor安裝

1. 配置好yum源後，能夠直接安裝

   yum install supervisor

2. Debian/Ubuntu可經過apt安裝

   apt-get install supervisor 

3. pip安裝

   pip install supervisor

4. easy_install安裝

   easy_install supervisor

3、supervisor使用

supervisor配置文件：/etc/supervisord.conf

*注：supervisor的配置文件默認是不全的，不過在大部分默認的狀況下，上面說的基本功能已經知足。*

子進程配置文件路徑：/etc/supervisord.d/

*注：默認子進程配置文件爲ini格式，可在supervisor主配置文件中修改。*

4、配置文件說明

supervisor.conf配置文件說明：

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

子進程配置文件說明：

給須要管理的子進程(程序)編寫一個配置文件，放在/etc/supervisor.d/目錄下，以.ini做爲擴展名（每一個進程的配置文件均可以單獨分拆也能夠把相關的腳本放一塊兒）。如任意定義一個和腳本相關的項目名稱的選項組（/etc/supervisord.d/test.conf）：

#項目名 [program:blog] #腳本目錄 directory=/opt/bin #腳本執行命令 command=/usr/bin/python /opt/bin/test.py #supervisor啓動的時候是否隨着同時啓動，默認True autostart=true #當程序exit的時候，這個program不會自動重啓,默認unexpected，設置子進程掛掉後自動重啓的狀況，有三個選項，false,unexpected和true。若是爲false的時候，不管什麼狀況下，都不會被從新啓動，若是爲unexpected，只有當進程的退出碼不在下面的exitcodes裏面定義的 autorestart=false #這個選項是子進程啓動多少秒以後，此時狀態若是是running，則咱們認爲啓動成功了。默認值爲1 startsecs=1 #腳本運行的用戶身份 user = test #日誌輸出 stderr_logfile=/tmp/blog_stderr.log stdout_logfile=/tmp/blog_stdout.log #把stderr重定向到stdout，默認 false redirect_stderr = true #stdout日誌文件大小，默認 50MB stdout_logfile_maxbytes = 20M #stdout日誌文件備份數 stdout_logfile_backups = 20 

子進程配置示例：

#說明同上
[program:test] 
directory=/opt/bin 
command=/opt/bin/test
autostart=true 
autorestart=false 
stderr_logfile=/tmp/test_stderr.log 
stdout_logfile=/tmp/test_stdout.log 
#user = test

5、supervisor命令說明

經常使用命令

supervisorctl status        //查看全部進程的狀態
supervisorctl stop es       //中止es
supervisorctl start es      //啓動es
supervisorctl restart       //重啓es
supervisorctl update        //配置文件修改後使用該命令加載新的配置
supervisorctl reload        //從新啓動配置中的全部程序

注：把es換成all能夠管理配置中的全部進程。直接輸入supervisorctl進入supervisorctl的shell交互界面，此時上面的命令不帶supervisorctl可直接使用。

注意事項

使用supervisor進程管理命令以前先啓動supervisord，不然程序報錯。
使用命令supervisord -c /etc/supervisord.conf啓動。
如果centos7：

systemctl start supervisord.service     //啓動supervisor並加載默認配置文件
systemctl enable supervisord.service    //將supervisor加入開機啓動項

常見問題

1. unix:///var/run/supervisor/supervisor.sock no such file
   問題描述：安裝好supervisor沒有開啓服務直接使用supervisorctl報的錯
   解決辦法：supervisord -c /etc/supervisord.conf

2. command中指定的進程已經起來，但supervisor還不斷重啓
   問題描述：command中啓動方式爲後臺啓動，致使識別不到pid，而後不斷重啓，這裏使用的是elasticsearch，command指定的是$path/bin/elasticsearch -d 
   解決辦法：supervisor沒法檢測後臺啓動進程的pid，而supervisor自己就是後臺啓動守護進程，所以不用擔憂這個

3. 啓動了多個supervisord服務，致使沒法正常關閉服務
   問題描述：在運行supervisord -c /etc/supervisord.conf以前，直接運行過supervisord -c /etc/supervisord.d/xx.conf致使有些進程被多個superviord管理，沒法正常關閉進程。
   解決辦法：使用ps -fe | grep supervisord查看全部啓動過的supervisord服務，kill相關的進程。