1.背景

Supervisor 是一個(gè)用 Python 寫(xiě)的進(jìn)程管理工具，可以很方便的用來(lái)啟動(dòng)、重啟、關(guān)閉進(jìn)程（不僅僅是 Python 進(jìn)程）。

除了對(duì)單個(gè)進(jìn)程的控制，還可以同時(shí)啟動(dòng)、關(guān)閉多個(gè)進(jìn)程，比如很不幸的服務(wù)器出問(wèn)題導(dǎo)致所有應(yīng)用程序都被殺死，此時(shí)可以用 supervisor 同時(shí)啟動(dòng)所有應(yīng)用程序而不是一個(gè)一個(gè)地敲命令啟動(dòng)。
安裝Supervisor 可以運(yùn)行在 Linux、Mac OS X 上。

2.安裝

如前所述，supervisor 是 Python 編寫(xiě)的，所以安裝起來(lái)也很方便。

sudo pip install supervisor

3.配置

Supervisor 相當(dāng)強(qiáng)大，提供了很豐富的功能，不過(guò)我們可能只需要用到其中一小部分。安裝完成之后，可以編寫(xiě)配置文件，來(lái)滿(mǎn)足自己的需求。

為了方便，我們把配置分成兩部分：

• supervisord（supervisor 是一個(gè) C/S 模型的程序，這是 server 端，對(duì)應(yīng)的有 client 端：supervisorctl）
• 應(yīng)用程序（即我們要管理的程序）

首先來(lái)看 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 和端口，如果開(kāi)放到公網(wǎng)，需要注意安全性
username=user              
;登錄管理后臺(tái)的用戶(hù)名;
password=123               
;登錄管理后臺(tái)的密碼
[supervisord]
logfile=/tmp/supervisord.log 
;日志文件，默認(rèn)是 $CWD/supervisord.log
logfile_maxbytes=50MB        
;日志文件大小，超出會(huì) rotate，默認(rèn) 50MB
logfile_backups=10           
日志文件保留備份數(shù)量默認(rèn) 10
loglevel=info                
; 日志級(jí)別，默認(rèn) info，其它: debug,warn,tracepid
file=/tmp/supervisord.pid 
; pid 文件
nodaemon=false               
; 是否在前臺(tái)啟動(dòng)，默認(rèn)是 false，即以 daemon 的方式啟動(dòng)
minfds=1024
;可以打開(kāi)的文件描述符的最小值，默認(rèn) 1024
minprocs=200
;可以打開(kāi)的進(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 
;通過(guò) UNIX socket 連接 supervisord，路徑與 unix_http_server 部分的 file 一致
;server
url=http://127.0.0.1:9001 
;通過(guò) HTTP 的方式連接 supervisord
; 包含其他的配置文件
[include]
files = relative/directory/*.ini    
; 可以是 *.conf 或 *.ini我們把上面這部分配置保存到 /etc/supervisord.conf（或其他任意有權(quán)限訪問(wèn)的文件），然后啟動(dòng) supervisord（通過(guò) -c 選項(xiàng)指定配置文件路徑，如果不指定會(huì)按照這個(gè)順序查找配置文件：$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf）：

然后執(zhí)行：

supervisord -c /etc/supervisord.conf

查看 supervisord 是否在運(yùn)行：

ps aux | grep supervisord

4.program 配置

上面我們已經(jīng)把 supervisrod運(yùn)行起來(lái)了，現(xiàn)在可以添加我們要管理的進(jìn)程的配置文件。
可以把所有配置項(xiàng)都寫(xiě)到 supervisord.conf 文件里，但并不推薦這樣做，而是通過(guò) include的方式把不同的程序（組）寫(xiě)到不同的配置文件里。

為了舉例，我們新建一個(gè)目錄 /etc/supervisor/ 用于存放這些配置文件，相應(yīng)的，把 /etc/supervisord.conf 里 include 部分的的配置修改一下：

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

假設(shè)有個(gè)用 Python 和 Flask 框架編寫(xiě)的用戶(hù)中心系統(tǒng)，取名 usercenter，用 gunicorn 做 web 服務(wù)器。

項(xiàng)目代碼位于 /home/leon/projects/usercenter，gunicorn 配置文件為gunicorn.py，WSGI callable 是 wsgi.py 里的 app 屬性。所以直接在命令行啟動(dòng)的方式可能是這樣的：

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

現(xiàn)在編寫(xiě)一份配置文件來(lái)管理這個(gè)進(jìn)程（需要注意：用 supervisord 管理時(shí)，gunicorn 的 daemon 選項(xiàng)需要設(shè)置為 False）：

[program:usercenter]
directory = /home/leon/projects/usercenter 
;程序的啟動(dòng)目錄
command = gunicorn -c gunicorn.py wsgi:app  
;啟動(dòng)命令，可以看出與手動(dòng)在命令行啟動(dòng)的命令是一樣的
autostart = true     
; 在 supervisord 啟動(dòng)的時(shí)候也自動(dòng)啟動(dòng)
startsecs = 5        
; 啟動(dòng) 5 秒后沒(méi)有異常退出，就當(dāng)作已經(jīng)正常啟動(dòng)了
autorestart = true   
; 程序異常退出后自動(dòng)重啟
startretries = 3     
; 啟動(dòng)失敗自動(dòng)重試次數(shù)，默認(rèn)是 3
user = leon          
; 用哪個(gè)用戶(hù)啟動(dòng)
redirect_stderr = true  
; 把 stderr 重定向到 stdout，默認(rèn) false
stdout_logfile_maxbytes = 20MB  
; stdout 日志文件大小，默認(rèn) 50MB
stdout_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
; 可以通過(guò) environment 來(lái)添加需要的環(huán)境變量，一種常見(jiàn)的用法是修改 PYTHONPATH;
environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

一份配置文件至少需要一個(gè) [program:x] 部分的配置，來(lái)告訴 supervisord 需要管理那個(gè)進(jìn)程。

[program:x] 語(yǔ)法中的 x 表示 program name，會(huì)在客戶(hù)端（supervisorctl 或 web 界面）顯示，在 supervisorctl 中通過(guò)這個(gè)值來(lái)對(duì)程序進(jìn)行 start、restart、stop 等操作。

5.使用 supervisorctl

Supervisorctl 是 supervisord 的一個(gè)命令行客戶(hù)端工具，啟動(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 # 重啟配置文件修改過(guò)的程序

上面這些命令都有相應(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)的日志文件來(lái)查找問(wèn)題。

Supervisor 有很豐富的功能，還有其他很多項(xiàng)配置，可以在官方文檔獲取更多信息：http://supervisord.org/index.html