使用 supervisor 管理進程

1.背景

Supervisor 是一個用 Python 寫的進程管理工具,可以很方便的用來啟動、重啟询微、關閉進程(不僅僅是 Python 進程)。

除了對單個進程的控制狂巢,還可以同時啟動撑毛、關閉多個進程,比如很不幸的服務器出問題導致所有應用程序都被殺死隧膘,此時可以用 supervisor 同時啟動所有應用程序而不是一個一個地敲命令啟動代态。
安裝Supervisor 可以運行在 Linux、Mac OS X 上疹吃。

2.安裝

如前所述,supervisor 是 Python 編寫的西雀,所以安裝起來也很方便萨驶。

sudo pip install supervisor

3.配置

Supervisor 相當強大,提供了很豐富的功能艇肴,不過我們可能只需要用到其中一小部分腔呜。安裝完成之后,可以編寫配置文件再悼,來滿足自己的需求核畴。

為了方便,我們把配置分成兩部分:

  • supervisord(supervisor 是一個 C/S 模型的程序冲九,這是 server 端谤草,對應的有 client 端:supervisorctl)
  • 應用程序(即我們要管理的程序)

首先來看 supervisord 的配置文件跟束。安裝完 supervisor 之后,可以運行

echo_supervisord_conf

命令輸出默認的配置項丑孩,也可以重定向到一個配置文件里:

echo_supervisord_conf > /etc/supervisord.conf

去除里面大部分注釋和“不相關”的部分冀宴,我們可以先看這些配置:

