一、supervisor簡介

Supervisor是用Python開發(fā)的一套通用的進程管理程序，能將一個普通的命令行進程變?yōu)楹笈_daemon，并監(jiān)控進程狀態(tài)，異常退出時能自動重啟。它是通過fork/exec的方式把這些被管理的進程當(dāng)作supervisor的子進程來啟動，這樣只要在supervisor的配置文件中，把要管理的進程的可執(zhí)行文件的路徑寫進去即可。也實現(xiàn)當(dāng)子進程掛掉的時候，父進程可以準(zhǔn)確獲取子進程掛掉的信息的，可以選擇是否自己啟動和報警。supervisor還提供了一個功能，可以為supervisord或者每個子進程，設(shè)置一個非root的user，這個user就可以管理它對應(yīng)的進程。

注：本文以centos7為例，supervisor版本3.4.0。

二、supervisor安裝

1. 配置好yum源后，可以直接安裝

   yum install supervisor
   

2. Debian/Ubuntu可通過apt安裝

   apt-get install supervisor
   

3. pip安裝

   pip install supervisor
   

4. easy_install安裝

   easy_install supervisor
   

三、supervisor使用

supervisor配置文件：/etc/supervisord.conf

通過easy_install或pip安裝后，需要運行如下命令生成配置文件

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

supervisor配置文件：/etc/supervisord/conf.d目錄下，可通過配置文件修改

四、配置文件說明

supervisor.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服務(wù)器，提供web管理界面
;port=127.0.0.1:9001        ;Web管理后臺運行的IP和端口，如果開放到公網(wǎng)，需要注意安全性
;username=user              ;登錄管理后臺的用戶名
;password=123               ;登錄管理后臺的密碼
 
[supervisord]
logfile=/tmp/supervisord.log ;日志文件，默認是 $CWD/supervisord.log
logfile_maxbytes=50MB        ;日志文件大小，超出會rotate，默認 50MB，如果設(shè)成0，表示不限制大小
logfile_backups=10           ;日志文件保留備份數(shù)量默認10，設(shè)為0表示不備份
loglevel=info                ;日志級別，默認info，其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false               ;是否在前臺啟動，默認是false，即以 daemon 的方式啟動
minfds=1024                  ;可以打開的文件描述符的最小值，默認 1024
minprocs=200                 ;可以打開的進程數(shù)的最小值，默認 200
 
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通過UNIX socket連接supervisord，路徑與unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通過HTTP的方式連接supervisord
 
; [program:xx]是被管理的進程配置參數(shù)，xx是進程的名稱
[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run  ; 程序啟動命令
autostart=true       ; 在supervisord啟動的時候也自動啟動
startsecs=10         ; 啟動10秒后沒有異常退出，就表示進程正常啟動了，默認為1秒
autorestart=true     ; 程序退出后自動重啟,可選值：[unexpected,true,false]，默認為unexpected，表示進程意外殺死后才重啟
startretries=3       ; 啟動失敗自動重試次數(shù)，默認是3
user=tomcat          ; 用哪個用戶啟動進程，默認是root
priority=999         ; 進程啟動優(yōu)先級，默認999，值小的優(yōu)先啟動
redirect_stderr=true ; 把stderr重定向到stdout，默認false
stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小，默認50MB
stdout_logfile_backups = 20   ; stdout 日志文件備份數(shù)，默認是10
; stdout 日志文件，需要注意當(dāng)指定目錄不存在時無法正常啟動，所以需要手動創(chuàng)建目錄（supervisord 會自動創(chuàng)建日志文件）
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false     ;默認為false,進程被殺死時，是否向這個進程組發(fā)送stop信號，包括子進程
killasgroup=false     ;默認為false，向進程組發(fā)送kill信號，包括子進程
 
;包含其它配置文件
[include]
files = /etc/supervisor/conf.d/*.conf    ;可以指定一個或多個以.conf結(jié)束的配置文件

上述配置文件只是部分配置，配置文件可以通過運行echo_supervisord_conf獲得。這個配置文件一般情況下不需要更改，除了最后的[include]部分，其余保持默認即可。

比較完整的配置文件展示：

[unix_http_server]
file=/tmp/supervisor.sock   ; the path to the socket file
;chmod=0700                 ; socket file mode (default 0700)
;chown=nobody:nogroup       ; socket file uid:gid owner
;username=user              ; default is no username (open server)
;password=123               ; default is no password (open server)

;[inet_http_server]         ; 配置web后臺
;port=127.0.0.1:9001        ; 指定ip_address:port, 使用 *:port 監(jiān)聽所有 IP
;username=user              ; 默認沒有用戶名 (open server)
;password=123               ; 默認沒有密碼 (open server)

[supervisord]
logfile=/tmp/supervisord.log ; 日志文件; 默認 $CWD/supervisord.log
logfile_maxbytes=50MB        ; 日志文件最大大小; 默認 50MB
logfile_backups=10           ; # of main logfile backups; 0 means none, default 10
loglevel=info                ; log level; default info; others: debug,warn,trace
pidfile=/tmp/supervisord.pid ; pid文件
nodaemon=false               ; 是否運行在前臺; 默認是后臺
minfds=1024                  ; min. avail startup file descriptors; default 1024
minprocs=200                 ; min. avail process descriptors;default 200
;umask=022                   ; process file creation umask; default 022
;user=chrism                 ; default is current user, required if root
;identifier=supervisor       ; supervisord identifier, default is 'supervisor'
;directory=/tmp              ; default is not to cd during start
;nocleanup=true              ; don't clean up tempfiles at start; default false
;childlogdir=/tmp            ; 'AUTO' child log dir, default $TEMP
;environment=KEY="value"     ; key value pairs to add to environment
;strip_ansi=false            ; strip ansi escape codes in logs; def. false

; The rpcinterface:supervisor 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:x] sections.

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

; 配置 supervisorctl 
; configure it match the settings in either the unix_http_server
; or inet_http_server section.

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris              ; should be same as in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

; 下面是子進程配置文件示例
; Create one or more 'real' program: sections to be able to control them under
; supervisor.

;[program:theprogramname]
;command=/bin/cat              ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=999                  ; the relative start priority (default 999)
;autostart=true                ; start at supervisord start (default: true)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; when to restart if exited after running (def: unexpected)
;exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; send stop signal to the UNIX process group (default false)
;killasgroup=false             ; SIGKILL the UNIX process group (def false)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (0 means none, default 10)
;stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10     ; # of stderr logfile backups (0 means none, default 10)
;stderr_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;environment=A="1",B="2"       ; process environment additions (def no adds)
;serverurl=AUTO                ; override serverurl computation (childutils)

; The sample eventlistener section below shows all possible eventlistener
; subsection values.  Create one or more 'real' eventlistener: sections to be
; able to handle event notifications sent by supervisord.

;[eventlistener:theeventlistenername]
;command=/bin/eventlistener    ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;events=EVENT                  ; event notif. types to subscribe to (req'd)
;buffer_size=10                ; event buffer queue size (default 10)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=-1                   ; the relative start priority (default -1)
;autostart=true                ; start at supervisord start (default: true)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; autorestart if exited after running (def: unexpected)
;exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; send stop signal to the UNIX process group (default false)
;killasgroup=false             ; SIGKILL the UNIX process group (def false)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=false         ; redirect_stderr=true is not allowed for eventlisteners
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (0 means none, default 10)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10     ; # of stderr logfile backups (0 means none, default 10)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;environment=A="1",B="2"       ; process environment additions
;serverurl=AUTO                ; override serverurl computation (childutils)

; The sample group section below shows all possible group values.  Create one
; or more 'real' group: sections to create "heterogeneous" process groups.

;[group:thegroupname]
;programs=progname1,progname2  ; each refers to 'x' in [program:x] definitions
;priority=999                  ; the relative start priority (default 999)

; 配置include files
; The [include] section can just contain the "files" setting.  This
; setting can list multiple files (separated by whitespace or
; newlines).  It can also contain wildcards.  The filenames are
; interpreted as relative to this file.  Included files *cannot*
; include files themselves.

[include]  
; .ini和.conf都支持
files = relative/directory/*.ini

子進程配置文件說明：

#*為必須填寫項
#項目名
[program:blog]
#腳本目錄
directory=/opt/bin

#*命令路徑,如果使用python啟動的程序應(yīng)該為 python /home/test.py, 
#不建議放入/home/user/, 對于非user用戶一般情況下是不能訪問
#腳本執(zhí)行命令
command=/usr/bin/python /opt/bin/test.py

#當(dāng)numprocs為1時,process_name=%(program_name)s;
#當(dāng)numprocs>=2時,%(program_name)s_%(process_num)02d
process_name=%(program_name)s

#進程數(shù)量
numprocs=1

#執(zhí)行目錄,若有/home/supervisor_test/test1.py
#將directory設(shè)置成/home/supervisor_test
#則command只需設(shè)置成python test1.py
#否則command必須設(shè)置成絕對執(zhí)行目錄
directory=/tmp

#掩碼:--- -w- -w-, 轉(zhuǎn)換后rwx r-x w-x
umask=022

#優(yōu)先級,值越高,最后啟動,最先被關(guān)閉,默認值999
priority=999

#*supervisor啟動的時候程序是否隨著同時啟動，默認True
autostart=true

#*自動重啟，當(dāng)程序exit的時候，這個program不會自動重啟,默認unexpected，設(shè)置子進程掛掉后自動重啟的情況，有三個選項，false,unexpected和true。如果為false的時候，無論什么情況下，都不會被重新啟動，如果為unexpected，只有當(dāng)進程的退出碼不在下面的exitcodes里面定義的
autorestart=false

#啟動延時執(zhí)行，這個選項是子進程多少秒之后啟動，此時狀態(tài)如果是running，則我們認為啟動成功了。默認值為1
startsecs=1

#啟動嘗試次數(shù),默認3次
startretries=3

#當(dāng)退出碼是0,2時,執(zhí)行重啟,默認值0,2
exitcodes=0,2

#停止信號,默認TERM
#中斷:INT(類似于Ctrl+C)(kill -INT pid),退出后會將寫文件或日志(推薦)
#終止:TERM(kill -TERM pid)
#掛起:HUP(kill -HUP pid),注意與Ctrl+Z/kill -stop pid不同
#從容停止:QUIT(kill -QUIT pid)
#KILL, USR1, USR2其他見命令(kill -l),說明1
stopsignal=TERM

stopwaitsecs=10

#腳本運行的用戶身份 
user = test

#日志輸出 
stderr_logfile=/tmp/blog_stderr.log 
stdout_logfile=/tmp/blog_stdout.log 

#把stderr重定向到stdout，默認 false
redirect_stderr = true

#stdout日志文件大小，默認 50MB
stdout_logfile_maxbytes = 20MB

#stdout日志文件備份數(shù)
stdout_logfile_backups = 20

#環(huán)境變量設(shè)置
environment=A="1",B="2"

serverurl=AUTO

子進程配置示例

[program:htmlQueue]
command=/usr/bin/php think queue:listen --queue htmlQueue --timeout=1800 ;
directory=/home/cyzone/public_html/hmh.cyzone.cn ;
autostart=true ;
autorestart=true ;自動啟動
startsecs=1 ;程序重啟時候停留在runing狀態(tài)的秒數(shù)
startretries=10 ;啟動失敗時的最多重試次數(shù)
user=apache ;
redirect_stderr=true ;重定向stderr到stdout
stdout_logfile=/home/cyzone/public_html/hmh.cyzone.cn/runtime/htmlQueue.log ;

五、supervisor啟動

1. 使用 pip或者easy_install安裝的supervisor運行如下命令即可啟動

   $ supervisord
   

   supervisor 默認在以下路徑查找配置文件：/usr/etc/supervisord.conf, /usr/supervisord.conf, supervisord.conf, etc/supervisord.conf, /etc/supervisord.conf, /etc/supervisor/supervisord.conf

   如需指定主配置文件，則需要使用-c$參數(shù)

   $ supervisord -c /etc/supervisor/supervisord.conf
   

   查看安裝的版本

   $ supervisord -v
   

   查看supervisor的狀態(tài)

   $ supervisorctl  status
   

   注：supervisord是主進程，supervisorctl是給守護進程發(fā)送命令的客戶端工具

2. 使用 apt-get 安裝的supervisor直接可以通過如下命令運行

   $ /etc/init.d/supervisor start
   

六、supervisor命令說明

supervisord

supervisord 是主進程。

通過supervisord -h可以查看幫助說明。示例：

-c/--configuration FILENAME ;指定配置文件
-n/--nodaemon ;運行在前臺（調(diào)試用）
-v/--version ;打印版本信息

-u/--user USER ;以指定用戶（或用戶ID）運行
-m/--umask UMASK ;指定子進程的umask，默認是022
-l/--logfile FILENAME ;指定日志文件
-e/--loglevel LEVEL ;指定日志級別

supervisorctl

supervisorctl 是客戶端程序，用于向supervisord發(fā)起命令。

通過supervisorctl -h可以查看幫助說明。我們主要關(guān)心的是其action命令：

$ supervisorctl  help

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version

這些命令對于控制子進程非常重要。示例:

supervisorctl status        //查看所有進程的狀態(tài)
supervisorctl status <name> //查看指定進程狀態(tài)
supervisorctl stop <name>   //停止停止指定子進程
supervisorctl stop all      //停止所有子進程
supervisorctl start <name>  //啟動指定子進程
supervisorctl start all     //啟動所有子進程
supervisorctl restart <name>//重啟指定子進程
supervisorctl restart all   //重啟指定子進程
supervisorctl update        //重新加載配置，如配置文件里將新的子進程加入進程組，設(shè)置autostart=true則會啟動新新增的子進程
supervisorctl reload        //重新啟動配置中的所有程序
supervisorctl reread        //重新加載配置文件
supervisorctl add <name>    //添加子進程到進程組 
supervisorctl reomve <name> //從進程組移除子進程，需要先stop。注意：移除后，需要使用reread和update才能重新運行該進程

注：直接輸入supervisorctl進入supervisorctl的shell交互界面，此時上面的命令不帶supervisorctl可直接使用。

七、web界面操作

需要開啟supervisord.conf注釋掉的這4行：

[inet_http_server]         ; inet (TCP) server disabled by default
port=127.0.0.1:9001        ; ip_address:port specifier, *:port for all iface
username=user              ; default is no username (open server)
password=123               ; default is no password (open server)

端口默認是監(jiān)聽127.0.0.1:9001，這里方便測試，修改為如下代碼：

port=*:9001

然后重啟主進程supervisord：

$ supervisorctl reload

瀏覽器訪問：http://myip:9001 ，輸入用戶名、密碼后，即可看到web頁面：

supervisord.png

注意：如果修改配置文件時，[inet_http_server]這一行被注釋，會導(dǎo)致不僅web需要認證，命令行使用supervisorctl也需要認證，這時候就需要在交互式命令行里輸入用戶名、密碼才能進行下一步的操作。