当前位置: 首页 > 工具软件 > Supervisord > 使用案例 >

进程管理程序supervisord-快速开始

亢嘉茂
2023-12-01

进程管理程序supervisord-快速开始

什么是Supervisor

Supervisor官网地址:http://supervisord.org/

Supervisor 是一个用 Python 写的进程管理工具,可以很方便的用来在 UNIX-like 系统(不支持 Windows)下启动、重启(自动重启程序)、关闭进程(不仅仅是 Python 进程)。

Supervisor是一个client/server系统,它容许用户在UNIX-like操作系统上监控和控制一定数据量的进程。

通过supervisorctl客户端来控制supervisord守护进程服务,真正进行进程监听的是supervisorctl客户端,而运行supervisor服务时是需要制定相应的supervisor配置文件的。

Supervisord存在的缺陷

  1. supervisor无法检测后台启动进程的pid,而supervisor本身就是后台启动守护进程。
    Supervisor要求管理的程序是非后台式的程序(not daemon program),因为Supervisord会自动帮你将要管理的进程转为后台进程,如果原本就是后台进程就存在问题,比如要使用Supervisor管理nginx,nginx就需要在配置文件中添加daemon off 让nginx以非后台运行形式启动。

  2. Supervisor不支持windows,只支持类UNIX系统,如Centos、Ubuntu、MacOS

  3. Supervisor管理的进程必须由supervisord启动,即已启动的程序是无法使用supervisord进行管理的。

Supervisor安装

可以使用PIP安装:

pip install supervisor

yum install supervisor

配置

安装好后在/etc/会生成一个supervisord.conf文件及一个supervisord.d文件目录

supervisor配置文件
supervisor分为主配置文件和子配置文件,方便起见,把supervisor服务器相关的配置写入supervisord.conf中,把监控各个进程的配置,按照进程名存在 supervisord.conf 目录下。

不过你也可以都写在supervisord.conf中。

[unix_http_server]
file=/var/run/supervisor/supervisor.sock   ; UNIX socket 文件,supervisorctl 会使用
;chmod=0700                 ; socket 文件的 mode,默认是 0700
;chown=nobody:nogroup       ; socket 文件的 owner,格式: uid:gid

;web管理(不常用)
;[inet_http_server]         ; HTTP 服务器,提供 web 管理界面
;port=127.0.0.1:9001        ; Web 管理后台运行的 IP 和端口,如果开放到公网,需要注意安全性
;username=user              ; 登录管理后台的用户名
;password=123               ; 登录管理后台的密码

[supervisord]
logfile=/var/log/supervisor/supervisord.log ; 日志文件,默认是 $CWD/supervisord.log
logfile_maxbytes=50MB        ; 日志文件大小,超出会 rotate,默认 50MB
logfile_backups=10           ; 日志文件保留备份数量默认 10
loglevel=info                ; 日志级别,默认 info,其它: debug,warn,trace
pidfile=/var/run/supervisord.pid ; pid 文件
nodaemon=false               ; 是否在前台启动,默认是 false,即以 daemon 的方式启动
minfds=1024                  ; 可以打开的文件描述符的最小值,默认 1024
minprocs=200                 ; 可以打开的进程数的最小值,默认 200

; 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 ; 通过 UNIX socket 连接 supervisord,路径与 unix_http_server 部分的 file 一致
;serverurl=http://127.0.0.1:9001 ; 通过 HTTP 的方式连接 supervisord