[unix_http_server]
file=/tmp/supervisor.sock
;UNIX socket 文件,supervisorctl 會使用
chmod=0700                 
;socket 文件的 mode温学,默認是 0700
;chown=nobody:nogroup       
;socket 文件的 owner略贮,格式: uid:gid;
[inet_http_server]         
;HTTP 服務器,提供 web 管理界面;
port=127.0.0.1:9001        
;Web 管理后臺運行的 IP 和端口仗岖,如果開放到公網逃延,需要注意安全性
username=user              
;登錄管理后臺的用戶名;
password=123               
;登錄管理后臺的密碼
[supervisord]
logfile=/tmp/supervisord.log 
;日志文件,默認是 $CWD/supervisord.log
logfile_maxbytes=50MB        
;日志文件大小轧拄,超出會 rotate揽祥,默認 50MB
logfile_backups=10           
日志文件保留備份數量默認 10
loglevel=info                
; 日志級別,默認 info紧帕,其它: debug,warn,tracepid
file=/tmp/supervisord.pid 
; pid 文件
nodaemon=false               
; 是否在前臺啟動盔然,默認是 false,即以 daemon 的方式啟動
minfds=1024
;可以打開的文件描述符的最小值是嗜,默認 1024
minprocs=200
;可以打開的進程數的最小值愈案,默認 200
;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:///tmp/supervisor.sock 
;通過 UNIX socket 連接 supervisord,路徑與 unix_http_server 部分的 file 一致
;server
url=http://127.0.0.1:9001 
;通過 HTTP 的方式連接 supervisord
; 包含其他的配置文件
[include]
files = relative/directory/*.ini    
; 可以是 *.conf 或 *.ini我們把上面這部分配置保存到 /etc/supervisord.conf(或其他任意有權限訪問的文件)鹅搪,然后啟動 supervisord(通過 -c 選項指定配置文件路徑站绪,如果不指定會按照這個順序查找配置文件:$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf):

然后執(zhí)行:

supervisord -c /etc/supervisord.conf

查看 supervisord 是否在運行:

ps aux | grep supervisord

4.program 配置

上面我們已經把 supervisrod運行起來了,現在可以添加我們要管理的進程的配置文件丽柿。
可以把所有配置項都寫到 supervisord.conf 文件里恢准,但并不推薦這樣做,而是通過 include的方式把不同的程序(組)寫到不同的配置文件里甫题。

為了舉例馁筐,我們新建一個目錄 /etc/supervisor/ 用于存放這些配置文件,相應的坠非,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:

[include]files = /etc/supervisor/*.conf

假設有個用 Python 和 Flask 框架編寫的用戶中心系統(tǒng)敏沉,取名 usercenter,用 gunicorn 做 web 服務器炎码。

項目代碼位于 /home/leon/projects/usercenter盟迟,gunicorn 配置文件為gunicorn.py,WSGI callable 是 wsgi.py 里的 app 屬性潦闲。所以直接在命令行啟動的方式可能是這樣的:

cd /home/leon/projects/usercentergunicorn -c gunicorn.py wsgi:app

現在編寫一份配置文件來管理這個進程(需要注意:用 supervisord 管理時攒菠,gunicorn 的 daemon 選項需要設置為 False):

[program:usercenter]
directory = /home/leon/projects/usercenter 
;程序的啟動目錄
command = gunicorn -c gunicorn.py wsgi:app  
;啟動命令,可以看出與手動在命令行啟動的命令是一樣的
autostart = true     
; 在 supervisord 啟動的時候也自動啟動
startsecs = 5        
; 啟動 5 秒后沒有異常退出歉闰,就當作已經正常啟動了
autorestart = true   
; 程序異常退出后自動重啟
startretries = 3     
; 啟動失敗自動重試次數辖众,默認是 3
user = leon          
; 用哪個用戶啟動
redirect_stderr = true  
; 把 stderr 重定向到 stdout卓起,默認 false
stdout_logfile_maxbytes = 20MB  
; stdout 日志文件大小,默認 50MB
stdout_logfile_backups = 20     
; stdout 日志文件備份數
; stdout 日志文件赵辕,需要注意當指定目錄不存在時無法正常啟動既绩,所以需要手動創(chuàng)建目錄(supervisord 會自動創(chuàng)建日志文件)
stdout_logfile = /data/logs/usercenter_stdout.log
; 可以通過 environment 來添加需要的環(huán)境變量,一種常見的用法是修改 PYTHONPATH;
environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

一份配置文件至少需要一個 [program:x] 部分的配置还惠,來告訴 supervisord 需要管理那個進程饲握。

[program:x] 語法中的 x 表示 program name,會在客戶端(supervisorctl 或 web 界面)顯示蚕键,在 supervisorctl 中通過這個值來對程序進行 start救欧、restart、stop 等操作锣光。

5.使用 supervisorctl

Supervisorctl 是 supervisord 的一個命令行客戶端工具笆怠,啟動時需要指定與 supervisord 使用同一份配置文件,否則與 supervisord 一樣按照順序查找配置文件誊爹。

supervisorctl -c /etc/supervisord.conf

上面這個命令會進入 supervisorctl 的 shell 界面蹬刷,然后可以執(zhí)行不同的命令了:

status #用于查看程序狀態(tài)

stop usercenter # 關閉 usercenter 程序

start usercenter # 啟動 usercenter 程序

restart usercenter # 重啟 usercenter 程序

reread #讀取有更新(增加)的配置文件,不會啟動新添加的程序

update # 重啟配置文件修改過的程序

上面這些命令都有相應的輸出频丘,除了進入 supervisorctl 的 shell 界面办成,也可以直接在 bash 終端運行:

$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update 

其它除了 supervisorctl 之外,還可以配置 supervisrod 啟動 web 管理界面搂漠,這個 web 后臺使用 Basic Auth 的方式進行身份認證迂卢。

除了單個進程的控制,還可以配置 group桐汤,進行分組管理而克。

經常查看日志文件,包括 supervisord 的日志和各個 pragram 的日志文件怔毛,程序 crash 或拋出異常的信息一半會輸出到 stderr员萍,可以查看相應的日志文件來查找問題。

Supervisor 有很豐富的功能拣度,還有其他很多項配置充活,可以在官方文檔獲取更多信息:http://supervisord.org/index.html

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市蜡娶,隨后出現的幾起案子,更是在濱河造成了極大的恐慌映穗,老刑警劉巖窖张,帶你破解...
    沈念sama閱讀 210,914評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現場離奇詭異蚁滋,居然都是意外死亡宿接,警方通過查閱死者的電腦和手機赘淮,發(fā)現死者居然都...
    沈念sama閱讀 89,935評論 2 383
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來睦霎,“玉大人梢卸,你說我怎么就攤上這事「迸” “怎么了蛤高?”我有些...
    開封第一講書人閱讀 156,531評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長碑幅。 經常有香客問我戴陡,道長,這世上最難降的妖魔是什么沟涨? 我笑而不...
    開封第一講書人閱讀 56,309評論 1 282
  • 正文 為了忘掉前任恤批,我火速辦了婚禮,結果婚禮上裹赴,老公的妹妹穿的比我還像新娘喜庞。我一直安慰自己,他們只是感情好棋返,可當我...
    茶點故事閱讀 65,381評論 5 384
  • 文/花漫 我一把揭開白布延都。 她就那樣靜靜地躺著,像睡著了一般懊昨。 火紅的嫁衣襯著肌膚如雪窄潭。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,730評論 1 289
  • 那天酵颁,我揣著相機與錄音嫉你,去河邊找鬼。 笑死躏惋,一個胖子當著我的面吹牛幽污,可吹牛的內容都是我干的。 我是一名探鬼主播簿姨,決...
    沈念sama閱讀 38,882評論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼距误,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了扁位?” 一聲冷哼從身側響起准潭,我...
    開封第一講書人閱讀 37,643評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎域仇,沒想到半個月后刑然,有當地人在樹林里發(fā)現了一具尸體,經...
    沈念sama閱讀 44,095評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡暇务,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,448評論 2 325
  • 正文 我和宋清朗相戀三年泼掠,在試婚紗的時候發(fā)現自己被綠了怔软。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,566評論 1 339
  • 序言:一個原本活蹦亂跳的男人離奇死亡择镇,死狀恐怖挡逼,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情腻豌,我是刑警寧澤家坎,帶...
    沈念sama閱讀 34,253評論 4 328
  • 正文 年R本政府宣布,位于F島的核電站饲梭,受9級特大地震影響乘盖,放射性物質發(fā)生泄漏。R本人自食惡果不足惜憔涉,卻給世界環(huán)境...
    茶點故事閱讀 39,829評論 3 312
  • 文/蒙蒙 一订框、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧兜叨,春花似錦穿扳、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,715評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至跪但,卻和暖如春履羞,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背屡久。 一陣腳步聲響...
    開封第一講書人閱讀 31,945評論 1 264
  • 我被黑心中介騙來泰國打工忆首, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人被环。 一個月前我還...
    沈念sama閱讀 46,248評論 2 360
  • 正文 我出身青樓糙及,卻偏偏與公主長得像,于是被迫代替她去往敵國和親筛欢。 傳聞我的和親對象是個殘疾皇子浸锨,可洞房花燭夜當晚...
    茶點故事閱讀 43,440評論 2 348

推薦閱讀更多精彩內容