supervisor的安裝部署及集群管理
supervisor官網:http://www.supervisord.org/
參考鏈接:
http://blog.csdn.net/xyang81/article/details/51555473
https://www.cnblogs.com/smail-bao/p/5673434.html
1,介紹
Supervisor是一個進程管理工具,就是有一個進程需要每時每刻不斷的運行,但是這個進程又有可能由於各種原因有可能停止運行。當進程停止運行的時候我們希望能自動重新啟動,Supervisor就可以幫我們實現。Supervisor是用Python開發的,能將一個普通的命令行進程變為后台daemon,並監控進程狀態,異常退出時能自動重啟。它是通過fork/exec的方式把這些被管理的進程當作supervisor的子進程來啟動,這樣只要在supervisor的配置文件中,把要管理的進程的可執行文件的路徑寫進去即可。也實現當子進程掛掉的時候,父進程可以准確獲取子進程掛掉的信息的,可以選擇是否自己啟動和報警。supervisor還提供了一個功能,可以為supervisord或者每個子進程,設置一個非root的user,這個user就可以管理它對應的進程。
supervisor的命令主要有:
supervisord : supervisor的服務器端部分,啟動supervisor就是運行這個命令
supervisorctl:啟動supervisor的命令行窗口。
2.安裝
第一種方法:
pip install supervisor
pip的安裝
cat pip_an.sh #!/bin/bash wget http://pypi.python.org/packages/source/s/setuptools/setuptools-0.6c11.tar.gz tar zxvf setuptools-0.6c11.tar.gz cd setuptools-0.6c11 python setup.py build python setup.py install wget "https://pypi.python.org/packages/source/p/pip/pip-1.5.4.tar.gz#md5=834b2904f92d46aaa33326" tar -xzvf pip-1.5.4.tar.gz cd pip-1.5.4 python setup.py install
第二種
yum install python-setuptools
easy_install supervisor
第三種
wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz tar zxvf supervisor-3.1.3.tar.gz cd supervisor python setup.py install
第四種
yum install -y epel-release
yum install -y supervisor
3.測試
#測試是否安裝成功
echo_supervisord_conf
#創建配置文件
echo_supervisord_conf > /etc/supervisord.conf
4.配置文件講解
1 [root@centos-011 ~ 07:50:00]#cat /etc/supervisord.conf.bak 2 ; Sample supervisor config file. 3 4 [unix_http_server] 5 file=/var/run/supervisor/supervisor.sock ; socket 路徑 6 7 ;chmod=0700 ; socket 文件的權限 8 ;chown=nobody:nogroup ; socket 所屬用戶及組 9 ;username=user ; 用戶名 10 ;password=123 ; 密碼 11 12 ;[inet_http_server] ; 是否啟用服務,默認是關閉的(啟用的話可以看到supervisor 管理的服務狀態) 13 ;port=127.0.0.1:9001 ; 監聽的IP及端口 14 ;username=user ; 用戶名 15 ;password=123 ; 密碼 16 17 [supervisord] ; supervisord 全局配置 18 logfile=/var/log/supervisor/supervisord.log ; supervisor 日志路徑 19 logfile_maxbytes=50MB ; 單個日志文件最大數 20 logfile_backups=10 ; 保留多少個日志文件(默認10個) 21 loglevel=info ; (log level;default info; others: debug,warn,trace) 22 pidfile=/var/run/supervisord.pid ; pid 文件路徑 23 nodaemon=false ; 啟動是否丟到前台,設置為false ,表示以daemon 的方式啟動 24 minfds=1024 ; 最小文件打開數,對應系統limit.conf 中的nofile ,默認最小為1024,最大為4096 25 minprocs=200 ; 最小的進程打開數,對應系統的limit.conf 中的nproc,默認為200 26 ;umask=022 ; (process file creation umask;default 022) 27 ;user=chrism ; 啟動supervisord 服務的用戶,默認為root 28 ;identifier=supervisor ; (supervisord identifier, default is 'supervisor') 29 ;directory=/tmp ; 這里的目錄指的是服務的工作目錄 30 ;nocleanup=true ; (don't clean up tempfiles at start;default false) 31 ;childlogdir=/tmp ; ('AUTO' child log dir, default $TEMP) 32 ;environment=KEY=value ; (key value pairs to add to environment) 33 ;strip_ansi=false ; (strip ansi escape codes in logs; def. false) 34 35 ; the below section must remain in the config file for RPC 36 ; (supervisorctl/web interface) to work, additional interfaces may be 37 ; added by defining them in separate rpcinterface: sections 38 [rpcinterface:supervisor] 39 supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 40 41 [supervisorctl] 42 serverurl=unix:///var/run/supervisor/supervisor.sock ; use a unix:// URL for a unix socket 43 ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket 44 ;username=chris ; should be same as http_username if set 45 ;password=123 ; should be same as http_password if set 46 ;prompt=mysupervisor ; cmd line prompt (default "supervisor") 47 ;history_file=~/.sc_history ; use readline history if available 48 49 ; The below sample program section shows all possible program subsection values, 50 ; create one or more 'real' program: sections to be able to control them under 51 ; supervisor. 52 53 ;[program:theprogramname] ; 定義一個守護進程 ,比如下面的elasticsearch 54 ;command=/bin/cat ; 啟動程序使用的命令,可以是絕對路徑或者相對路徑 55 ;process_name=%(program_name)s ; 一個python字符串表達式,用來表示supervisor進程啟動的這個的名稱,默認值是%(program_name)s 56 ;numprocs=1 ; Supervisor啟動這個程序的多個實例,如果numprocs>1,則process_name的表達式必須包含%(process_num)s,默認是1 57 ;directory=/tmp ; supervisord在生成子進程的時候會切換到該目錄 58 ;umask=022 ; umask for process (default None) 59 ;priority=999 ; 權重,可以控制程序啟動和關閉時的順序,權重越低:越早啟動,越晚關閉。默認值是999 60 ;autostart=true ; 如果設置為true,當supervisord啟動的時候,進程會自動啟動 61 ;autorestart=true ; 設置為隨 supervisord 重啟而重啟,值可以是false、true、unexpected。false:進程不會自動重啟 62 ;startsecs=10 ; 程序啟動后等待多長時間后才認為程序啟動成功,默認是10秒 63 ;startretries=3 ; supervisord嘗試啟動一個程序時嘗試的次數。默認是3 64 ;exitcodes=0,2 ; 一個預期的退出返回碼,默認是0,2。 65 ;stopsignal=QUIT ; 當收到stop請求的時候,發送信號給程序,默認是TERM信號,也可以是 HUP, INT, QUIT, KILL, USR1, or USR2 66 ;stopwaitsecs=10 ; 在操作系統給supervisord發送SIGCHILD信號時等待的時間 67 ;user=chrism ; 如果supervisord以root運行,則會使用這個設置用戶啟動子程序 68 ;redirect_stderr=true ; 如果設置為true,進程則會把標准錯誤輸出到supervisord后台的標准輸出文件描述符 69 ;stdout_logfile=/a/path ; 把進程的標准輸出寫入文件中,如果stdout_logfile沒有設置或者設置為AUTO,則supervisor會自動選擇一個文件位置 70 ;stdout_logfile_maxbytes=1MB ; 標准輸出log文件達到多少后自動進行輪轉,單位是KB、MB、GB。如果設置為0則表示不限制日志文件大小 71 ;stdout_logfile_backups=10 ; 標准輸出日志輪轉備份的數量,默認是10,如果設置為0,則不備份 72 ;stdout_capture_maxbytes=1MB ; 當進程處於stderr capture mode模式的時候,寫入FIFO隊列的最大bytes值,單位可以是KB、MB、GB 73 ;stdout_events_enabled=false ; 如果設置為true,當進程在寫它的stderr 74 ;stderr_logfile=/a/path ; 把進程的錯誤日志輸出一個文件中,除非redirect_stderr參數被設置為true 75 ;stderr_logfile_maxbytes=1MB ; 錯誤log文件達到多少后自動進行輪轉,單位是KB、MB、GB。如果設置為0則表示不限制日志文件大小 76 ;stderr_logfile_backups=10 ; 錯誤日志輪轉備份的數量,默認是10,如果設置為0,則不備份 77 ;stderr_capture_maxbytes=1MB ; 當進程處於stderr capture mode模式的時候,寫入FIFO隊列的最大bytes值,單位可以是KB、MB、GB 78 ;stderr_events_enabled=false ; 如果設置為true,當進程在寫它的stderr到文件描述符的時候,PROCESS_LOG_STDERR事件會被觸發 79 ;environment=A=1,B=2 ; 一個k/v對的list列表 80 ;serverurl=AUTO ; 是否允許子進程和內部的HTTP服務通訊,如果設置為AUTO,supervisor會自動的構造一個url 81 82 ; The below sample eventlistener section shows all possible 83 ; eventlistener subsection values, create one or more 'real' 84 ; eventlistener: sections to be able to handle event notifications 85 ; sent by supervisor. 86 #這個地方是自定義一個守護進程 87 [program:elasticsearch] ; 定義一個守護進程 elasticsearch 88 environment=ES_HOME=/usr/local/elasticsearch ; 設置ES_HOME 環境變量 89 user=elk ; 啟動elasticsearch 的用戶 90 directory=/usr/local/elasticsearch ; 進入到這個目錄中 91 command=/usr/local/elasticsearch/bin/elasticsearch ; 執行啟動命令 92 numprocs=1 ; Supervisor啟動這個程序的多個實例,如果numprocs>1,則process_name的表達式必須包含%(process_num)s,默認是1 93 autostart=true ; 設置為隨 supervisord 啟動而啟動 94 autorestart=true ; 設置為隨 supervisord 重啟而重啟 95 startretries=3 ; 設置elasticsearch 重啟的重試次數 96 priority=1 ; 權重,可以控制程序啟動和關閉時的順序,權重越低:越早啟動,越晚關閉。默認值是999 97 98 ;[eventlistener:theeventlistenername] 99 ;command=/bin/eventlistener ; the program (relative uses PATH, can take args) 100 ;process_name=%(program_name)s ; process_name expr (default %(program_name)s) 101 ;numprocs=1 ; number of processes copies to start (def 1) 102 ;events=EVENT ; event notif. types to subscribe to (req'd) 103 ;buffer_size=10 ; event buffer queue size (default 10) 104 ;directory=/tmp ; directory to cwd to before exec (def no cwd) 105 ;umask=022 ; umask for process (default None) 106 ;priority=-1 ; the relative start priority (default -1) 107 ;autostart=true ; start at supervisord start (default: true) 108 ;autorestart=unexpected ; restart at unexpected quit (default: unexpected) 109 ;startsecs=10 ; number of secs prog must stay running (def. 1) 110 ;startretries=3 ; max # of serial start failures (default 3) 111 ;exitcodes=0,2 ; 'expected' exit codes for process (default 0,2) 112 ;stopsignal=QUIT ; signal used to kill process (default TERM) 113 ;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10) 114 ;user=chrism ; setuid to this UNIX account to run the program 115 ;redirect_stderr=true ; redirect proc stderr to stdout (default false) 116 ;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO 117 ;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB) 118 ;stdout_logfile_backups=10 ; # of stdout logfile backups (default 10) 119 ;stdout_events_enabled=false ; emit events on stdout writes (default false) 120 ;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO 121 ;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB) 122 ;stderr_logfile_backups ; # of stderr logfile backups (default 10) 123 ;stderr_events_enabled=false ; emit events on stderr writes (default false) 124 ;environment=A=1,B=2 ; process environment additions 125 ;serverurl=AUTO ; override serverurl computation (childutils) 126 127 ; The below sample group section shows all possible group values, 128 ; create one or more 'real' group: sections to create "heterogeneous" 129 ; process groups. 130 131 ;[group:thegroupname] ; 服務組管理,可以將多個服務名寫到這里管理(組名自定義) 132 ;programs=progname1,progname2 ; 上面配置好的服務名,比如elasticsearch,kibana,logstash 133 ;priority=999 ; the relative start priority (default 999) 134 135 ; The [include] section can just contain the "files" setting. This 136 ; setting can list multiple files (separated by whitespace or 137 ; newlines). It can also contain wildcards. The filenames are 138 ; interpreted as relative to this file. Included files *cannot* 139 ; include files themselves. 140 141 [include] 142 files = supervisord.d/*.ini
5.web界面配置
需要在supervisor的配置文件里添加[inet_http_server]選項組:之后可以通過http://ip:9001來訪問控制子線程的管理。
[inet_http_server] port=159.45.67.89:9001 username=user password=123
6.配置管理進程
進程管理配置參數,不建議全都寫在supervisord.conf文件中,應該每個進程寫一個配置文件放在include指定的目錄下包含進supervisord.conf文件中。
1> 創建/etc/supervisor/config.d目錄,用於存放進程管理的配置文件
2> 修改/etc/supervisor/supervisord.conf中的include參數,將/etc/supervisor/conf.d目錄添加到include中
[include] files = /etc/supervisor/config.d/*.ini
下面是配置Tomcat進程的一個例子:
[program:tomcat] command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out autostart=true autorestart=true startsecs=5 priority=1 stopasgroup=true killasgroup=true
7.啟動Supervisor服務
supervisord -c /etc/supervisor/supervisord.conf
8.控制進程
8.1 交互終端
supervisord啟動成功后,可以通過supervisorctl客戶端控制進程,啟動、停止、重啟。運行supervisorctl命令,不加參數,會進入supervisor客戶端的交互終端,並會列出當前所管理的所有進程。
上圖中的tomcat就是我們在配置文件中[program:tomcat]指定的名字。
stop tomcat // 表示停止tomcat進程
stop all // 表示停止所有進程
// ...
8.2 bash終端
supervisorctl status
supervisorctl stop tomcat
supervisorctl start tomcat
supervisorctl restart tomcat
supervisorctl reread
supervisorctl update
8.3 Web管理界面
1.瀏覽器輸入http://ip:9001訪問
2.supervisor的最終界面如下
9.開機啟動Supervisor服務
9.1 配置systemctl服務
1> 進入/lib/systemd/system目錄,並創建supervisord.service文件
[Unit] Description=supervisor After=network.target [Service] Type=forking ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown ExecReload=/usr/bin/supervisorctl $OPTIONS reload KillMode=process Restart=on-failure RestartSec=42s [Install] WantedBy=multi-user.target
2> 設置開機啟動
systemctl daemon-reload
systemctl enable supervisord.service
3> 修改文件權限為766
chmod 766 supervisord.service
9.2 配置service類型服務
#!/bin/bash # # supervisord This scripts turns supervisord on # # Author: Mike McGrath <mmcgrath@redhat.com> (based off yumupdatesd) # # chkconfig: - 95 04 # # description: supervisor is a process control utility. It has a web based # xmlrpc interface as well as a few other nifty features. # processname: supervisord # config: /etc/supervisor/supervisord.conf # pidfile: /var/run/supervisord.pid # # source function library . /etc/rc.d/init.d/functions RETVAL=0 start() { echo -n $"Starting supervisord: " daemon "supervisord -c /etc/supervisor/supervisord.conf " RETVAL=$? echo [ $RETVAL -eq 0 ] && touch /var/lock/subsys/supervisord } stop() { echo -n $"Stopping supervisord: " killproc supervisord echo [ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/supervisord } restart() { stop start } case "$1" in start) start ;; stop) stop ;; restart|force-reload|reload) restart ;; condrestart) [ -f /var/lock/subsys/supervisord ] && restart ;; status) status supervisord RETVAL=$? ;; *) echo $"Usage: $0 {start|stop|status|restart|reload|force-reload|condrestart}" exit 1 esac exit $RETVAL
將上述腳本內容保存到/etc/rc.d/init.d/supervisor文件中,修改文件權限為755,並設置開機啟動
chmod 755 /etc/rc.d/init.d/supervisord chkconfig supervisor on
注意:
Supervisor只能管理非daemon的進程,也就是說Supervisor不能管理守護進程。否則提示Exited too quickly (process log may have details)異常。例子中的Tomcat默認是以守護進程啟動的,所以我們改成了catalina.sh run,以前台進程的方式運行。
10. 集群管理
supervisor不支持跨機器的進程監控,一個supervisord只能監控本機上的程序,大大限制了supervisor的使用。
不過由於supervisor本身支持xml-rpc,因此也有一些基於supervisor二次開發的多機器進程管理工具。比如:
- Django-Dashvisor
Web-based dashboard written in Python. Requires Django 1.3 or 1.4. - Nodervisor
Web-based dashboard written in Node.js. - Supervisord-Monitor
Web-based dashboard written in PHP. - SupervisorUI
Another Web-based dashboard written in PHP. - cesi
cesi is a web interface provides manage supervizors from same interface.
10.1使用cesi管理
原文:https://github.com/Gamegos/cesi/blob/master/README.md
(1)安裝依賴
yum install -y sqlite3 python python-flask
(2)從github中clone
cd /opt
git clone https://github.com/Gamegos/cesi
(3)安裝
python setup.py build
python setup.py install
(4)導入數據庫
mkdir path/to -p
sqlite3 path/to/userinfo.db < userinfo.sql
(5)復制配置文件
cp cesi.conf /etc/cesi.conf
(6)修改配置文件
vim /etc/cesi.conf
[node:local] username = user password = 123 host = xxxx.xxxx.xxxx.xxx port = 9001 ;[node:<node_name2>] ;username = <username> ;password = <password> ;host = <hostname> ;port = <port> ;[environment:<environment_name>] ;members = <node_name>, <node_name2> [cesi] database = /opt/cesi/path/to/userinfo.db activity_log = /opt/cesi/cesi.log host = xxxx.xxxx.xxxx.xxxx
(8)啟動並訪問
cd /opt/cesi/cesi
python web.py
地址:http://ip:5000 Username : admin Password : admin
2.加入后台
安裝screen:yum install -y screen
進入screen:screen
執行:python web.py
退出screen:按ctrl+a+d退出
3.最后的界面展示
cesi主界面
cesi repo上的示例效果: