CentOS 7.9 Supervisor 的安装 配置 使用
CentOS 7.9 Supervisor 的安装 配置 使用
一、Supervisor 简介
1、功能说明
Supervisor 是一个进程控制系统，可以用来监视并控制类 UNIX 系统上服务的进程。
功能：当服务进程意外停止时，能让服务自动完成重启，确保服务一直处于运行状态。
2、应用场景
可以将生产中需要长期运行且运行模式是非守护进程(daemonize)的服务托管在Supervisor上，如Java、Python等服务进程以及用于监控收集数据的服务进程，都可以交由Supervisor来管理。
3、官网地址
二、Supervisor 安装配置
1、CentOS 7.9 安装 Supervisor
Supervisor 的 rpm 包位于 epel 源中，所以安装 Supervisor 前需要先安装 epel-release
yum install -y epel-release && yum install -y supervisor
2、配置 Supervisor
修改 /etc/supervisord.conf 配置文件，修改如下：
; Sample supervisor config file.
[unix_http_server]
file=/var/run/supervisor/supervisor.sock ; (the path to the socket file)
chmod=0700 ; sockef file mode (default 0700)
;chown=nobody:nogroup ; socket file uid:gid owner
username=miracle ; (default is no username (open server))
password=luna ; (default is no password (open server))
[inet_http_server] ; inet (TCP) server disabled by default
port=0.0.0.0:9001 ; (ip_address:port specifier, *:port for all iface)
username=miracle ; (default is no username (open server))
password=1234 ; (default is no password (open server))
[supervisord]
logfile=/var/log/supervisor/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)
;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/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=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)
; 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 ; restart at unexpected quit (default: unexpected)
;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_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 = supervisord.d/*.ini
3、开放防火墙的 9001 端口
开放 9001 端口，可以通过浏览器访问 Supervisor 服务的管理页面。
1）开启防火墙 9001 端口
firewall-cmd --zone=public --add-port=9001/tcp --permanent
2）重新加载防火墙配置
firewall-cmd --reload
3）查看防火墙开放的端口
firewall-cmd --zone=public --list-ports
4、Supervisor 配置 systemctl 服务
1）配置 supervisor.service 系统文件
编辑命令如下：
vi /usr/lib/systemd/system/supervisor.service
配置内容如下：
[Unit]
Description=supervisor
After=network.target
[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/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）重新加载系统配置
systemctl daemon-reload
3）设置 Supervisor 服务开机自启动
systemctl enable supervisor
4）检查开机自启动设置
systemctl is-enabled supervisor
5）查看 Supervisor 服务状态
systemctl status supervisor
6）启动 Supervisor 服务
systemctl start supervisor
7）停止 Supervisor 服务
systemctl stop supervisor
8）重启 Supervisor 服务
systemctl restart supervisor
三、Supervisor 使用
以 SpringBoot 工程为例说明 Supervisor 的使用方式，并演示使用效果。
1、创建 SpringBoot 工程
创建一个 SpringBoot 工程，实现对 Sqlite 数据库数据的访问，工程目录结构如下：
2、打包部署到 Linux 机器
将 sqlite-demo 工程打包，部署到 Supervisor 服务所在的机器上，部署目录为 /opt/sqlite/，并在 /opt/sqlite/bin/ 目录下创建启动文件 sqlite.sh
sqlite.sh 内容如下：
#!/bin/bash
java -jar /opt/sqlite/sqlite-demo-0.0.1-SNAPSHOT.jar
3、配置 Supervisor 控制文件
在 /etc/supervisord.d 目录下创建控制文件 sqlite.ini
sqlite.ini 文件内容如下：
[program:sqlite]
stopasgroup=true
user=root
environment=JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.352.b08-2.el7_9.x86_64
directory=/opt/sqlite/
command=sh /opt/sqlite/bin/sqlite.sh
redirect_stderr=true
stdout_logfile=/opt/sqlite/logs/out.log
stderr_logfile=/opt/sqlite/logs/out.err
其中，JAVA_HOME 可以通过如下命令获取（个人安装的 OpenJDK 所在目录为：/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.352.b08-2.el7_9.x86_64）：
echo $JAVA_HOME
三、supservisorctl 命令
1、查看 Supervisor 所管理的所有服务
个人配置的账号为：miralce，密码为：luna
（默认是没有账号和密码的，出于安全考虑，可以根据实际情况在配置文件中进行设置）
命令如下：
supervisorctl
或者
supervisorctl --username miracle --password luna
或者
supervisorctl -u miracle -p luna
从上图可知，目前管理的服务名为 sqlite （状态为： RUNNING）
2、查看某个服务的状态
status sqlite
3、停止某个服务
stop sqlite
4、启动某个服务
start sqlite
5、重启某个服务
restart sqlite
6、停止所有服务
stop all
7、启动所有服务
start all
8、重启所有服务
restart all
9、查看所有服务状态
status all
四、Supervisor 管理页面
Supervisor 管理页面的访问地址如下：
http://实际的 IP 地址:9001
注意：
如果配置文件 /etc/supervisord.conf 中没有设置访问账号和密码，通过浏览器可以直接访问管理页面；
如果配置文件 /etc/supervisord.conf 中设置了访问账号和密码，需要输入设置的账号和密码（如案例中设置的账号：miracle，密码：1234），才可以通过浏览器访问管理页面。
登录成功后，管理页面效果如下：
说明：
从上图页面可知，除了通过 supervisorctl 命令对服务进行管理和控制外，也可以通过管理页面上的功能按钮，直接对 Supervisor 所管理的服务进行控制，如：refresh、restart all、stop all、restart、start、stop、tail -f 等。
如：tail -f 功能按钮的效果如下：
管理页面的功能演示，录屏效果如下：
PS：
当 Supervisor 管理的服务进程被意外断开时，Supervisor 会自动重启管理的服务，保证服务的连续性。
效果如下：
说明：将示例中的 sqlite 相关进程（PID 为 4770） kill 掉，Supervisor 会自动启动一个新的进程（PID 为 11509）。
