Supervisor使用詳解


一、supervisor簡介

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

 

二、supervisor安裝

1、配置好apt-get源后,可以直接安裝

apt-get install supervisor

2、pip安裝

pip install supervisor

3、easy_install安裝

easy_install supervisor

三、supervisor使用

創建目錄,初始化配置文件
mkdir /etc/supervisor/
echo_supervisord_conf > /etc/supervisor/supervisord.conf

*注:1、為了不將所有新增配置信息全寫在一個配置文件里,這里新建一個文件夾
    mkdir /etc/supervisor/conf.d/
   2、修改系統配置文件
    vim /etc/supervisor/supervisord.conf
   3、include 2.1中新建的conf.d文件夾下所有的conf
    [include]
    files = /etc/supervisor/conf.d/*.conf
 
supervisor配置文件:/etc/supervisor/supervisord.conf
*注:supervisor的配置文件默認是不全的,不過在大部分默認的情況下,上面說的基本功能已經滿足。*       
子進程配置文件路徑:/etc/supervisor/supervisord.d/
*注:默認子進程配置文件為ini格式,可在supervisor主配置文件中修改。*        

四、配置文件說明

supervisor.conf配置文件說明:

 1 [unix_http_server]
 2 file=/tmp/supervisor.sock   ;UNIX socket 文件,supervisorctl 會使用
 3 ;chmod=0700                 ;socket文件的mode,默認是0700
 4 ;chown=nobody:nogroup       ;socket文件的owner,格式:uid:gid
 5  
 6 ;[inet_http_server]         ;HTTP服務器,提供web管理界面
 7 ;port=127.0.0.1:9001        ;Web管理后台運行的IP和端口,如果開放到公網,需要注意安全性
 8 ;username=user              ;登錄管理后台的用戶名
 9 ;password=123               ;登錄管理后台的密碼
10  
11 [supervisord]
12 logfile=/tmp/supervisord.log ;日志文件,默認是 $CWD/supervisord.log
13 logfile_maxbytes=50MB        ;日志文件大小,超出會rotate,默認 50MB,如果設成0,表示不限制大小
14 logfile_backups=10           ;日志文件保留備份數量默認10,設為0表示不備份
15 loglevel=info                ;日志級別,默認info,其它: debug,warn,trace
16 pidfile=/tmp/supervisord.pid ;pid 文件
17 nodaemon=false               ;是否在前台啟動,默認是false,即以 daemon 的方式啟動
18 minfds=1024                  ;可以打開的文件描述符的最小值,默認 1024
19 minprocs=200                 ;可以打開的進程數的最小值,默認 200
20  
21 [supervisorctl]
22 serverurl=unix:///tmp/supervisor.sock ;通過UNIX socket連接supervisord,路徑與unix_http_server部分的file一致
23 ;serverurl=http://127.0.0.1:9001 ; 通過HTTP的方式連接supervisord
24  
25 ; [program:xx]是被管理的進程配置參數,xx是進程的名稱
26 [program:xx]
27 command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run  ; 程序啟動命令
28 autostart=true       ; 在supervisord啟動的時候也自動啟動
29 startsecs=10         ; 啟動10秒后沒有異常退出,就表示進程正常啟動了,默認為1秒
30 autorestart=true     ; 程序退出后自動重啟,可選值:[unexpected,true,false],默認為unexpected,表示進程意外殺死后才重啟
31 startretries=3       ; 啟動失敗自動重試次數,默認是3
32 user=tomcat          ; 用哪個用戶啟動進程,默認是root
33 priority=999         ; 進程啟動優先級,默認999,值小的優先啟動
34 redirect_stderr=true ; 把stderr重定向到stdout,默認false
35 stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小,默認50MB
36 stdout_logfile_backups = 20   ; stdout 日志文件備份數,默認是10
37 ; stdout 日志文件,需要注意當指定目錄不存在時無法正常啟動,所以需要手動創建目錄(supervisord 會自動創建日志文件)
38 stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
39 stopasgroup=false     ;默認為false,進程被殺死時,是否向這個進程組發送stop信號,包括子進程
40 killasgroup=false     ;默認為false,向進程組發送kill信號,包括子進程
41  
42 ;包含其它配置文件
43 [include]
44 files = relative/directory/*.ini    ;可以指定一個或多個以.ini結束的配置文件

子進程配置文件說明:

給需要管理的子進程(程序)編寫一個配置文件,放在/etc/supervisor/conf.d/目錄下,以.ini作為擴展名(每個進程的配置文件都可以單獨分拆也可以把相關的腳本放一起)。如任意定義一個和腳本相關的項目名稱的選項組(/etc/supervisor/conf.d/test.conf)

 1 #項目名
 2 [program:blog]
 3 #腳本目錄
 4 directory=/opt/bin
 5 #腳本執行命令
 6 command=/usr/bin/python /opt/bin/test.py
 7 
 8 #supervisor啟動的時候是否隨着同時啟動,默認True
 9 autostart=true
10 #當程序exit的時候,這個program不會自動重啟,默認unexpected,設置子進程掛掉后自動重啟的情況,有三個選項,false,unexpected和true。如果為false的時候,無論什么情況下,都不會被重新啟動,如果為unexpected,只有當進程的退出碼不在下面的exitcodes里面定義的
11 autorestart=false
12 #這個選項是子進程啟動多少秒之后,此時狀態如果是running,則我們認為啟動成功了。默認值為1
13 startsecs=1
14 
15 #腳本運行的用戶身份 
16 user = test
17 
18 #日志輸出 
19 stderr_logfile=/tmp/blog_stderr.log 
20 stdout_logfile=/tmp/blog_stdout.log 
21 #把stderr重定向到stdout,默認 false
22 redirect_stderr = true
23 #stdout日志文件大小,默認 50MB
24 stdout_logfile_maxbytes = 20M
25 #stdout日志文件備份數
26 stdout_logfile_backups = 20
子進程配置示例:

[program:test_one]
command=java -jar /data/smallvideo/supervisor/taskApp-exec.jar TaskTestOne ; 被監控的進程路徑
priority=1 ; 數字越高,優先級越高
numprocs=1 ; 啟動幾個進程
autostart=true ; 隨着supervisord的啟動而啟動
autorestart=true ; 自動重啟
startretries=10 ; 啟動失敗時的最多重試次數
exitcodes=0 ; 正常退出代碼
stopsignal=KILL ; 用來殺死進程的信號
stopwaitsecs=10 ; 發送SIGKILL前的等待時間
redirect_stderr=true ; 重定向stderr到stdout

[program:test_two]
command=java -jar /data/smallvideo/supervisor/taskApp-exec.jar TaskTestTwo ; 被監控的進程路徑
priority=1 ; 數字越高,優先級越高
numprocs=1 ; 啟動幾個進程
autostart=true ; 隨着supervisord的啟動而啟動
autorestart=true ; 自動重啟
startretries=10 ; 啟動失敗時的最多重試次數
exitcodes=0 ; 正常退出代碼
stopsignal=KILL ; 用來殺死進程的信號
stopwaitsecs=10 ; 發送SIGKILL前的等待時間
redirect_stderr=true ; 重定向stderr到stdout

 

 

五、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/supervisor/supervisord.conf啟動。
若是centos7

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

若是Ubuntu

1.在/lib/systemd/system/中添加supervisord.service文件
[Unit]
Description=Supervisord Service

[Service]
Restart=on-failure
RestartSec=42s
User=myuser
ExecStart=/home/myuser/.pyenv/versions/3.6.8/bin/supervisord -n -c /home/myuser/etc/supervisord.conf

[Install]

User替換成你的用戶名,ExecStart 命令中supervisord的路徑替換成你自己的路徑 supervisord.conf同樣替換成你自己的配置路徑,常用路徑是/etc/supervisord.conf,因權限問題我在用戶目錄里添加了配置。

2.執行如下命令
sudo systemctl daemon-reload

sudo systemctl enable supervisord.service

sudo systemctl start supervisord.service
3.最后重啟就可以看到,supervisor已經自啟動

  

常見問題
  1. unix:///var/run/supervisor/supervisor.sock no such file
    問題描述:安裝好supervisor沒有開啟服務直接使用supervisorctl報的錯
    解決辦法:supervisord -c /etc/supervisor/supervisord.conf
  2. command中指定的進程已經起來,但supervisor還不斷重啟
    問題描述:command中啟動方式為后台啟動,導致識別不到pid,然后不斷重啟,這里使用的是elasticsearch,command指定的是$path/bin/elasticsearch -d
    解決辦法:supervisor無法檢測后台啟動進程的pid,而supervisor本身就是后台啟動守護進程,因此不用擔心這個
  3. 啟動了多個supervisord服務,導致無法正常關閉服務
    問題描述:在運行supervisord -c /etc/supervisor/supervisord.conf之前,直接運行過supervisord -c /etc/supervisor/conf.d/xx.conf導致有些進程被多個superviord管理,無法正常關閉進程。
    解決辦法:使用ps -fe | grep supervisord查看所有啟動過的supervisord服務,kill相關的進程。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM