Supervisor 托管服務

        Supervisor (http://supervisord.org) 是一個用 Python 寫的程序管理工具，可以很友善的用來啟動、重新開機、關閉程序（不僅僅是 Python 程序）。除了對單個程序的控制，還可以同時啟動、關閉多個程序，當然了自己寫個腳本也是可以給supervisor托管的。在企業裡我們更多的是托管服務，或是為了更友善的标準化，自動化而使用托管服務，對tomcat的使用尤為的友善。當然我們之前在一些中小型的公司，大家混布比較常見，一個伺服器一個家目錄下扔n多個項目，有的編譯源碼安裝到處亂放，給維護或者新人帶來了極大的維護成本，其實都可以使用supervisor來托管。

一、supervisor的安裝其實很簡單，這塊說2中安裝方法：

1、yum  install  supervisor

2、sudo pip install supervisor

Supervisor 相當強大，提供了很豐富的功能，不過我們可能隻需要用到其中一小部分。安裝完成之後，可以編寫配置檔案，來滿足自己的需求。為了友善，我們把配置分成兩部分：supervisord（supervisor 是一個 C/S 模型的程式，這是 server 端，對應的有 client 端：supervisorctl）和應用程式（即我們要管理的程式）。

首先來看 supervisord 的配置檔案。安裝完 supervisor 之後，可以運作echo_supervisord_conf 指令輸出預設的配置項，也可以重定向到一個配置檔案裡：

echo_supervisord_conf > /etc/supervisord.conf

yum安裝的當然不需要這麼麻煩，預設的就在/etc目錄下。

二：supervisor的配置：

[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,trace

pidfile=/tmp/supervisord.pid ; pid 檔案

nodaemon=false               ; 是否在前台啟動，預設是 false，即以 daemon 的方式啟動

minfds=65535                ; 可以打開的檔案描述符的最小值，預設 1024

minprocs=65535                ; 可以打開的程序數的最小值，預設 200

user=root

umask=022

; 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    /etc/supervisor/*.conf; 可以是 *.conf 或 *.ini

三、項目啟動配置檔案：

現在編寫一份配置檔案來管理這個程序（需要注意：用 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

四：progrem簡單配置：（下面為例）

[program:arch.gate.soa]

command=sh start.sh

process_name=arch.gate.soa

numprocs=1

stopsignal=INT

directory=/data/arch.gate.soa

user=www-data

redirect_stderr=true

stdout_logfile=/data/log/supervisor/arch.gate.soa.out

stdout_logfile_maxbytes=100MB

stdout_logfile_backups=10

stopasgroup=true

killasgroup=true

environment = ELEME_ENV="prod"

一份配置檔案至少需要一個 [program:x] 部分的配置，來告訴 supervisord 需要管理那個程序。[program:x] 文法中的 x 表示 program name，會在用戶端（supervisorctl 或 web 界面）顯示，在 supervisorctl 中通過這個值來對程式進行 start、restart、stop 等操作。

五、使用 supervisorctl：

Supervisorctl 是 supervisord 的一個指令行用戶端工具，啟動時需要指定與 supervisord 使用同一份配置檔案，否則與 supervisord 一樣按照順序查找配置檔案。

上面這個指令會進入 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