supervisor 介紹
supervisor是用python開發(fā)的通用進(jìn)程(不僅僅是python進(jìn)程)管理程序击敌,其可以將普通的命令行進(jìn)程轉(zhuǎn)變?yōu)楹笈_daemon(守護(hù)進(jìn)程)罚斗,監(jiān)控進(jìn)程狀態(tài)财破,當(dāng)進(jìn)程異常退出時可自動重啟扼倘。
注意!注意牲迫!后方高能報警中~~~
====》Supervisor只能管理非daemon的進(jìn)程验游,也就是說Supervisor不能管理守護(hù)進(jìn)程。否則提示Exited too quickly (process log may have details)異常泄隔。
supervisor 原理
supervisor通過fork/exec來將被管理進(jìn)程當(dāng)作自己的子進(jìn)程來啟動(只需在supervisor的配置文件中機(jī)上進(jìn)程可執(zhí)行文件路徑即可)拒贱。當(dāng)子進(jìn)程異常時,父進(jìn)程可以準(zhǔn)確獲取子進(jìn)程掛掉的信息,可以選擇自己啟動或者報警逻澳。
Supervisor管理進(jìn)程狀態(tài)轉(zhuǎn)換圖
說明:
- running:進(jìn)程處于運行狀態(tài)
- starting:Supervisor 收到啟動請求后闸天,進(jìn)程處于正在啟動過程中
- stopped:進(jìn)程處于關(guān)閉狀態(tài)
- stopping:Supervisor 收到關(guān)閉請求后,進(jìn)程處于正在關(guān)閉過程中
- backoff:進(jìn)程進(jìn)入 starting 狀態(tài)后斜做,由于馬上就退出導(dǎo)致沒能進(jìn)入 running 狀態(tài)
- fatal:進(jìn)程沒有正常啟動
- exited:進(jìn)程從 running 狀態(tài)退出
以下步驟均是在ubuntu中實踐的結(jié)果苞氮,可放一億個心好好參考~~~??
supervisor 安裝
# 安裝
apt install supervisor
# 拓展:卸載
apt remove supervisor
安裝成功后,可以確認(rèn)以下兩點:
-
在/etc/下會生成一個supervisor配置目錄:/etc/supervisor
圖片.png supervisor已成功運行
# 查看supervisor進(jìn)程的命令
ps -ef | grep supervisor
# 啟動supervisor
supervisord
拓展:supervisor安裝完成后會生成三個執(zhí)行程序:
1)supervisord :守護(hù)進(jìn)程服務(wù)(用來接收進(jìn)程管理命令)
2)supervisorctl :客戶端(用來和守護(hù)進(jìn)程通信陨享,發(fā)送管理進(jìn)程的命令)
3)echo_supervisord_conf :生成初始配置文件程序
supervisor總配置:supervisord.conf
安裝成功后葱淳,在/etc/supervisor目錄下钝腺,會生成supervisord.conf配置文件抛姑,內(nèi)容如下所示:
; supervisor config file
[unix_http_server]
file=/var/run/supervisor.sock ; (the path to the socket file)
chmod=0700 ; sockef file mode (default 0700)
[supervisord]
logfile=/var/log/supervisor/supervisord.log ; (main log file;default $CWD/supervisord.log)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
childlogdir=/var/log/supervisor ; ('AUTO' child log dir, default $TEMP)
; the below section must remain in the config file for RPC
; (supervisorctl/web interface) to work, additional interfaces may be
; added by defining them in separate rpcinterface: sections
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]
serverurl=unix:///var/run/supervisor.sock ; use a unix:// URL for a unix socket
; The [include] section can just contain the "files" setting. This
; setting can list multiple files (separated by whitespace or
; newlines). It can also contain wildcards. The filenames are
; interpreted as relative to this file. Included files *cannot*
; include files themselves.
[include]
files = /etc/supervisor/conf.d/*.conf
當(dāng)然,若您在/etc/supervisor目錄下未發(fā)現(xiàn)supervisord.conf文件艳狐,可以選擇在/etc/supervisor目錄下手動創(chuàng)建supervisord.conf定硝,方法有兩種:
1) (內(nèi)容比較簡潔,推薦~~~)手動創(chuàng)建supervisord.conf文件毫目,然后完全copy我上面貼出來的內(nèi)容即可蔬啡;
2) 內(nèi)容比較多,不推薦~~~)使用supervisor內(nèi)置生成配置文件的命令镀虐,生成默認(rèn)配置文件箱蟆,命令如下:
# 生成默認(rèn)配置文件
echo_supervisord_conf > supervisord.conf
supervisor 進(jìn)程管理配置
一般地,進(jìn)程管理配置參數(shù)刮便,不建議都寫在supervisord.conf文件中空猜,應(yīng)該每個進(jìn)程寫一個配置文件:*.conf(文件放在include指定地目錄下)。
配置文件內(nèi)容格式如下:
[program:minibreakpad] //進(jìn)程名稱
directory = /root/error/mini-breakpad-server //程序的啟動目錄
command = node lib/app.js //啟動命令 autostart = true //在supervisord 啟動的時候也自動啟動
startsecs = 5 //啟動5秒后沒有退出就當(dāng)做已經(jīng)正常啟動
autostart = true // 自動啟動
autorestart = true //程序異常退出后自動重啟
startretries = 5 //啟動失敗自動重試次數(shù) 5
user = root //用哪個用戶啟動
redirect_stderr = true //把 stderr 重定向到 stdout 默認(rèn) false恨旱,如果是false就不需要設(shè)置下面的log配置
stdout_logfile_maxbytes = 20MB //stdout 日志文件大小辈毯,默認(rèn)50MB
stdout_logfile_backups = 20 //stdout 日志文件備份數(shù)
//stdout 日志文件,需要注意當(dāng)指定目錄不存在時無法正常啟動搜贤,所以需要手動創(chuàng)建目錄(supervisord 會自動創(chuàng)建日志文件)
stdout_logfile = /var/log/flask_demo/stdout.log // 日志輸出路徑
stderr_logfile = /var/log/flask_demo/stderr.log // 錯誤日志輸出路徑
environment=ASPNETCORE_ENVIRONMENT="Development" // 自定義該子進(jìn)程的環(huán)境變量谆沃,和別的子進(jìn)程是不共享的 (default no adds)
下面是一個supervisor管理nginx進(jìn)程地實例,僅供參考仪芒。
[program:nginx]
directory = /usr/local/nginx
command = /usr/local/nginx/sbin/nginx -g 'daemon off;'
startsecs = 5
autostart = true
autorestart = true
stdout_logfile = /var/log/supervisor/nginx.log
stderr_logfile = /var/log/supervisor/nginx_error.log
user = root
特別注意:
sbin/nginx這條命令默認(rèn)是后臺啟動唁影,但是supervisor不能監(jiān)控后臺程序,所以supervisor就一直執(zhí)行這個命令掂名,導(dǎo)致nginx一直在重啟夭咬,加上-g 'daemon off;'這個參數(shù)可解決這問題,這個參數(shù)的意思是在前臺運行铆隘。
supervisor啟動命令
# 啟動supervisor服務(wù)
supervisord
查看已啟動服務(wù)
pstree -p |grep supervisord
查看supervisor log日志
日志路徑是自定義配置的卓舵,不固定。
若不確定路徑膀钠,可以在supervisord.conf中查找到supervisor log日志的路徑掏湾。
cat /var/log/supervisor/supervisord.log
supervisorctl 常用命令
# 查看supervisorctl命令
supervisorctl help
# 查看已被監(jiān)控地program,并進(jìn)入supervisor的命令行窗口
supervisorctl
# 重載最新的配置文件裹虫,當(dāng)添加/修改supervisor配置后,需要執(zhí)行reload
supervisorctl reload
# 根據(jù)最新的配置文件融击,啟動新配置或有改動的進(jìn)程筑公,配置沒有改動的進(jìn)程不會受影響而重啟
supervisorctl update
# 查看運行狀態(tài)
supervisorctl status
# 啟動某個進(jìn)程
supervisorctl start <program-name>
# 重啟某個進(jìn)程
supervisorctl restart <program-name>
# 停止某個進(jìn)程
supervisorctl stop <program-name>
# 停止所有進(jìn)程
supervisorctl stop all
supervisor設(shè)置開機(jī)啟動
用apt安裝supervisor,一般來說是會自動設(shè)置好開機(jī)啟動的尊浪,這也是為什么我在本文章開頭采用apt安裝supervisor的原因匣屡。
但,不怕一萬就怕萬一拇涤,若你重啟服務(wù)器之后supervisor沒有自動啟動捣作,那么可以按照下面的方法設(shè)置開啟啟動:將supervisor啟動命令寫進(jìn)rc.local即可
# 可以使用 whereis supervisord獲得supervisord的路徑
/usr/bin/supervisord
ubuntu 配置rc.local的方法可參考:ubuntu 設(shè)置腳本開機(jī)自啟動