Linux進程管理工具Supervisor的安裝配置

2021 年 2 月 24 日
筆記
linux

Linux進程管理工具Supervisor的安裝配置

Linux進程管理工具Supervisor的安裝配置

簡介

Supervisor是用Python開發的一個Client/Server服務，是Linux/Unix系統下的一個進程管理工具，不支援Windows系統。它可以很方便的監聽、啟動、停止、重啟一個或者多個進程。用Supervisor管理的進程，當一個進程意外被殺死，Supervisor監聽到進程死亡後，會自動將它重新拉起，很方便的做到進程自動回復的功能，不再需要自己寫Shell腳本控制。

因為Supervisor是Python開發的，安裝前先檢查一下系統是否安裝Python 2.4以上的版本。下面以CentOS 7環境介紹SuperVisor的安裝和配置。

安裝Python包管理工具

easy_install是setuptools包裡帶的一個命令，使用easy_install實際上是在調用setuptools來完成安裝模組的工作，所以安裝setuptools即可。

[root@localhost ~]# wget --no-check-certificate //bootstrap.pypa.io/ez_setup.py -O - | sudo python

安裝Supervisor

[root@VM-0-7-centos ~]# easy_install supervisor

supervisor安裝完成後會生成三個執行程式：supervisord、supervisorctl、echo_supervisord_conf，分別是supervisor的守護進程（用於接收管理命令）、客戶端（用於和守護進程通訊，發送管理進程的指令）、生成初始化配置文件程式。

配置

運行supervisord服務的時候，需要指定supervisor配置文件，如果沒有顯示指定，默認在以下路徑查找：

$CWD/supervisord.conf
$CWD/etc/supervisord.conf
/etc/supervisord.conf
/etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
../etc/supervisord.conf (Relative to the executable)
../supervisord.conf (Relative to the executable)

$CWD表示運行supervisord程式的目錄。

可以通過運行echo_supervisord_conf程式來生成supervisor的初始化配置文件，如下所示：

[root@VM-0-7-centos ~]# mkdir /etc/supervisor
[root@VM-0-7-centos ~]# echo_supervisord_conf > /etc/supervisor/supervisord.con

配置文件參數說明

supervisor的配置參數較多，下面介紹以下常用的參數配置，詳細的配置和說明，請參考官方文檔。

[unix_http_server]
file=/tmp/supervisor.sock   ; Unix Socker文件，supervisorctl使用
;chmod=0700                 ; socket文件許可權
;chown=nobody:nogroup       ; socket文件所屬組和所有者
;username=user              ; default is no username (open server)
;password=123               ; default is no password (open server)

;[inet_http_server]         ; HTTP伺服器，提供web管理介面
;port=127.0.0.1:9001        ; web管理後台運行的IP和埠
;username=user              ; 登錄管理後台的用戶名
;password=123               ; 登錄管理後台的密碼

[supervisord]
logfile=/tmp/supervisord.log ; 主日誌文件
logfile_maxbytes=50MB        ; 日誌文件大小，超出50M則進行切割
logfile_backups=10           ; 日誌文件包保留備份數量默認為10
loglevel=info                ; 日誌級別，默認為INFO，其他：debug、warn、trace
pidfile=/tmp/supervisord.pid ; PID文件
nodaemon=false               ; 是否在前台啟動，默認是false，即以daemon的方式啟動
silent=false                 ; no logs to stdout if true; default false
minfds=1024                  ; 可以打開的文件描述符的最小值。默認1024
minprocs=200                 ; 可以打開的進程數的最小值，默認為200
;umask=022                   ; process file creation umask; default 022
;user=supervisord            ; setuid to this UNIX account at startup; recommended 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. fals

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; 通過Unix Socket鏈接supervisord
;serverurl=//127.0.0.1:9001 ; 通過HTTP的方式鏈接supervisord
;username=chris              ; should be same as in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set

;[program:theprogramname]  [program:xx]是被管理的進程配置參數，xx是進程的名稱
;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                  ; 進程啟動優先順序，默認999，值小的優先啟動
;autostart=true                ; 在supervisor啟動的時候也啟動
;startsecs=1                   ; 在啟動1秒後沒有異常退出，就表示進程正常啟動了
;startretries=3                ; 啟動失敗自動重試次數，默認是3
;autorestart=unexpected        ; when to restart if exited after running (def: unexpected)
;exitcodes=0                   ; 'expected' exit codes used with autorestart (default 0)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; 默認為false，進程被殺死時，是否向這個進程組發送stop訊號，包括子進程
;killasgroup=false             ; 默認為false，向進程組發送kill訊號，包括紫禁城
;user=chrism                   ; 用哪個用戶啟動進程
;redirect_stderr=true          ; 把stderr重定向到stdout
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; stdout日誌文件大小，默認50MB
;stdout_logfile_backups=10     ; stdout日誌文件備份樹，默認是10
;stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stdout_syslog=false           ; send stdout to syslog with process name (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)
;stderr_syslog=false           ; send stderr to syslog with process name (default false)
;environment=A="1",B="2"       ; process environment additions (def no adds)
;serverurl=AUTO                ; override serverurl computation (childutils)

