Supervisor 介紹
Supervisor 是一個用 Python 寫的進程管理工具锋喜,可以很方便的用來啟動扣孟、重啟盼铁、關(guān)閉進程(不僅僅是 Python 進程)醋粟。除了對單個進程的控制仗阅,還可以同時啟動昌讲、關(guān)閉多個進程,比如很不幸的服務(wù)器由于某種原因暫時 kill 掉你的應(yīng)用减噪,此時可以用 Supervisor 讓你的應(yīng)用自動重啟短绸,如果是多個應(yīng)用被殺死,也省去了手動一個一個地敲命令重新啟動筹裕。
安裝
目前 Supervisor 只能運行在 Unix-Like 的系統(tǒng)上醋闭,無法運行在 Windows 上。Supervisor 官方版目前只能運行在 Python 2.4 以上版本朝卒,但是還無法運行在 Python 3 上目尖。執(zhí)行下面代碼前,需要安裝 pip:
pip install supervisor
安裝完成后扎运,可以使用兩個命令瑟曲,分別是 supervisord
和 supervisorctl
,如果你的系統(tǒng)里有兩個版本的 Python,且默認的 python
命令版本是 Python 3,此時運行會出錯豪治,解決方式是修改兩個命令使用的 Python 版本洞拨。使用 which
命令找到兩個命令的文件地址,然后編輯文件并指定 Python 版本:
編輯配置文件
將下面內(nèi)容保存到 /etc/supervisor/supervisord.conf
:
; 基礎(chǔ)配置樣例
[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 ;加載其他配置文件
[inet_http_server] ; inet (TCP) server disabled by default
port=*:9001 ; 通過網(wǎng)頁可以控制子進程
;username=user ; (default is no username (open server))
;password=123 ; (default is no password (open server))
; 進程的配置樣例
; 設(shè)置進程的名稱负拟,使用 supervisorctl 來管理進程時需要使用該進程名烦衣,這里的進程名是 your_program_name
[program:your_program_name]
;numprocs=1 ; 進程數(shù)量,默認為1
;process_name=%(program_name)s ; 默認為 %(program_name)s,即 [program:x] 中的 x
directory=/home/yiming ; 執(zhí)行 command 之前花吟,先切換到工作目錄
command=python test.py
autostart=true ;如果設(shè)置為true秸歧,當(dāng)supervisord啟動的時候,進程會自動重啟衅澈。
user=yiming ; 使用 yiming 用戶來啟動該進程
autorestart=true ; 程序崩潰時自動重啟键菱,重啟次數(shù)是有限制的,默認為3次
startsecs = 5 ; 啟動 5 秒后沒有異常退出今布,就當(dāng)作已經(jīng)正常啟動了
redirect_stderr=true ; 錯誤日志重定向到標(biāo)準(zhǔn)輸出
loglevel=info
現(xiàn)在以守護進程的方式啟動 test.py
:
supervisord -c /etc/supervisor/supervisord.conf
此時命令 python test.ty
已經(jīng)被執(zhí)行经备,因為進程配置樣例中有 autostart=true
,所以 Supervisord 服務(wù)運行后啟動進程 your_program_name 部默,并把 your_program_name 進程作為自己的子進程侵蒙,所以當(dāng)進程 your_program_name 掛掉后,Supervisord 會收到通知傅蹂,然后可以再次將 your_program_name 作為子進程啟動纷闺。
模擬程序異常退出
如下圖,名稱為 echo 的進程被殺掉兩次份蝴,之后都會被重新啟動急但,右側(cè)是 Supervisord 日志記錄了 echo 進程狀態(tài)的變化:
使用 supervisorctl 管理進程
- 停止某一個進程,program_name 為 [program:x] 里的 x:
supervisorctl stop program_name
- 啟動某個進程:
supervisorctl start program_name
- 重啟某個進程:
supervisorctl restart program_name
- 停止全部進程搞乏,注:start波桩、restart、stop 都不會載入最新的配置文件:
supervisorctl stop all
- 載入最新的配置文件请敦,停止原有進程并按新的配置啟動镐躲、管理所有進程:
supervisorctl reload
- 根據(jù)最新的配置文件,啟動新配置或有改動的進程侍筛,配置沒有改動的進程不會受影響而重啟:
supervisorctl update
Web 管理
Supervisor 可以在界面上管理進程萤皂,Web Server 其實是通過 XML_RPC 來實現(xiàn)的,可以向Supervisor 請求數(shù)據(jù)匣椰,也可以控制 Supervisor 及子進程裆熙。配置在 [inet_http_server]
塊里面:
[inet_http_server] ; inet (TCP) server disabled by default
port=*:9001 ; 通過網(wǎng)頁可以控制子進程
;username=user ; (default is no username (open server))
;password=123 ; (default is no password (open server))
配置參數(shù)介紹
參數(shù) | 參數(shù)解釋 |
---|---|
command | 啟動程序使用的命令,可以是絕對路徑或者相對路徑 |
process_name | 一個python字符串表達式禽笑,用來表示supervisor進程啟動的這個的名稱入录,默認值是%(program_name)s |
numprocs | Supervisor啟動這個程序的多個實例,如果numprocs>1佳镜,則process_name的表達式必須包含%(process_num)s僚稿,默認是1 |
numprocs_start | 一個int偏移值,當(dāng)啟動實例的時候用來計算numprocs的值 |
priority | 權(quán)重蟀伸,可以控制程序啟動和關(guān)閉時的順序蚀同,權(quán)重越低:越早啟動缅刽,越晚關(guān)閉。默認值是999 |
autostart | 如果設(shè)置為true蠢络,當(dāng)supervisord啟動的時候衰猛,進程會自動重啟。 |
autorestart | 值可以是false刹孔、true啡省、unexpected。false:進程不會自動重啟芦疏,unexpected:當(dāng)程序退出時的退出碼不是exitcodes中定義的時冕杠,進程會重啟微姊,true:進程會無條件重啟當(dāng)退出的時候酸茴。 |
startsecs | 程序啟動后等待多長時間后才認為程序啟動成功 |
startretries | supervisord嘗試啟動一個程序時嘗試的次數(shù)。默認是3 |
exitcodes | 一個預(yù)期的退出返回碼兢交,默認是0,2薪捍。 |
stopsignal | 當(dāng)收到stop請求的時候,發(fā)送信號給程序配喳,默認是TERM信號酪穿,也可以是 HUP, INT, QUIT, KILL, USR1, or USR2。 |
stopwaitsecs | 在操作系統(tǒng)給supervisord發(fā)送SIGCHILD信號時等待的時間 |
stopasgroup | 如果設(shè)置為true晴裹,則會使supervisor發(fā)送停止信號到整個進程組 |
killasgroup | 如果設(shè)置為true被济,則在給程序發(fā)送SIGKILL信號的時候,會發(fā)送到整個進程組涧团,它的子進程也會受到影響只磷。 |
user | 如果supervisord以root運行,則會使用這個設(shè)置用戶啟動子程序 |
redirect_stderr | 如果設(shè)置為true泌绣,進程則會把標(biāo)準(zhǔn)錯誤輸出到supervisord后臺的標(biāo)準(zhǔn)輸出文件描述符钮追。 |
stdout_logfile | 把進程的標(biāo)準(zhǔn)輸出寫入文件中,如果stdout_logfile沒有設(shè)置或者設(shè)置為AUTO阿迈,則supervisor會自動選擇一個文件位置元媚。 |
stdout_logfile_maxbytes | 標(biāo)準(zhǔn)輸出log文件達到多少后自動進行輪轉(zhuǎn),單位是KB苗沧、MB刊棕、GB。如果設(shè)置為0則表示不限制日志文件大小 |
stdout_logfile_backups | 標(biāo)準(zhǔn)輸出日志輪轉(zhuǎn)備份的數(shù)量待逞,默認是10鞠绰,如果設(shè)置為0,則不備份 |
stdout_capture_maxbytes | 當(dāng)進程處于stderr capture mode模式的時候飒焦,寫入FIFO隊列的最大bytes值蜈膨,單位可以是KB屿笼、MB、GB |
stdout_events_enabled | 如果設(shè)置為true翁巍,當(dāng)進程在寫它的stderr到文件描述符的時候驴一,PROCESS_LOG_STDERR事件會被觸發(fā) |
stderr_logfile | 把進程的錯誤日志輸出一個文件中,除非redirect_stderr參數(shù)被設(shè)置為true |
stderr_logfile_maxbytes | 錯誤log文件達到多少后自動進行輪轉(zhuǎn)灶壶,單位是KB肝断、MB、GB驰凛。如果設(shè)置為0則表示不限制日志文件大小 |
stderr_logfile_backups | 錯誤日志輪轉(zhuǎn)備份的數(shù)量胸懈,默認是10,如果設(shè)置為0恰响,則不備份 |
stderr_capture_maxbytes | 當(dāng)進程處于stderr capture mode模式的時候趣钱,寫入FIFO隊列的最大bytes值,單位可以是KB胚宦、MB首有、GB |
stderr_events_enabled | 如果設(shè)置為true,當(dāng)進程在寫它的stderr到文件描述符的時候枢劝,PROCESS_LOG_STDERR事件會被觸發(fā) |
environment | 一個k/v對的list列表 |
directory | supervisord在生成子進程的時候會切換到該目錄 |
umask | 設(shè)置進程的umask |
serverurl | 是否允許子進程和內(nèi)部的HTTP服務(wù)通訊井联,如果設(shè)置為AUTO,supervisor會自動的構(gòu)造一個url |