使用 supervisor 管理進程


原文鏈接:http://blog.csdn.net/xyang81/article/details/51555473

Supervisor(http://supervisord.org/)是用Python開發的一個client/server服務,是Linux/Unix系統下的一個進程管理工具,不支持Windows系統。它可以很方便的監聽、啟動、停止、重啟一個或多個進程。用Supervisor管理的進程,當一個進程意外被殺死,supervisort監聽到進程死后,會自動將它重新拉起,很方便的做到進程自動恢復的功能,不再需要自己寫shell腳本來控制。

因為Supervisor是Python開發的,安裝前先檢查一下系統否安裝了Python2.4以上版本。下面以CentOS7,Python2.7版本環境下,介紹Supervisor的安裝與配置步聚:

1、安裝Python包管理工具(easy_install

easy_install是setuptools包里帶的一個命令,使用easy_install實際上是在調用setuptools來完成安裝模塊的工作,所以安裝setuptools即可。
wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python

2、安裝supervisor

easy_install supervisor

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

3、配置

運行supervisord服務的時候,需要指定supervisor配置文件,如果沒有顯示指定,默認在以下目錄查找:

  1. $CWD/supervisord.conf
  2. $CWD/etc/supervisord.conf
  3. /etc/supervisord .conf
  4. /etc/supervisor/supervisord .conf (since Supervisor 3.3.0)
  5. ../etc/supervisord .conf (Relative to the executable)
  6. ../supervisord .conf (Relative to the executable)

 

$CWD表示運行supervisord程序的目錄。

可以通過運行echo_supervisord_conf程序生成supervisor的初始化配置文件,如下所示:

  1. mkdir /etc/supervisor
  2. echo_supervisord_conf > /etc/supervisor/supervisord.conf

 

4、配置文件參數說明

supervisor的配置參數較多,下面介紹一下常用的參數配置,詳細的配置及說明,請參考官方文檔介紹。 
注:分號(;)開頭的配置表示注釋

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

 

include示例:

  1. [ include]
  2. files = /opt/absolute/filename.ini /opt/absolute/*.ini foo.conf config??.ini

 

5、配置管理進程

進程管理配置參數,不建議全都寫在supervisord.conf文件中,應該每個進程寫一個配置文件放在include指定的目錄下包含進supervisord.conf文件中。 
1> 創建/etc/supervisor/config.d目錄,用於存放進程管理的配置文件 
2> 修改/etc/supervisor/supervisord.conf中的include參數,將/etc/supervisor/conf.d目錄添加到include中

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

 

supervisor配置文件目錄結構

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

  1. [program:tomcat]
  2. command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run
  3. stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
  4. autostart=true
  5. autorestart=true
  6. startsecs=5
  7. priority=1
  8. stopasgroup=true
  9. killasgroup=true

 

5、啟動Supervisor服務

supervisord -c /etc/supervisor/supervisord.conf

 

6、控制進程

6.1 交互終端

supervisord啟動成功后,可以通過supervisorctl客戶端控制進程,啟動、停止、重啟。運行supervisorctl命令,不加參數,會進入supervisor客戶端的交互終端,並會列出當前所管理的所有進程。 
supervisorctl

上圖中的tomcat就是我們在配置文件中[program:tomcat]指定的名字。 

輸入help可以查看可以執行的命令列表,如果想看某個命令的作用,運行help 命令名稱,如:help stop

  1. stop tomcat // 表示停止tomcat進程
  2. stop all // 表示停止所有進程
  3. // ...

 

6.2 bash終端

  1. supervisorctl status
  2. supervisorctl stop tomcat
  3. supervisorctl start tomcat
  4. supervisorctl restart tomcat
  5. supervisorctl reread
  6. supervisorctl update

 

6.3 Web管理界面

Supervisor Web管理界面 
出於安全考慮,默認配置是沒有開啟web管理界面,需要修改supervisord.conf配置文件打開http訪權限,將下面的配置:

  1. ;[inet_http_server] ; inet (TCP) server disabled by default
  2. ; port=127.0.0.1:9001 ; (ip_address:port specifier, *:port for all iface)
  3. ;username=user ; ( default is no username (open server))
  4. ;password= 123 ; (default is no password (open server))

 

修改成:

  1. [inet_http_server] ; inet (TCP) server disabled by default
  2. port=0.0.0.0:9001 ; (ip_address:port specifier, *:port for all iface)
  3. username=user ; ( default is no username (open server))
  4. password= 123 ; (default is no password (open server))

 

port:綁定訪問IP和端口,這里是綁定的是本地IP和9001端口 
username:登錄管理后台的用戶名 
password:登錄管理后台的密碼

7、開機啟動Supervisor服務

7.1 配置systemctl服務

1> 進入/lib/systemd/system目錄,並創建supervisor.service文件

  1. [Unit]
  2. Description=supervisor
  3. After=network.target
  4.  
  5. [Service]
  6. Type=forking
  7. ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
  8. ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown
  9. ExecReload=/usr/bin/supervisorctl $OPTIONS reload
  10. KillMode=process
  11. Restart=on-failure
  12. RestartSec=42s
  13.  
  14. [Install]
  15. WantedBy=multi-user.target

2> 設置開機啟動

  1. systemctl enable supervisor.service
  2. systemctl daemon-reload

 

3、修改文件權限為766

chmod 766 supervisor.service

 

7.2 配置service類型服務

  1. #!/bin/bash
  2. #
  3. # supervisord This scripts turns supervisord on
  4. #
  5. # Author: Mike McGrath <mmcgrath@redhat.com> (based off yumupdatesd)
  6. #
  7. # chkconfig: - 95 04
  8. #
  9. # description: supervisor is a process control utility. It has a web based
  10. # xmlrpc interface as well as a few other nifty features.
  11. # processname: supervisord
  12. # config: /etc/supervisor/supervisord.conf
  13. # pidfile: /var/run/supervisord.pid
  14. #
  15.  
  16. # source function library
  17. . /etc/rc.d/init.d/ functions
  18.  
  19. RETVAL= 0
  20.  
  21. start() {
  22. echo -n $"Starting supervisord: "
  23. daemon "supervisord -c /etc/supervisor/supervisord.conf "
  24. RETVAL=$?
  25. echo
  26. [ $RETVAL -eq 0 ] && touch /var/lock/subsys/supervisord
  27. }
  28.  
  29. stop() {
  30. echo -n $"Stopping supervisord: "
  31. killproc supervisord
  32. echo
  33. [ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/supervisord
  34. }
  35.  
  36. restart() {
  37. stop
  38. start
  39. }
  40.  
  41. case "$1" in
  42. start)
  43. start
  44. ;;
  45. stop)
  46. stop
  47. ;;
  48. restart|force-reload|reload)
  49. restart
  50. ;;
  51. condrestart)
  52. [ -f /var/lock/subsys/supervisord ] && restart
  53. ;;
  54. status)
  55. status supervisord
  56. RETVAL=$?
  57. ;;
  58. *)
  59. echo $"Usage: $0 {start|stop|status|restart|reload|force-reload|condrestart}"
  60. exit 1
  61. esac
  62.  
  63. exit $RETVAL

 

將上述腳本內容保存到/etc/rc.d/init.d/supervisor文件中,修改文件權限為755,並設置開機啟動

  1. chmod 755 /etc/rc.d/init.d/supervisor
  2. chkconfig supervisor on

 

注意:修改腳本中supervisor配置文件路徑為你的supervisor的配置文件路徑

其它Linux發行版開機啟動腳本:https://github.com/Supervisor/initscripts

注意:

Supervisor只能管理非daemon的進程,也就是說Supervisor不能管理守護進程。否則提示Exited too quickly (process log may have details)異常。例子中的Tomcat默認是以守護進程啟動的,所以我們改成了catalina.sh run,以前台進程的方式運行。


yum方式安裝

  1. yum install epel-release
  2. yum install -y supervisor

 

supervisor沒有發布在標准的CentOS源在,需要安裝epel源。這種方式安裝的可能不是最新版本,但比較方便,安裝完成之后,配置文件會自動幫你生成。 
默認配置文件:/etc/supervisord.conf 
進程管理配置文件放到:/etc/supervisord.d/目錄下即可


默認日志文件:/tmp/supervisord.log,可以查看進程的啟動信息

 

 

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 

進程管理supervisor的簡單說明

背景:

      項目中遇到有些腳本需要通過后台進程運行,保證不被異常中斷,之前都是通過nohup、&、screen來實現,帶着能否做一個start/stop/restart/reload的服務啟動的想法找到里Supervisor。關於supervisor的介紹在網上大致搜索總結如下:

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

說明:

1,安裝

復制代碼
1:easy_install 安裝:
easy_install supervisor

2:pip 安裝: pip install supervisor 3:Debian / Ubuntu可以直接通過apt安裝: apt-get install supervisor
復制代碼

2,配置文件

1)通過apt-get install安裝后,supervisor的配置文件在:

/etc/supervisor/supervisord.conf 

supervisor的配置文件默認是不全的,不過在大部分默認的情況下,上面說的基本功能已經滿足。而其管理的子進程配置文件在:

/etc/supervisor/conf.d/*.conf

然后,開始給自己需要的腳本程序編寫一個子進程配置文件,讓supervisor來管理它,放在/etc/supervisor/conf.d/目錄下,以.conf作為擴展名(每個進程的配置文件都可以單獨分拆也可以把相關的腳本放一起)。如任意定義一個和腳本相關的項目名稱的選項組(/etc/supervisor/conf.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 #日志輸出 stderr_logfile=/tmp/blog_stderr.log stdout_logfile=/tmp/blog_stdout.log #腳本運行的用戶身份 user = zhoujy #把 stderr 重定向到 stdout,默認 false redirect_stderr = true #stdout 日志文件大小,默認 50MB stdout_logfile_maxbytes = 20M #stdout 日志文件備份數 stdout_logfile_backups = 20 [program:zhoujy] #說明同上 directory=/opt/bin command=/usr/bin/python /opt/bin/zhoujy.py autostart=true autorestart=false stderr_logfile=/tmp/zhoujy_stderr.log stdout_logfile=/tmp/zhoujy_stdout.log #user = zhoujy  
復制代碼

2)通過easy_install安裝后,配置文件不存在,需要自己導入。

①:運行echo_supervisord_conf打印出一個配置文件的樣本,樣本說明可以看supervisor(一)基礎篇的詳細說明,要是設置樣本為一個配置文件則:

1:運行 echo_supervisord_conf,查看配置樣本: echo_supervisord_conf 2:創建配置文件: echo_supervisord_conf > /etc/supervisord.conf

②:配置子進程配置文件,可以直接在supervisor中的;[program:theprogramname]里設置。

詳細的子進程配置文件:

樣本:

View Code

說明:

View Code

改成自己實際的配置文件:和①上面一樣。

3:運行

1)apt-get install 安裝的supervisor直接可以通過 /etc/init.d/supervisor 運行:

/etc/init.d/supervisor start

2)通過easy_install 安裝的supervisor運行supervisord 運行:

supervisord 

4:web界面操作

需要在supervisor的配置文件里添加[inet_http_server]選項組:之后可以通過http://10.211.55.11:9001來訪問控制子線程的管理。

[inet_http_server]
port=10.211.55.11:9001 username=user password=123

效果:

5:子進程管理(supervisorctl)

1) 查看所有子進程的狀態: 

# supervisorctl status
blog                             RUNNING    pid 2395, uptime 0:08:41 zhoujy RUNNING pid 2396, uptime 0:08:41

2)關閉、開啟指定的子進程:

# supervisorctl stop zhoujy
zhoujy: stopped

# supervisorctl start zhoujy
zhoujy: started

3)關閉、開啟所有的子進程:

# supervisorctl stop all
blog: stopped
zhoujy: stopped
# supervisorctl start all
blog: started
zhoujy: started

4):其他參數:supervisor開啟后子進程自動開啟(autostart=true)和子進程退出后自動啟動(autorestart=ture

更多的參數可以看官方文檔supervisor(一)基礎篇的說明。

總結:

      我們需要的功能在上面介紹的supervisor的基本功能中已經實現,supervisor還有其他的一些功能:如進程組、web頁面管理子進程、監控子線程情況等等,更多的信息可以去官網上查看。

參考文檔:

Supervisor官方文檔

Supervisor(一)基礎篇

Supervisor(二)event

Supervisor(三)xml_rpc


免責聲明!

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



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