Supervisor安装及使用

1.简介

官网为 http://supervisord.org/
A Process Control System
使用b/s架构、运行在类Unix系统上一个进程监控管理系统
它可以使进程以daemon方式运行，并且一直监控进程，在意外退出时能自动重启进程。

2.安装部署

#安装supervisor
$ wget -O /etc/yum.repos.d/epel.repo http://mirrors.aliyun.com/repo/epel-7.repo^ && yum clean all && yum  makecache
$ yum install supervisor -y 
$ mkdir /etc/supervisor
#生成supervisor配置文件
$ echo_supervisord_conf > /etc/supervisor/supervisord.conf
#启动supervisor
$ supervisord -c /etc/supervisor/supervisord.conf

3.使用supervisor管理应用

首先需要熟悉下配置文件

[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
directory=/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=root                        ; 以指定用户身份启动程序。默认为当前用户。
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)

4.常用命令

supervisor进程管理工具，可以方便启动停止进程，查看程序日志，重新载入配置文件。
如果supervisord配置文件不再默认位置，使用supervisorctl工具时需要指定配置文件路径 supervisordctl -c 配置文件路径
常用命令

$ supervisordctl status 查看进程运行状态
$ supervisordctl start 进程名 启动进程
$ supervisordctl stop 进程名 关闭进程
$ supervisordctl restart 进程名 重启进程
$ supervisordctl update 重新载入配置文件
$ supervisordctl shutdown 关闭supervisord
$ supervisordctl clear 进程名 清空进程日志
$ supervisordctl 进入到交互模式下。使用help查看所有命令。
$ start stop restart + all 表示启动，关闭，重启所有进程。

• 注:如果修改了配置文件加入了新的program，需要执行update后然后再使用start启动新的服务

5.使用进阶

以上是基础用法，在使用过程中，supervisor有一些比较好用的高级用法可以方便我们对服务的管理

5.1 使用服务组管理服务

[group:demogroup]             ; ；这个东西就是给programs分组，划分到组里面的program。我们就不用一个一个去操作了我们可以对组名进行统一的操作。
programs=app1,app2            ; 组成员，用逗号分开这个是个必须的设置项
priority=999                  ; 优先级，相对于组和组之间说的默认999。。非必须选项

# 控制组内单个服务
$ supervisordctl start/stop/restart/status demogroup:app1
# 控制组内所有服务
$ supervisordctl start/stop/restart/status demogroup:*

5.2 一些常用demo参考

[program:App_name]
directory = /data1/workspace/App_name/main ; 程序的启动目录
command = /usr/local/python-2.7/bin/python ./api_main.py --port=78%(process_num)02d  ; 启动命令，可以看出与手动在命令行启动的命令是一样的
process_name=%(program_name)s_%(process_num)02d ; 
numprocs=4
numprocs_start=1
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 5        ; 启动 5 秒后没有异常退出，就当作已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数，默认是 3
redirect_stderr = true  ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 5     ; stdout 日志文件备份数
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile = /etc/supervisord.conf.d/App_name.log
stopwaitsecs=2