轉載于? http://liyangliang.me/posts/2015/06/using-supervisor/
Supervisor (http://supervisord.org) 是一個用 Python 寫的進程管理工具,可以很方便的用來啟動、重啟、關閉進程(不僅僅是 Python 進程)。除了對單個進程的控制,還可以同時啟動、關閉多個進程,比如很不幸的服務器出問題導致所有應用程序都被殺死,此時可以用 supervisor 同時啟動所有應用程序而不是一個一個地敲命令啟動。
安裝
Supervisor 可以運行在 Linux、Mac OS X 上。如前所述,supervisor 是 Python 編寫的,所以安裝起來也很方便,可以直接用 pip :
sudo pip install supervisor
如果是 Ubuntu 系統,還可以使用 apt-get 安裝。
supervisord 配置
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.loglogfile_maxbytes=50MB? ? ? ? ; 日志文件大小,超出會 rotate,默認50MBlogfile_backups=10; 日志文件保留備份數量默認10loglevel=info? ? ? ? ? ? ? ? ; 日志級別,默認 info,其它: debug,warn,tracepidfile=/tmp/supervisord.pid ; pid 文件nodaemon=false; 是否在前臺啟動,默認是false,即以 daemon 的方式啟動minfds=1024; 可以打開的文件描述符的最小值,默認1024minprocs=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 一致;serverurl=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
program 配置
上面我們已經把 supervisrod 運行起來了,現在可以添加我們要管理的進程的配置文件。這些配置可以都寫到 supervisord.conf 文件里,如果應用程序很多,最好通過 include 的方式把不同的程序(組)寫到不同的配置文件里。
為了舉例,我們新建一個目錄 /etc/supervisor/ 用于存放這些配置文件,相應的,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:
[include]files= /etc/supervisor/*.conf
假設有個用 Flask 開發的用戶系統 usercenter, 生產環境使用 gunicorn 運行。項目代碼位于?/home/leon/projects/usercenter,WSGI 對象位于 wsgi.py。在命令行啟動的方式是這樣的:
cd/home/leon/projects/usercentergunicorn -w 8 -b 0.0.0.0:17510 wsgi:app
對應的配置文件可能是:
[program:usercenter]directory= /home/leon/projects/usercenter ; 程序的啟動目錄command= gunicorn -w8-b0.0.0.0:17510wsgi:app? ; 啟動命令autostart=true; 在 supervisord 啟動的時候也自動啟動startsecs=5; 啟動5秒后沒有異常退出,就當作已經正常啟動了autorestart=true; 程序異常退出后自動重啟startretries=3; 啟動失敗自動重試次數,默認是3user= leon? ? ? ? ? ; 用哪個用戶啟動redirect_stderr=true; 把 stderr 重定向到 stdout,默認falsestdout_logfile_maxbytes=20MB? ; stdout 日志文件大小,默認50MBstdout_logfile_backups=20; stdout 日志文件備份數; stdout 日志文件,需要注意當指定目錄不存在時無法正常啟動,所以需要手動創建目錄(supervisord 會自動創建日志文件)stdout_logfile= /data/logs/usercenter_stdout.log
其中?[program:usercenter]?中的?usercenter?是應用程序的唯一標識,不能重復。對該程序的所有操作(start, restart 等)都通過名字來實現。
Tips 1: Python 環境
有兩種方式指定程序使用的 Python 環境:
command?使用絕對路徑。假設使用 pyenv 來管理 Python 環境,上面例子中的 gunicorn 路徑可以替換為?/home/leon/.pyenv/versions/usercenter/bin/gunicorn. 這種方式一目了然,推薦。
通過?environment?配置?PYTHONPATH.?environment=PYTHONPATH=$PYTHONPATH:/home/leon/.pyenv/versions/usercenter/bin/.?environment?這個配置項非常有用,可以用來給程序傳入環境變量。
Tips 2: 后臺進程
Supervisor 只能管理在前臺運行的程序,所以如果應用程序有后臺運行的選項,需要關閉。
Tips 3: 子進程
有時候用 Supervisor 托管的程序還會有子進程(如 Tornado),如果只殺死主進程,子進程就可能變成孤兒進程。通過這兩項配置來確保所有子進程都能正確停止:
stopasgroup=truekillasgroup=true
使用 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