supervisor安裝配置

Supervisor（ http://supervisord.org ）是用Python開發的一個client/server服務，是Linux/Unix系統下的一個進程管理工具，不支持Windows系統。它能夠很方便的監聽、啓動、中止、重啓一個或多個進程。用Supervisor管理的進程，當一個進程意外被殺死，supervisort監聽到進程死後，會自動將它從新拉起，很方便的作到進程自動恢復的功能，再也不須要本身寫shell腳原本控制。

一、supervisor組件

• supervisord(server 部分)：主要負責管理子進程，響應客戶端命令以及日誌的輸出等；
• supervisorctl(client 部分)：命令行客戶端，用戶能夠經過它與不一樣的 supervisord 進程聯繫，獲取子進程的狀態等。
• Web Server主要能夠在界面上管理進程，Web Server實際上是經過XML_RPC來實現的，能夠向supervisor請求數據，也能夠控制supervisor及子進程。配置在[inet_http_server]塊裏面;
• XML_RPC接口
  提供了與webserver中相同的用於查詢和控制進程的http接口;

二、安裝

python版本要求2.4以上, 且不能是python3, supervisor不能運行在任何python3版本上。
能夠直接用pip安裝:

$ sudo pip install supervisor

若是是Ubuntu系統, 也能夠用 apt-get。
也可使用easy_install安裝：

wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
easy_install supervisor

supervisor安裝完成後會生成三個執行程序：supervisortd、supervisorctl、echo_supervisord_conf，分別是supervisor的守護進程服務（用於接收進程管理命令）、客戶端（用於和守護進程通訊，發送管理進程的指令）、生成初始配置文件程序。

三、配置

運行supervisord服務的時候，須要指定supervisor配置文件，若是沒有顯示指定，默認在如下目錄查找：

$CWD/supervisord.conf
$CWD/etc/supervisord.conf
/etc/supervisord.conf
/etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
../etc/supervisord.conf (Relative to the executable)
../supervisord.conf (Relative to the executable)

$CWD表示運行supervisord程序的目錄。
能夠經過運行echo_supervisord_conf程序生成supervisor的初始化配置文件，以下所示：

mkdir /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf

3.一、 啓動

而後能夠經過 supervisord 命令啓動 supervisord.

$ supervisord

查看supervisor進程信息

$ ps aux | grep super
root       1405  0.0  0.2  60956  7032 ?        Ss   10:34   0:01 /usr/bin/python /usr/bin/supervisord -n -c /etc/supervisor/supervisord.conf

此時supervisord已經啓動，能夠經過supervisorctl進入shell管理界面：

$ supervisorctl
supervisor>status
supervisor>

因爲目前沒有添加任何須要管理的進程，因此 status 沒有輸出人和結果。

3.二、 program配置

上面咱們已經把 supervisrod 運行起來了，如今能夠添加咱們要管理的進程的配置文件。能夠把全部配置項都寫到 supervisord.conf 文件裏，但並不推薦這樣作，而是經過 include 的方式把不一樣的程序（組）寫到不一樣的配置文件裏。
爲了舉例，咱們新建一個目錄 /etc/supervisor/ 用於存放這些配置文件，相應的，把 /etc/supervisord.conf 裏 include 部分的的配置修改一下：

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

假設有個用 Python 和 Flask 框架編寫的用戶中心繫統，取名 usercenter，用 gunicorn (http://gunicorn.org/) 作 web 服務器。項目代碼位於 /home/leon/projects/usercenter，gunicorn 配置文件爲 gunicorn.py，WSGI callable 是 wsgi.py 裏的 app 屬性。因此直接在命令行啓動的方式多是這樣的：

cd /home/tudou/projects/usercenter
gunicorn -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 等操做。

3.三、 管理命令

可使用如下命令更新配置、更新進程、查看狀態

# 讀取有更新（增長）的配置文件，不會啓動新添加的程序
$ supervisorctl reread
# 重啓配置文件修改過的程序
$ supervisorctl update
# 查看程序狀態
$ supervisorctl status
# 啓動程序 App_name
$ supervisorctl start App_name
# 關閉程序 App_name
$ supervisorctl stop App_name
# 重啓程序 App_name
$ supervisorctl restart App_name

以上命令也能夠在supervisorctl Shell中執行：

$ supervisorctl
supervisor> reread
supervisor> update
supervisor> status
supervisor> start App_name
supervisor> stop App_name
supervisor> restart App_name

3.四、web管理界面

除了 supervisorctl 以外，還能夠配置 supervisrod 啓動 web 管理界面，這個 web 後臺使用 Basic Auth 的方式進行身份認證。
除了單個進程的控制，還能夠配置 group，進行分組管理。
常常查看日誌文件，包括 supervisord 的日誌和各個 pragram 的日誌文件，程序 crash 或拋出異常的信息一半會輸出到 stderr，能夠查看相應的日誌文件來查找問題。

3.4.一、配置

編輯配置文件/etc/supervisor/supervisord.conf,添加inet_http_server節點，以下：

[inet_http_server]
port = 127.0.0.1:9001
username = username
password = password

其中，port是服務監聽端口信息，username是管理員用戶名，password是管理員密碼。

一、日誌權限錯誤

IOError: [Errno 13] Permission denied: '/var/log/supervisor/supervisord.log'

緣由，/var/log/supervisor/supervisord.log沒有寫權限，賦予權限便可：

sudo chmod -R 777 /var/log/supervisor/supervisord.log

二、開啓HTTP Server錯誤

Error: Cannot open an HTTP server: socket.error reported errno.EACCES (13)

配置文件中 /var/run 文件夾，沒有授予啓動 supervisord 的相應用戶的寫權限。/var/run 文件夾其實是連接到 /run，所以咱們修改 /run 的權限。

sudo chmod 777 /run

通常狀況下，咱們能夠用 root 用戶啓動 supervisord 進程，而後在其所管理的進程中，再具體指定須要以那個用戶啓動這些進程。

三、日誌權限問題

'INFO spawnerr: unknown error making dispatchers for 'app_name': EACCES'

修改日誌文件的權限

sudo chmod 777 /usr/log/supervisor/supervisor.log
sudo chmod 777 /usr/log/supervisor/youAppName.log