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)
1 easy_install是setuptools包里帶的一個命令,使用easy_install實際上是在調用setuptools來完成安裝模塊的工作,所以安裝setuptools即可。 2 get --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
6、啟動Supervisor服務
1 supervisord -c /etc/supervisor/supervisord.conf
7、控制進程
supervisord啟動成功后,可以通過supervisorctl客戶端控制進程,啟動、停止、重啟。運行supervisorctl命令,不加參數,會進入supervisor客戶端的交互終端,並會列出當前所管理的所有進程。
8、bash終端
1 supervisorctl status 2 supervisorctl stop celeryd 3 supervisorctl start celeryd 4 supervisorctl restart celeryd 5 supervisorctl reread 6 supervisorctl update
9、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))
change:
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:登錄管理后台的密碼
10、開機啟動Supervisor服務
10.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
10.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