Linux程序管理工具Supervisor的安裝配置
阿新 • • 發佈:2021-02-24
[toc]
# 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即可。
```shell
[root@localhost ~]# wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
```
## 安裝Supervisor
```shell
[root@VM-0-7-centos ~]# easy_install supervisor
```
supervisor安裝完成後會生成三個執行程式:`supervisord`、`supervisorctl`、`echo_supervisord_conf`,分別是supervisor的守護程序(用於接收管理命令)、客戶端(用於和守護程序通訊,傳送管理程序的指令)、生成初始化配置檔案程式。
## 配置
執行supervisord服務的時候,需要指定supervisor配置檔案,如果沒有顯示指定,預設在以下路徑查詢:
```shell
$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的初始化配置檔案,如下所示:
```shell
[root@VM-0-7-centos ~]# mkdir /etc/supervisor
[root@VM-0-7-centos ~]# echo_supervisord_conf > /etc/supervisor/supervisord.con
```
## 配置檔案引數說明
supervisor的配置引數較多,下面介紹以下常用的引數配置,詳細的配置和說明,請參考官方文件。
```shell
[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=http://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中。
```shell
[include]
files = /etc/supervisor/config.d/*.ini
```
下面時配置Tomcat程序的例子:
```shell
[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
```shell
[root@VM-0-7-centos ~]# supervisorctl -c /etc/supervisor/supervisord.conf
```
## 控制程序
### 互動終端
supervisord啟動成功後,可以通過supervisorctl客戶端控制程序,啟動、停止、重啟。執行supervisorctl命令,不加引數,會進入supervisor客戶端按的互動終端,並會列出當前所管理的所有程序。
![image-20210224152131703](https://hzxyf.oss-cn-hangzhou.aliyuncs.com/hdlimage-20210224152131703.png)
上圖中的`tomcat`就是我們在配置檔案中`[program:tomcat]`的名字。
輸入help命令可以檢視可以執行的命令列表,如果想看某個命令的作用,輸入help命令名稱,如help stop
```shell
stop tomcat # 表示停止Tomcat程序
stop all # 表示停止所有程序
```
### bash終端
```shell
supervisorctl reload # 重啟supervisor
supervisorctl status # 檢視狀態
supervisorctl start tomcat
supervisorctl restart tomcat
supervisorctl reread
supervisorctl update
```
### web管理介面
如果需要開啟web介面,則需要修改配置檔案取消註釋
```shell
[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`檔案
```shell
[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)設定開機啟動
```shell
[root@VM-0-7-centos ~]# systemctl enable supervisor.service
[root@VM-0-7-centos ~]# systemctl daemon-reload
```
3)修改檔案許可權為766
```shell
[root@VM-0-7-centos ~]# chmod 766 /lib/systemd/system/supervisor.service
```
### 配置service型別
```shell
#!/bin/bash
#
# supervisord This scripts turns supervisord on
#
# Author: Mike McGrath (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,並設定開機啟動
```shell
[root@VM-0-7-centos ~]# chmod 755 /etc/rc.d/init.d/supervisor
[root@VM-0-7-centos ~]# chkconfig supervisor