; 包含其他的配置文件
;子进程配置文件路径:/etc/supervisord.d/*.ini
;注:默认子进程配置文件为ini格式,可在supervisor主配置文件中修改。
[include]
files = supervisord.d/*.ini    ; 可以是 *.conf 或 *.ini   

子进程配置文件

[program:theprogramname]
command=/bin/cat              ; 程序运行命令,建议使用绝对路径。
process_name=%(program_name)s ; 程序名称,可用的变量有 `group_name`, `host_node_name`, `process_num`, `program_name`, `here`(配置文件目录)。 一般程序需要运行多个副本的情况会使用。后面会有例子。
numprocs=1                    ; 程序运行的副本个数,默认为1,如果值大于1,则`process_name` 必须包含 `%(process_num)s`
numprocs_start=0              ; `%(process_num)s`起始数字,默认为0
00=/tmp                       ; 程序运行的所在目录,相当于先cd到指定目录,然后运行程序。
umask=022                     ; umask for process (default None)
priority=999                  ; 程序操作的的优先级,例如在start all/stop all,高优先级的程序会先关闭和重启。
autostart=true                ; 在supervisord启动时自动启动,默认为true
startsecs=1                   ; 程序启动前等待时间等待时间。默认为1。
startretries=3                ; 尝试重启最大次数。默认为3。
autorestart=unexpected        ; 是否自动重启,可选参数为 false, unexpected, true。如果为false则不自动重启,如果为unexpected表示如果程序退出信号不在 `exitcodes` 中,则自动重启。默认为unexpected
exitcodes=0,2                 ; 程序退出码。配合`autorestart`使用。默认为 0,2
stopsignal=QUIT               ; 杀死进程时发送的信号,默认为TREM。
stopwaitsecs=10               ; 发送SIGKILL信号前最大等待时间。默认为10。
user=dev                      ; 以指定用户身份启动程序。默认为当前用户。
stopasgroup=false             ; 是否向子进程发送停止信号,这对于Flask的debug模式很有用处,如果设置为true,则不向子进程发送停止信号。默认为false
killasgroup=false             ; 是否向子进程发送kill信号,默认为false
redirect_stderr=false         ; 将错误输出定向到标准输出,默认为false
stdout_logfile=/a/path        ; 标准输出日志路径,可选参数为 `自定义` `AUTO` `NONE`,`自定义`将日志写到自定义路径,可用的变量有`group_name`, `host_node_name`, `process_num`, `program_name`, `here`(配置文件目录);`NONE`不创建日志;`AUTO` 又supervisord自动选择路径,并且当supervisord服务重新启动时原来自动创建的日志以及日志的备份文件会被删除。默认为AUTO
stdout_logfile_maxbytes=1MB   ; 标准输出日志单个文件最大大小,如果超过指定大小会将日志文件备份,可用的单位 KB MB GB。如果设置为0则表示不限制文件大小。默认为50MB
stdout_logfile_backups=10     ; 标准输出日志文件最大备份数。默认为10
stdout_capture_maxbytes=1MB   ; 当进程处于“stdout capture mode”模式下写入到FIFO队列最大字节数,可用单位 KB MB GB。默认为0,详细说明见[capture-mode](http://supervisord.org/logging.html#capture-mode)
stdout_events_enabled=false   ; 
                              ;以下配置项配置错误输出的日志参数。和上面标准输出配置相同。
stderr_logfile=/a/path        ;
stderr_logfile_maxbytes=1MB   ;
stderr_logfile_backups=10     ;
stderr_capture_maxbytes=1MB   ;
stderr_events_enabled=false   ;
environment=A="1",B="2"       ; 环境变量设置,可用的变量有 `group_name`, `host_node_name`, `process_num`, `program_name`, `here`。 默认为空。
serverurl=AUTO                ; override serverurl computation (childutils)
  • 注意: 分号后面是注释。如果在配置后面 加分号注释,分号前面记得补一个空格
  • 大多数情况下建议开启 stopasgroup=true,这样使用 supervisorctl 进行 stop 的时候,会把子进程一起杀掉,不然可能只杀父进程没杀子进程,而如果你的 program 是占用端口的服务时,下次 supervisorctl start 可能会失败。

Supervisord工具的使用流程

1、首先通过命令echo_supervisord_conf 生成配置文件模板
2、启动时指定配置文件

supervisord -c /etc/supervisord.conf

supervisorctl客户端会将对应的信息传递给supervisord守护进程服务,让supervisord守护进程服务进行进程守护。

3、进入ctl模式

supervisorctl 
supervosorctl help 查看命令帮助
supervosorctl status  查看状态
supervosorctl stop  XXX  停止某一个进程
supervosorctl start  XXX  启动某个进程
supervosorctl restart  XXX  重启某个进程
supervosorctl reload  载入最新的配置文件,停止原有进程并按新的配置启动、管理所有进程
supervosorctl update 根据最新的配置文件,启动新配置或有改动的进程,配置没有改动的进程不会受影响而重启。

Supervisor配置systemctl服务

  1. 新建配置文件
vim  /usr/lib/systemd/system/supervisor.service

2、内容如下

[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

3、使用systemctl启动

systemctl daemon-reload
systemctl start supervisor.service
systemctl status supervisor.service

4、设置开机自启

systemctl enable supervisor.service

工作常用技巧

程序挂了,不让supervisord帮我拉起

问题描述:
一些场景下,我们为了测试验证问题,我们需要 程序挂了,不让supervisord帮我拉起

解决方案:
配置选项:
autorestart=unexpected ; 是否自动重启,可选参数为 false, unexpected, true。如果为false则不自动重启,如果为unexpected表示如果程序退出信号不在 exitcodes 中,则自动重启。默认为unexpected

supervisor程序启动优先级(顺序)

配置关键字: priority决定程序优先级

priority=1 ; 数字越高,优先级越高

参考

进程管理工具——Supervisord简介及安装
参考URL: https://blog.csdn.net/xu710263124/article/details/116047899
supervisor程序启动优先级
参考URL: https://www.kkwen.cn/index.php/archives/28/

 类似资料: