用途

有一個程序需要每時每刻不斷的跑，但是這個程序又有可能由於各種原因有可能中斷。當程序中斷的時候，希望能自動重新啟動它。此時，我就需要使用到了Supervisor。

前言

supervisor管理的程序必須由supervisor來啟動
supervisor還要求管理的程式是非daemon程式，supervisord會幫你把它轉成daemon程式，因此如果用supervisor來管理nginx的話，必須在nginx的配置檔案裡新增一行設定daemon off讓nginx以非daemon方式啟動。
supervisor工具包括4個組成部分：supervisord，supervisorctl，Web Server，XML-RPC Interface。

supervisord

它負責在自己的呼叫啟動子程式，響應客戶端的命令，重新啟動崩潰或退出的子程序，記錄其子程序stdout和stderr輸出

supervisorctl

supervisord的命令列客戶端，是一個shell介面，可以操作supervisord提供的操作功能。從supervisorctl，使用者可以連線到不同的supervisord程序，獲得每個子程序的狀態，以及停止和啟動子程序。
它通過UNIX socker或TCP socket和服務端進行連線。

Web Server

在瀏覽器中執行supervisorctl的各種操作

XML-RPC Interface

和HTTP服務相似，這是提供了一個XML-RPC介面。你可以通過該介面去執行supervisorctl的操作。

其中最重要的是supervisord和supervisorctl。

1：安裝

sudo easy_install supervisor

2：生成配置檔案

【修改時間】：2017年7月3日
【增加內容】：現在的版本好像不需要再手動建立配置檔案了。主配置檔案預設為/etc/supervisor/supervisord.conf，建議你把自己增加的配置檔案放在/etc/supervisor/conf.d目錄下。主配置檔案會包含該路徑下的所有.conf結尾的檔案

sudo
 
 su - root -c "echo_supervisord_conf > /etc/supervisord.conf"

嚴謹的講，你需要對這個檔案進行許可權設定，因為它可能包含未加密的使用者名稱和密碼。

3：修改配置檔案

在預設的配置檔案中，supervisord.pid 以及 supervisor.sock 是放在 /tmp 目錄下，但是 /tmp 目錄是存放臨時檔案，裡面的檔案是會被 Linux 系統刪除的，一旦這些檔案丟失，就無法再通過 supervisorctl 來執行 restart 和 stop 命令了，將只會得到unix:///tmp/supervisor.sock不存在的錯誤 。

【修改時間】：2017年7月3日
【增加內容】：主配置檔案預設為/etc/supervisor/supervisord.conf，建議你把自己增加的配置檔案放在/etc/supervisor/conf.d目錄下。主配置檔案會包含該路徑下的所有.conf結尾的檔案

sudo vi /etc/supervisord.conf

; Sample supervisor config file.
;
; For more information on the config file, please see:
; http://supervisord.org/configuration.html
;
; Note: shell expansion ("~" or "$HOME") is not supported.  Environment
; variables can be expanded using this syntax: "%(ENV_HOME)s".

[unix_http_server]
file=/var/run/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]         ; 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))

[supervisord]
logfile=/var/log/supervisord.log ; (main log file;default $CWD/supervisord.log)
logfile_maxbytes=50MB        ; (max main logfile bytes b4 rotation;default 50MB)
logfile_backups=10           ; (num of main logfile rotation backups;default 10)
loglevel=info                ; (log level;default info; others: debug,warn,trace)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
nodaemon=false               ; (start in foreground if true;default 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)
;user=root                    ; (default is current user, required if root)
;password=rootpasswd        ; (default is no password (open server))
;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 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:///var/run/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 http_username if set
;password=123                ; should be same as http_password if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

