一、supervisor簡介

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

注：本文以centos7為例，supervisor版本3.4.0。

二、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
   

三、supervisor使用

supervisor配置檔案：/etc/supervisord.conf

注：supervisor的配置檔案預設是不全的，不過在大部分預設的情況下，上面說的基本功能已經滿足。

子程序配置檔案路徑：/etc/supervisord.d/

注：預設子程序配置檔案為ini格式，可在supervisor主配置檔案中修改。

四、配置檔案說明

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 = 20MB
#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  

五、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.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相關的程序。