supervisor詳解

官網地址：
https://pypi.org/project/supervisor/
http://supervisord.org/
本文參考：https://www.jianshu.com/p/0b9054b33db3

一、supervisor簡介

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

• supervisord
  運行 Supervisor 時會啟動一個進程 supervisord，它負責啟動所管理的進程，並將所管理的進程作為自己的子進程來啟動，而且可以在所管理的進程出現崩潰時自動重啟。
• supervisorctl
  是命令行管理工具，可以用來執行 stop、start、restart 等命令，來對這些子進程進行管理。
  supervisor是所有進程的父進程，管理着啟動的子進程，supervisor以子進程的PID來管理子進程，當子進程異常退出時supervisor可以收到相應的信號量。

二、supervisor安裝

centos/redhat系統中，配置好yum源后，可以直接安裝

yum install supervisor –y 

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

注：生產環境中，配置文件中的monfds這一參數要修改至65536

子進程配置文件說明：

給需要管理的子進程(程序)編寫一個配置文件，放在/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:elasticsearch]
command=/usr/local/elasticsearch-7.1.0/bin/elasticsearch
directory=/usr/local/elasticsearch-7.1.0
autostart=true
autorestart=true
stdout_logfile=/var/log/supervisor/elasticsearch.log
redirect_stderr=true
user=elasticsearch

五、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，否則程序報錯。
centos 7中，使用命令

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

常見問題

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

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相關的進程。