supervisor 的简单配置和使用

Supervisor初识

测试工作中接触到进程管理工具，学习并记录

简介

是一个使用Python开发的通用的进程管理工具，可以分为两部分来理解：supervisord、supervisorctl

1. supervisord
   启动supervisor后会运行一个supervisord进程，按通常的理解上后面带d的基本都是守护进程，负责启动和管理supervisor中的进程，当进程崩溃时能够自动重启。
2. supervisorctl ；
   supervisor的管理工具，理解为docker的客户端，用来执行命定，对进程进行管理，常用命令start、stop、restart，控制进程的启停和重启。

安装

直接pip install supervisor，安装之前记得更新pip

配置

1. 初始化supervisor.conf
   echo_supervisord_conf 会将配置文件打印出来用于查看
   echo_supervisord_conf > /etc/supervisord.conf 用于生成配置文件到指定路径

2. 查看supervisor.conf文件中的配置内容

#配置文件分为几部分：
[unix_http_server]
file=/tmp/supervisor.sock   ;UNIX socket 文件，supervisorctl 会使用
;chmod=0700                 ;socket文件的mode，默认是0700
;chown=nobody:nogroup       ;socket文件的owner，格式：uid:gid

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

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

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord

#[program:xx]是被管理的进程配置参数，xx是进程的名称
[program:xx]
command=/bin/cat     ; 程序启动命令
autostart=true       ; 在supervisord启动的时候也自动启动
startsecs=10         ; 启动10秒后没有异常退出，就表示进程正常启动了，默认为1秒
autorestart=true     ; 程序退出后自动重启,可选值：[unexpected,true,false]，默认为unexpected，表示进程意外杀死后才重启
startretries=3       ; 启动失败自动重试次数，默认是3
user=root            ; 用哪个用户启动进程，默认是root
priority=999         ; 进程启动优先级，默认999，值小的优先启动
redirect_stderr=true ; 把stderr重定向到stdout，默认false
stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小，默认50MB
stdout_logfile_backups = 20   ; stdout 日志文件备份数，默认是10
stdout_logfile=/a/path ; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stopasgroup=false     ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false     ;默认为false，向进程组发送kill信号，包括子进程

;包含其它配置文件
[include]
files = relative/directory/*.ini    ;可以指定一个或多个以.ini结束的配置文件

3. supervisor.conf文件间的引用
   当配置文件的内容较多时，按我们通常不会将所有配置内容放在一个配置文件中，会编辑多个子配置文件，然后在总的配置文件中将子配置文件引入，这样逻辑会更清晰也便于维护，在主配置文件中加入：

[include]
files = /etc/supervisor/conf.d/*.conf

运行

1. 向supervisor中添加一个程序
   新建一个配置文件test.conf用于配置要运行的进程程序，并在supervisor.conf中引用该文件，文件内容如下，具体的属性参数根据实际需要进行增删。

[program:test_yzb]
process_name=%(program_name)  # 进程的名称    
directory=/tmp/        # 想要运行的文件所在目录
command=python test_yzb.py  # 运行命令
autostart=true         # 是否自动启动
autorestart=true       # 是否重启
startsecs=2            # 启动10秒后没有异常退出，就表示进程正常启动了，默认为1秒
startretries=3         # 启动失败自动重试次数，默认是3  
stopsignal=QUIT        # 请求停止时用于终止程序的信号。可以是TERM，HUP，INT，QUIT，KILL，USR1或USR2中的任何一个

2. 运行supervisord、supervisorctl
   运行supervisord：
   supervisord -c /etc/supervisord.conf
   运行supervisorctl：
   supervisorctl -c /etc/supervisord.conf
   ==== 至此程序已经运行并被supervisor管理====
3. 修改&&增加配置文件
   如果只修改了配置文件，只需要让supervisor.d重新加载一下配置就行，这一过程只会重新加载有修改的配置文件：
   update：supervisorctl update
   如果新增了配置文件，重新加载就不奏效了，需要reload或者reread，reload会重启配置中的多有程序，reread不会重新启动。
   reload：supervisorctl reload
   reread：supervisorctl reread

查看&&操作进程

1. 查看进程
   supervisorctl
2. 操作进程
   stop：pervisorctl stop <program_name>
   start：pervisorctl start <program_name>
   restart：pervisorctl restart <program_name>