轉(zhuǎn)載于? http://liyangliang.me/posts/2015/06/using-supervisor/
Supervisor (http://supervisord.org) 是一個(gè)用 Python 寫的進(jìn)程管理工具焊唬,可以很方便的用來啟動(dòng)侈百、重啟父阻、關(guān)閉進(jìn)程(不僅僅是 Python 進(jìn)程)。除了對(duì)單個(gè)進(jìn)程的控制权纤,還可以同時(shí)啟動(dòng)、關(guān)閉多個(gè)進(jìn)程,比如很不幸的服務(wù)器出問題導(dǎo)致所有應(yīng)用程序都被殺死比庄,此時(shí)可以用 supervisor 同時(shí)啟動(dòng)所有應(yīng)用程序而不是一個(gè)一個(gè)地敲命令啟動(dòng)唉工。
安裝
Supervisor 可以運(yùn)行在 Linux研乒、Mac OS X 上。如前所述淋硝,supervisor 是 Python 編寫的雹熬,所以安裝起來也很方便宽菜,可以直接用 pip :
sudo pip install supervisor
如果是 Ubuntu 系統(tǒng),還可以使用 apt-get 安裝竿报。
supervisord 配置
Supervisor 相當(dāng)強(qiáng)大铅乡,提供了很豐富的功能,不過我們可能只需要用到其中一小部分烈菌。安裝完成之后阵幸,可以編寫配置文件,來滿足自己的需求芽世。為了方便挚赊,我們把配置分成兩部分:supervisord(supervisor 是一個(gè) C/S 模型的程序,這是 server 端捂襟,對(duì)應(yīng)的有 client 端:supervisorctl)和應(yīng)用程序(即我們要管理的程序)咬腕。
首先來看 supervisord 的配置文件。安裝完 supervisor 之后葬荷,可以運(yùn)行echo_supervisord_conf?命令輸出默認(rèn)的配置項(xiàng)涨共,也可以重定向到一個(gè)配置文件里:
echo_supervisord_conf > /etc/supervisord.conf
去除里面大部分注釋和“不相關(guān)”的部分,我們可以先看這些配置:
[unix_http_server]file=/tmp/supervisor.sock? ; UNIX socket 文件宠漩,supervisorctl 會(huì)使用;chmod=0700? ? ? ? ? ? ? ? ; socket 文件的 mode举反,默認(rèn)是 0700;chown=nobody:nogroup? ? ? ; socket 文件的 owner,格式: uid:gid;[inet_http_server]? ? ? ? ; HTTP 服務(wù)器扒吁,提供 web 管理界面;port=127.0.0.1:9001? ? ? ? ; Web 管理后臺(tái)運(yùn)行的 IP 和端口火鼻,如果開放到公網(wǎng),需要注意安全性;username=user? ? ? ? ? ? ? ; 登錄管理后臺(tái)的用戶名;password=123? ? ? ? ? ? ? ; 登錄管理后臺(tái)的密碼[supervisord]logfile=/tmp/supervisord.log ; 日志文件雕崩,默認(rèn)是$CWD/supervisord.loglogfile_maxbytes=50MB? ? ? ? ; 日志文件大小魁索,超出會(huì) rotate,默認(rèn)50MBlogfile_backups=10; 日志文件保留備份數(shù)量默認(rèn)10loglevel=info? ? ? ? ? ? ? ? ; 日志級(jí)別盼铁,默認(rèn) info粗蔚,其它: debug,warn,tracepidfile=/tmp/supervisord.pid ; pid 文件nodaemon=false; 是否在前臺(tái)啟動(dòng),默認(rèn)是false饶火,即以 daemon 的方式啟動(dòng)minfds=1024; 可以打開的文件描述符的最小值鹏控,默認(rèn)1024minprocs=200; 可以打開的進(jìn)程數(shù)的最小值,默認(rèn)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 一致;serverurl=http://127.0.0.1:9001 ; 通過 HTTP 的方式連接 supervisord; 包含其他的配置文件[include]files= relative/directory/*.ini? ? ; 可以是 *.conf 或 *.ini
我們把上面這部分配置保存到 /etc/supervisord.conf(或其他任意有權(quán)限訪問的文件)当辐,然后啟動(dòng) supervisord(通過 -c 選項(xiàng)指定配置文件路徑,如果不指定會(huì)按照這個(gè)順序查找配置文件:$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf):
supervisord -c /etc/supervisord.conf
查看 supervisord 是否在運(yùn)行:
ps aux | grep supervisord
program 配置
上面我們已經(jīng)把 supervisrod 運(yùn)行起來了鲤看,現(xiàn)在可以添加我們要管理的進(jìn)程的配置文件缘揪。這些配置可以都寫到 supervisord.conf 文件里,如果應(yīng)用程序很多,最好通過 include 的方式把不同的程序(組)寫到不同的配置文件里寺晌。
為了舉例世吨,我們新建一個(gè)目錄 /etc/supervisor/ 用于存放這些配置文件,相應(yīng)的呻征,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:
[include]files= /etc/supervisor/*.conf
假設(shè)有個(gè)用 Flask 開發(fā)的用戶系統(tǒng) usercenter, 生產(chǎn)環(huán)境使用 gunicorn 運(yùn)行耘婚。項(xiàng)目代碼位于?/home/leon/projects/usercenter,WSGI 對(duì)象位于 wsgi.py陆赋。在命令行啟動(dòng)的方式是這樣的:
cd/home/leon/projects/usercentergunicorn -w 8 -b 0.0.0.0:17510 wsgi:app
對(duì)應(yīng)的配置文件可能是:
[program:usercenter]directory= /home/leon/projects/usercenter ; 程序的啟動(dòng)目錄command= gunicorn -w8-b0.0.0.0:17510wsgi:app? ; 啟動(dòng)命令autostart=true; 在 supervisord 啟動(dòng)的時(shí)候也自動(dòng)啟動(dòng)startsecs=5; 啟動(dòng)5秒后沒有異常退出沐祷,就當(dāng)作已經(jīng)正常啟動(dòng)了autorestart=true; 程序異常退出后自動(dòng)重啟startretries=3; 啟動(dòng)失敗自動(dòng)重試次數(shù),默認(rèn)是3user= leon? ? ? ? ? ; 用哪個(gè)用戶啟動(dòng)redirect_stderr=true; 把 stderr 重定向到 stdout攒岛,默認(rèn)falsestdout_logfile_maxbytes=20MB? ; stdout 日志文件大小赖临,默認(rèn)50MBstdout_logfile_backups=20; stdout 日志文件備份數(shù); stdout 日志文件,需要注意當(dāng)指定目錄不存在時(shí)無(wú)法正常啟動(dòng)灾锯,所以需要手動(dòng)創(chuàng)建目錄(supervisord 會(huì)自動(dòng)創(chuàng)建日志文件)stdout_logfile= /data/logs/usercenter_stdout.log
其中?[program:usercenter]?中的?usercenter?是應(yīng)用程序的唯一標(biāo)識(shí),不能重復(fù)顺饮。對(duì)該程序的所有操作(start, restart 等)都通過名字來實(shí)現(xiàn)吵聪。
Tips 1: Python 環(huán)境
有兩種方式指定程序使用的 Python 環(huán)境:
command?使用絕對(duì)路徑。假設(shè)使用 pyenv 來管理 Python 環(huán)境兼雄,上面例子中的 gunicorn 路徑可以替換為?/home/leon/.pyenv/versions/usercenter/bin/gunicorn. 這種方式一目了然吟逝,推薦。
通過?environment?配置?PYTHONPATH.?environment=PYTHONPATH=$PYTHONPATH:/home/leon/.pyenv/versions/usercenter/bin/.?environment?這個(gè)配置項(xiàng)非常有用赦肋,可以用來給程序傳入環(huán)境變量块攒。
Tips 2: 后臺(tái)進(jìn)程
Supervisor 只能管理在前臺(tái)運(yùn)行的程序,所以如果應(yīng)用程序有后臺(tái)運(yùn)行的選項(xiàng)佃乘,需要關(guān)閉囱井。
Tips 3: 子進(jìn)程
有時(shí)候用 Supervisor 托管的程序還會(huì)有子進(jìn)程(如 Tornado),如果只殺死主進(jìn)程趣避,子進(jìn)程就可能變成孤兒進(jìn)程琅绅。通過這兩項(xiàng)配置來確保所有子進(jìn)程都能正確停止:
stopasgroup=truekillasgroup=true
使用 supervisorctl
Supervisorctl 是 supervisord 的一個(gè)命令行客戶端工具,啟動(dòng)時(shí)需要指定與 supervisord 使用同一份配置文件鹅巍,否則與 supervisord 一樣按照順序查找配置文件。
supervisorctl -c /etc/supervisord.conf
上面這個(gè)命令會(huì)進(jìn)入 supervisorctl 的 shell 界面料祠,然后可以執(zhí)行不同的命令了:
> status# 查看程序狀態(tài)> stop usercenter# 關(guān)閉 usercenter 程序> start usercenter# 啟動(dòng) usercenter 程序> restart usercenter# 重啟 usercenter 程序> reread? ? # 讀取有更新(增加)的配置文件骆捧,不會(huì)啟動(dòng)新添加的程序> update? ? # 重啟配置文件修改過的程序
上面這些命令都有相應(yīng)的輸出,除了進(jìn)入 supervisorctl 的 shell 界面髓绽,也可以直接在 bash 終端運(yùn)行:
$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update
其它
除了 supervisorctl 之外敛苇,還可以配置 supervisrod 啟動(dòng) web 管理界面,這個(gè) web 后臺(tái)使用 Basic Auth 的方式進(jìn)行身份認(rèn)證。
除了單個(gè)進(jìn)程的控制枫攀,還可以配置 group括饶,進(jìn)行分組管理。
經(jīng)常查看日志文件来涨,包括 supervisord 的日志和各個(gè) pragram 的日志文件图焰,程序 crash 或拋出異常的信息一半會(huì)輸出到 stderr,可以查看相應(yīng)的日志文件來查找問題蹦掐。
Supervisor 有很豐富的功能技羔,還有其他很多項(xiàng)配置,可以在官方文檔獲取更多信息:http://supervisord.org/index.html