使用supervisor进行进程管理

Posted 2021-02-13

简介：

 Supervisor是基于Python开发的进程管理程序，能将一个命令行进程转为后台daemon，可以替换nohup、&、screen等启动方案。还可以实现监控进程状态，当进程异常退出时能自动重启。它通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只须在supervisor的配置文件中，填写目标进程的执行命令配置即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。
 supervisor还可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理对应的进程。

安装：

1.easy_install 安装(使用默认python时，没有pip，可以用这个方法)：

easy_install supervisor

2.pip 安装：

pip install supervisor

3.Debian / Ubuntu可以直接通过apt安装：

apt-get install supervisor

4.Centos / Redhat安装需要安装epel源：

yum install -y epel-release
yum install -y supervisor

配置文件：

默认情况下会自动生成如下文件和目录：
默认配置文件： /etc/supervisord.conf
进程管理配置目录：/etc/supervisord.d/

没有生成上述信息的情况下，可自行创建。
可通过如下命令获取默认配置信息：

$ echo_supervisord_conf

生成配置文件supervisord.conf：

# echo_supervisord_conf > /etc/supervisord.conf

以下是部分配置文件的信息：

[unix_http_server]
file=/tmp/supervisor.sock   ; 通信文件路径，使用supervisorctl时候会调用
;chmod=0700                 ; socket文件的权限，默认是0700
;chown=nobody:nogroup       ; socket文件的owner，格式：uid:gid

;[inet_http_server]         ; web管理界面，默认关闭
;port=127.0.0.1:9001        ; Web管理后台运行的IP和端口，使用*:port开放访问

[supervisord]
logfile=/tmp/supervisord.log ; 日志文件，默认路径 $CWD/supervisord.log
logfile_maxbytes=50MB        ; 日志文件大小，超出会新建，默认50MB，0则不限
logfile_backups=10           ; 日志文件保留备份数量默认10，设为0表示不备份
loglevel=info                ; 日志级别，默认info，其它： debug,warn,trace
pidfile=/tmp/supervisord.pid ; pid文件
nodaemon=false               ; 是否在前台启动，默认是false
minfds=1024                  ; 可以打开的文件描述符的最小值，默认 1024
minprocs=200                 ; 可以打开的进程数的最小值，默认 200
;nocleanup=true              ; 启动的时候会清除临时文件

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; 通过UNIX socket连接supervisord
;serverurl=http://127.0.0.1:9001 ; 通过HTTP方式连接supervisord

;[program:theprogramname] 被管理进程的信息，可以单独配置*.ini
;command=/bin/cat              ; 程序启动命令
;process_name=%(program_name)s ; 进程名称
;numprocs=1                    ; 启动进程的数量
;autostart=true                ; supervisord运行的时候，保持进程的运行
;autorestart=unexpected        ; 自动重启
;startsecs=1                   ; N秒没异常推出则表示启动成功 (def. 1)
;startretries=3                ; 启动失败自动重试次数
;user=chrism                   ; 启动进程的用户，默认为root
;redirect_stderr=true          ; 把stderr重定向到stdout，默认fals
;priority=999                  ; 进程启动优先级，默认999，值小时优先启动

;[group:thegroupname]
;programs=progname1,progname2  ; 进程组
;priority=999                  ; 进程启动优先级，默认999，值小时优先启动

[include]    其他配置文件
files = relative/directory/*.ini  ;指定读取某目录下.ini后缀配置文件

自定义进程配置:

默认为/etc/supervisord.d目录，可通过上述include中files参数定义,如：

[program:redis]
command=/usr/bin/redis-server /home/redis/redis/redis-6389.conf
user=redis
stdout_logfile=/home/redis/redis/logs/run.log
autostart=true
autorestart=true
startsecs=10
ikillasgroup=true
startretries=1
redirect_stderr=true

启动supervisor服务：

可通过以下命令启动服务：

$ supervisord -c /etc/supervisor.conf

 当supervisord启动的时候根据配置信息生成sock、pid、log文件，并加载自定义配置信息，执行command指定的命令，若include模块开启，会自动检索files设定的目录的.ini文件，根据用户自定义配置文件执行相关命令。

常用命令：

$ supervisord -c supervisor.conf 通过配置文件启动
$ supervisor supervisorctl -c supervisor.conf status 查看状态
$ supervisorctl -c supervisor.conf reload 重新载入配置文件 
$ supervisorctl -c supervisor.conf start [all]|[x] 启动所有/指定的程序进程 
$ supervisorctl -c supervisor.conf stop [all]|[x] 关闭所有/指定的程序进程

也可通过supervisorctl进入supervisord的命令行客户端工具：

$ supervisorctl -c /etc/supervisord.conf

进入supervisorctl:

$ supervisorctl -c /home/elodes/www/warehouse/supervisor/supervisord.conf
gunicorn                RUNNING   pid 15501, uptime 2 days, 5:09:49
nginx                   STARTING
redis                   RUNNING   pid 15536, uptime 2 days, 5:09:48

使用help可以罗列出所有命令：

supervisor> help
default commands (type help <topic>):
=====================================
add clear fg open quit remove restart start stop update
avail exit maintail  pid reload reread shutdown status tail version

如关闭、开启指定的子进程：

supervisor> stop gogs
gogs: stopped
supervisor> start gogs
gogs: started

此外还有：

help                    # 查看帮助
status                  # 查看程序状态
stop program_name       # 关闭指定的程序
start program_name      # 启动指定的程序
restart program_name    # 重启指定的程序
tail -f program_name    # 查看该程序的日志
update                  # 更新进程配置文件
...

#也可以直接通过 shell 命令操作：
supervisorctl status
supervisorctl update
....

web界面操作：

开启web界面，需要在supervisor的配置文件里添加inet_http_server模块，reload后可通过localhost:9001访问，若开放其他机器访问需要将port=127.0.0.1:9001改为port=*:9001。

效果：

此外还可以基于xml_rpc进行调用，嵌入到自己的应用中使用

import xmlrpclib
p = xmlrpclib.Server(‘http://localhost:9001/RPC2‘)

查看服务端可用函数：

>>>server.system.listMethods()
[...
‘supervisor.getState‘, ... ‘supervisor.restart‘, ...
‘supervisor.shutdown‘, ‘supervisor.startAllProcesses‘, 
‘supervisor.startProcess‘, 
...]

详细的这里就不赘余了，想进行深度定制的项目可以参考官档

参考文档：
《进程管理supervisor的简单说明》：https://www.cnblogs.com/zhoujinyi/p/6073705.html
《supervisor 使用详解》：https://blog.csdn.net/zou79189747/article/details/80403016