使用 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):

然后執行:

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 框架編寫的用戶中心系統,取名 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 日志文件,需要注意當指定目錄不存在時無法正常啟動,所以需要手動創建目錄(supervisord 會自動創建日志文件)
stdout_logfile = /data/logs/usercenter_stdout.log
; 可以通過 environment 來添加需要的環境變量,一種常見的用法是修改 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 界面,然后可以執行不同的命令了:

status #用于查看程序狀態

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閱讀 228,702評論 6 534
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,615評論 3 419
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,606評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,044評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,826評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,227評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,307評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,447評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,992評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,807評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,001評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,550評論 5 361
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,243評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,667評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,930評論 1 287
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,709評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,996評論 2 374

推薦閱讀更多精彩內容