Supervisor安裝、配置

本文更新於2021-01-06。

官方文檔參閱：http://supervisord.org/

目錄

• 安裝
  • CentOS下安裝
  • Debian下安裝
• 開機啟動
• 命令
• 配置
  • supervisord小節
  • program小節

安裝

CentOS下安裝

以CentOS 7.5 為例。

yum install supervisor

Debian下安裝

以Debian 8.9 (jessie)為例。

apt install supervisor

如使用的apt源找不到相應的包，可參考以下步驟：

通過vi /etc/apt/sources.list修改apt源為：

deb http://mirrors.163.com/debian/ jessie main non-free contrib
deb http://mirrors.163.com/debian/ jessie-updates main non-free contrib
deb http://mirrors.163.com/debian/ jessie-backports main non-free contrib
deb http://mirrors.163.com/debian-security/ jessie/updates main non-free contrib
deb-src http://mirrors.163.com/debian/ jessie main non-free contrib
deb-src http://mirrors.163.com/debian/ jessie-updates main non-free contrib
deb-src http://mirrors.163.com/debian/ jessie-backports main non-free contrib
deb-src http://mirrors.163.com/debian-security/ jessie/updates main non-free contrib

然后執行apt update。如出現"[Waiting for headers]"，則需執行以下命令再重新運行apt update：

cd /var/lib/apt/lists
rm *
rm partial/*

再執行apt install supervisor。

開機啟動

systemctl enable supervisord

命令

下述，“|”表示使用左側或右側，“<>”表示其括起的內容可選，“{}”表示其括起的內容為一個整體，“...”表示重復之前的內容，“PROGRAM”為配置中program小節設置的程序名。

• supervisorctl：進入命令行交互界面，可直接輸入子命令進行管理。
• supervisorctl reload：重新加載配置文件，並重啟supervisord及所有自動啟動的程序。
• supervisorctl restart all|{PROGRAM < ...>}：重啟程序，all表示重啟所有程序。
• supervisorctl start all|{PROGRAM <...>}：啟動程序，all表示啟動所有程序。
• supervisorctl status <all|{PROGRAM <...>}>：查看程序狀態，如為all或不指定則查看所有程序狀態。
• supervisorctl stop all|{PROGRAM <...>}：停止程序，all表示停止所有程序。
• supervisorctl update：重新加載配置文件，並啟動新配置指定的程序。

配置

CentOS中的配置文件為/etc/supervisord.conf，配置文件目錄為/etc/supervisord.d/，配置文件目錄中的配置文件后綴為.ini。
Debian中的配置文件為/etc/supervisor/supervisord.conf，配置文件目錄為/etc/supervisor/conf.d，配置文件目錄中的配置文件后綴為.conf。

自定義服務的配置文件最好放於配置文件目錄。每個配置文件可包含多個小節，使用“;”開頭進行注釋。

supervisord小節

修改此小節的內容需要使用systemctl restart supervisord重啟supervisord。

• [supervisord]：supervisord服務進程。
• minfds=N：supervisord服務進程啟動時必需的最少可用文件描述符數量，也是個program小節定義的被管理程序的最大可用文件描述符數量（即Max open files的值）。默認為1024。

配置示例如下（各配置均已被注釋）：

;[supervisord]
;logfile=/var/log/supervisor/supervisord.log ; (main log file;default $CWD/supervisord.log)
;pidfile=/var/run/supervisord.pid            ; (supervisord pidfile;default supervisord.pid)
;childlogdir=/var/log/supervisor             ; ('AUTO' child log dir, default $TEMP)
;minfds=1024

program小節

修改此小節的內容需要使用supervisorctl restart PROGRAM重啟被管理的程序。

• [program:PROGRAM]：被管理的程序名。可指定多個program小節。
• command=CMD：執行的命令，可帶參數。
• directory=DIR：執行命令時的進程運行目錄。
• autostart=AUTO：是否自動啟動。默認為true。
• autorestart=AUTO：是否自動重啟。為true、false或unexpected，默認為true。如為unexpected，當進程的退出碼不為exitcodes中的值時重啟。
• exitcodes=CODE1,CODE2：允許的進程退出碼。以“,”分隔，默認為0,2。
• stopsignal=SIGNAL：停止進程時發送的信號。默認為TERM。
• user=USER：執行命令使用的系統用戶。
• stdout_logfile=FILENAME：stdout的重定向日志文件。
• stderr_logfile=FILENAME：stderr的重定向日志文件。

配置示例如下（各配置均已被注釋）：

;[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=true              ; retstart at unexpected quit (default: true)
;startsecs=10                  ; 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)
;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)