; The below sample program section shows all possible program subsection values,
; 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)
;autorestart=unexpected        ; whether/when to restart (default: unexpected)
;startsecs=1                   ; number of secs prog must stay running (def. 1)
;startretries=3                ; max # of serial start failures (default 3)
;exitcodes=0,2                 ; 'expected' exit codes for process (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 (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 (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 below sample eventlistener section shows all possible
; eventlistener subsection values, create one or more 'real'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.

;[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)
;autorestart=unexpected        ; whether/when to restart (default: unexpected)
;startsecs=1                   ; number of secs prog must stay running (def. 1)
;startretries=3                ; max # of serial start failures (default 3)
;exitcodes=0,2                 ; 'expected' exit codes for process (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 (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        ; # of stderr logfile backups (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 below sample group section 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)

; 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]
;files = relative/directory/*.ini

4：新增program

在配置檔案中，新增一個自己要執行的命令或自己寫的指令碼

4.1：先寫個指令碼

vi /home/wang/testvisor.py

#! /use/bin/env python

from datetime import datetime
import time

while True:
    print datetime.now()
    time.sleep(7)

4.2：在supervisord.conf中新增program

【修改時間】：2017年7月3日
【增加內容】：主配置檔案預設為/etc/supervisor/supervisord.conf，建議你把自己增加的配置檔案放在/etc/supervisor/conf.d目錄下。主配置檔案會包含該路徑下的所有.conf結尾的檔案

vi /etc/supervisord.conf

在檔案中新增下面的程式碼

[program:printdate]
command=python testvisor.py
directory=/home/wang
stdout_logfile=/var/log/supervisor/printdate.log
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10

2017年3月20日更新
如果需要執行的命令列中有百分號（%），那麼你需要用%%來代替。否則，%會認為是supervisor中的變數。

4.3：更多配置以及說明

下面是我從網路上搜到的關於部分配置的中文解釋

;[program:應用名稱]
[program:cat]

;執行的命令
command=python printdate.py

;程序名稱
;當numprocs為1時,process_name=%(program_name)s
;當numprocs>=2時,%(program_name)s_%(process_num)02d
process_name=%(program_name)s

;程序數量
numprocs=1

;執行命令的目錄
directory=/home/wang

;掩碼
umask=022

;優先順序，值越高，啟動的越晚，關閉的越早。預設999
priority=999

;是否自動啟動。如果是true,當supervisor啟動時,程式將會自動啟動
autostart=true


autorestart=true
;值範圍：false, unexpected, true
;false：不會自動重新啟動該程序
;unexpected：當程式退出並且退出程式碼不是與此程序配置相關聯的退出程式碼（請參閱exitcodes，預設值為0,2）時，該程序將重新啟動
;true：程序將在退出時無條件地重新啟動，不考慮其退出程式碼。

; 啟動10秒後沒有異常退出，就當作已經正常啟動了。預設1秒
startsecs=10

;該命令退出後，嘗試重新啟動的次數，預設3次
startretries=3

;當退出碼是多少時執行重啟。預設值0,2
exitcodes=0,2

;停止訊號
stopsignal=TERM

stopwaitsecs=10

;以哪個使用者執行該命令
user=root

;錯誤重定向
redirect_stderr=false

;輸出日誌檔案
stdout_logfile=/var/log/supervisor/printdate.log

;單個日誌檔案的最大容量
stdout_logfile_maxbytes=1MB

;最多幾個日誌檔案
stdout_logfile_backups=10

;錯誤日誌
stderr_logfile=/var/log/supervisor/printdateerr.log
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10

;環境變數設定
environment=A="1",B="2"

配置修改後，需要supervisorctl update後才可以生效

5：supervisord執行和關閉

service supervisor start
service supervisor stop
service supervisor restart

或者

sudo supervisord -c /etc/supervisor/supervisord.conf
sudo supervisorctl shutdown

6：檢視輸出

程式輸出到日誌檔案

cat /var/log/supervisor/printdate.log

7：操作supervisord

操作supervisord是通過supervisorctl
7.1：你可以進入supervisorctl的控制檯

sudo supervisorctl

7.2：也可以在shell中直接執行控制命令

sudo supervisorctl status

7.3：控制命令

printdate為[program:printdate]裡配置的值，這個示例就是printdate。

停止某一個程序
sudo supervisorctl stop printdate

啟動某個程序
sudo supervisorctl start printdate  

重啟某個程序
sudo supervisorctl restart printdate

重啟所有屬於名為groupworker這個分組的程序(start,restart同理)
sudo supervisorctl stop groupworker:

停止全部程序。注：start、restart、stop都不會載入最新的配置檔案。
sudo supervisorctl stop all

載入最新的配置檔案，停止原有程序並按新的配置啟動、管理所有程序。
sudo supervisorctl reload

根據最新的配置檔案，啟動新配置或有改動的程序，配置沒有改動的程序不會受影響而重啟。
sudo supervisorctl update

關閉supervisord
sudo supervisorctl shutdown

注意：顯示用stop停止掉的程序，用reload或者update都不會自動重啟。

8：官方文件

9：本文參考文件