supervisor

 

--轉載：

Supervisor (http://supervisord.org) 是一個用 Python 寫的進程管理工具，能夠很方便的用來啓動、重啓、關閉進程（不只僅是 Python 進程）。除了對單個進程的控制，還能夠同時啓動、關閉多個進程，好比很不幸的服務器出問題致使全部應用程序都被殺死，此時能夠用 supervisor 同時啓動全部應用程序而不是一個一個地敲命令啓動。

安裝

Supervisor 能夠運行在 Linux、Mac OS X 上。如前所述，supervisor 是 Python 編寫的，因此安裝起來也很方便，能夠直接用 pip :

 

1	sudo pip install supervisor

若是是 Ubuntu 系統，還可使用 apt-get 安裝。

supervisord 配置

Supervisor 至關強大，提供了很豐富的功能，不過咱們可能只須要用到其中一小部分。安裝完成以後，能夠編寫配置文件，來知足本身的需求。爲了方便，咱們把配置分紅兩部分：supervisord（supervisor 是一個 C/S 模型的程序，這是 server 端，對應的有 client 端：supervisorctl）和應用程序（即咱們要管理的程序）。

首先來看 supervisord 的配置文件。安裝完 supervisor 以後，能夠運行echo_supervisord_conf 命令輸出默認的配置項，也能夠重定向到一個配置文件裏：

 

1	echo_supervisord_conf > /etc/supervisord.conf

去除裏面大部分註釋和「不相關」的部分，咱們能夠先看這些配置：

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

[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=1024                  ; 能夠打開的文件描述符的最小值，默認 1024 minprocs=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）：

 

1	supervisord -c /etc/supervisord.conf

 

program 配置

上面咱們已經把 supervisrod 運行起來了，如今能夠添加咱們要管理的進程的配置文件。能夠把全部配置項都寫到 supervisord.conf 文件裏，但並不推薦這樣作，而是經過 include 的方式把不一樣的程序（組）寫到不一樣的配置文件裏。

爲了舉例，咱們新建一個目錄 /etc/supervisor/ 用於存放這些配置文件，相應的，把 /etc/supervisord.conf 裏 include 部分的的配置修改一下：

 

1 2	[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 屬性。因此直接在命令行啓動的方式多是這樣的：

 

1 2	cd /home/leon/projects/usercenter gunicorn -c gunicorn.py wsgi:app

如今編寫一份配置文件來管理這個進程（須要注意：用 supervisord 管理時，gunicorn 的 daemon 選項須要設置爲 False）：

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

[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 等操做。

使用 supervisorctl

Supervisorctl 是 supervisord 的一個命令行客戶端工具，啓動時須要指定與 supervisord 使用同一份配置文件，不然與 supervisord 同樣按照順序查找配置文件。

 

1	supervisorctl -c /etc/supervisord.conf

上面這個命令會進入 supervisorctl 的 shell 界面，而後能夠執行不一樣的命令了：

 

1 2 3 4 5 6

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

上面這些命令都有相應的輸出，除了進入 supervisorctl 的 shell 界面，也能夠直接在 bash 終端運行：

 

Supervisor (http://supervisord.org) 是一個用 Python 寫的進程管理工具，能夠很方便的用來啓動、重啓、關閉進程（不只僅是 Python 進程）。除了對單個進程的控制，還能夠同時啓動、關閉多個進程，好比很不幸的服務器出問題致使全部應用程序都被殺死，此時能夠用 supervisor 同時啓動全部應用程序而不是一個一個地敲命令啓動。
安裝

Supervisor 能夠運行在 Linux、Mac OS X 上。如前所述，supervisor 是 Python 編寫的，因此安裝起來也很方便，能夠直接用 pip :

sudo pip install supervisor
1
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
1
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.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=1024                  ; 能夠打開的文件描述符的最小值，默認 1024
minprocs=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

[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=1024                  ; 能夠打開的文件描述符的最小值，默認 1024
minprocs=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
1
supervisord -c /etc/supervisord.conf
program 配置

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

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

[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/leon/projects/usercenter
gunicorn -c gunicorn.py wsgi:app
1
2
cd /home/leon/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: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 等操做。
使用 supervisorctl

Supervisorctl 是 supervisord 的一個命令行客戶端工具，啓動時須要指定與 supervisord 使用同一份配置文件，不然與 supervisord 同樣按照順序查找配置文件。

supervisorctl -c /etc/supervisord.conf
1
supervisorctl -c /etc/supervisord.conf
上面這個命令會進入 supervisorctl 的 shell 界面，而後能夠執行不一樣的命令了：

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

> 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 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

 

1 2 3 4 5 6

$ 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

 

 

 

 

 

 

 

 

 

 

 

---------------2016-6-7 10:21:21--

　　source：【1】