;[include]
;files = relative/directory/*.ini ; 可以指定一個或多個以.ini結束的配置文件

配置進程管理

進程管理配置參數，不建議全部寫在supervisord.conf文件中，應該每個進程寫一個配置文件放在include指定的目錄下包含進supervisord.conf文件中。

1）創建/etc/supervisor/config.d目錄，用於存放進程管理的配置文件；

2）修改/etc/supervisor/supervisord.conf中的include參數，將/etc/supercisor/conf.d目錄添加到include中。

[include]
files = /etc/supervisor/config.d/*.ini

下面時配置Tomcat進程的例子：

[program:tomcat]
command=/usr/local/tomcat/bin/catalina.sh run
stdout_logfile=/usr/local/tomcat/logs/catalina.out
autostart=true
autorestart=true
startsecs=5
priority=1
stopasgroup=true
killasgroup=true

啟動supervisor

[root@VM-0-7-centos ~]# supervisorctl -c /etc/supervisor/supervisord.conf

控制進程

交互終端

supervisord啟動成功後，可以通過supervisorctl客戶端控制進程，啟動、停止、重啟。運行supervisorctl命令，不加參數，會進入supervisor客戶端按的交互終端，並會列出當前所管理的所有進程。

上圖中的tomcat就是我們在配置文件中[program:tomcat]的名字。

輸入help命令可以查看可以執行的命令列表，如果想看某個命令的作用，輸入help命令名稱，如help stop

stop tomcat  # 表示停止Tomcat進程
stop all     # 表示停止所有進程

bash終端

supervisorctl reload  # 重啟supervisor
supervisorctl status  # 查看狀態
supervisorctl start tomcat
supervisorctl restart tomcat
supervisorctl reread
supervisorctl update

web管理介面

如果需要開啟web介面，則需要修改配置文件取消注釋

[root@VM-0-7-centos logs]# vim /etc/supervisor/supervisord.conf
[inet_http_server]         ; inet (TCP) server disabled by default
port=127.0.0.1:9001        ; ip_address:port specifier, *:port for all iface
;username=root              ; default is no username (open server)
;password=123456               ; default is no password (open server)
[root@VM-0-7-centos logs]#  supervisorctl reload

配置開啟自啟動supervisor

配置systemctl服務

1）進入/lib/systemd/system目錄，並創建supervisor.service文件

[Unit]
Description=supervisor
After=network.target

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown
ExecReload=/usr/bin/supervisorctl $OPTIONS reload
KillMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target

2）設置開機啟動

[root@VM-0-7-centos ~]# systemctl enable supervisor.service
[root@VM-0-7-centos ~]# systemctl daemon-reload

3）修改文件許可權為766

[root@VM-0-7-centos ~]# chmod 766 /lib/systemd/system/supervisor.service

配置service類型

#!/bin/bash
#
# supervisord   This scripts turns supervisord on
#
# Author:       Mike McGrath <[email protected]> (based off yumupdatesd)
#
# chkconfig:    - 95 04
#
# description:  supervisor is a process control utility.  It has a web based
#               xmlrpc interface as well as a few other nifty features.
# processname:  supervisord
# config: /etc/supervisor/supervisord.conf
# pidfile: /var/run/supervisord.pid
#

# source function library
. /etc/rc.d/init.d/functions

RETVAL=0

start() {
    echo -n $"Starting supervisord: "
    daemon "supervisord -c /etc/supervisor/supervisord.conf "
    RETVAL=$?
    echo
    [ $RETVAL -eq 0 ] && touch /var/lock/subsys/supervisord
}

stop() {
    echo -n $"Stopping supervisord: "
    killproc supervisord
    echo
    [ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/supervisord
}

restart() {
    stop
    start
}

case "$1" in
  start)
    start
    ;;
  stop) 
    stop
    ;;
  restart|force-reload|reload)
    restart
    ;;
  condrestart)
    [ -f /var/lock/subsys/supervisord ] && restart
    ;;
  status)
    status supervisord
    RETVAL=$?
    ;;
  *)
    echo $"Usage: $0 {start|stop|status|restart|reload|force-reload|condrestart}"
    exit 1
esac

exit $RETVAL

將上述腳本內容保存到/etc/rc.d/rc.local/supervisor文件中，修改文件許可權為755，並設置開機啟動

[root@VM-0-7-centos ~]# chmod 755 /etc/rc.d/init.d/supervisor
[root@VM-0-7-centos ~]# chkconfig supervisor on

Tags: linux