进程管理器supervisor

一、supervisor 简介

Supervisor 是用 Python 开发的一套通用的过程管理程序，能将一个一般的命令行过程变为后盾 daemon，并监控过程状态，异样退出时能主动重启。它是通过 fork/exec 的形式把这些被治理的过程当作 supervisor 的子过程来启动，这样只有在 supervisor 的配置文件中，把要治理的过程的可执行文件的门路写进去即可。也实现当子过程挂掉的时候，父过程能够精确获取子过程挂掉的信息的，能够抉择是否本人启动和报警。supervisor 还提供了一个性能，能够为 supervisord 或者每个子过程，设置一个非 root 的 user，这个 user 就能够治理它对应的过程。

注：本文以 centos7 为例，supervisor 版本 3.4.0。

二、supervisor 装置

• 配置好 yum 源后，能够间接装置

  yum install supervisor

• Debian/Ubuntu 可通过 apt 装置

  apt-get install supervisor

• pip 装置

  pip install supervisor

• easy_install 装置

  easy_install supervisor

三、supervisor 应用

supervisor 配置文件：/etc/supervisord.conf

注：supervisor 的配置文件默认是不全的，不过在大部分默认的状况下，下面说的基本功能曾经满足。

子过程配置文件门路：/etc/supervisord.d/

注：默认子过程配置文件为 ini 格局，可在 supervisor 主配置文件中批改。(装置办法不同子过程配置文件门路不同)

四、配置文件阐明

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=/opt/apache-tomcat-8.0.35/bin/catalina.sh run  ; 程序启动命令
autostart=true       ; 在 supervisord 启动的时候也主动启动
startsecs=10         ; 启动 10 秒后没有异样退出，就示意过程失常启动了，默认为 1 秒
autorestart=true     ; 程序退出后主动重启, 可选值：[unexpected,true,false]，默认为 unexpected，示意过程意外杀死后才重启
startretries=3       ; 启动失败主动重试次数，默认是 3
user=tomcat          ; 用哪个用户启动过程，默认是 root
priority=999         ; 过程启动优先级，默认 999，值小的优先启动
redirect_stderr=true ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 20   ; stdout 日志文件备份数，默认是 10
; stdout 日志文件，须要留神当指定目录不存在时无奈失常启动，所以须要手动创立目录（supervisord 会主动创立日志文件）stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false     ; 默认为 false, 过程被杀死时，是否向这个过程组发送 stop 信号，包含子过程
killasgroup=false     ; 默认为 false，向过程组发送 kill 信号，包含子过程
 
; 蕴含其它配置文件
[include]
files = relative/directory/*.ini    ; 能够指定一个或多个以.ini 完结的配置文件

子过程配置文件阐明：

给须要治理的子过程 (程序) 编写一个配置文件，放在 /etc/supervisor.d/ 目录下，以 .ini 作为扩展名（每个过程的配置文件都能够独自分拆也能够把相干的脚本放一起）。如任意定义一个和脚本相干的项目名称的选项组（/etc/supervisord.d/test.conf）：

# 我的项目名
[program:blog]
#脚本目录
directory=/opt/bin
#脚本执行命令
command=/usr/bin/python /opt/bin/test.py

#supervisor 启动的时候是否随着同时启动，默认 True
autostart=true
#当程序 exit 的时候，这个 program 不会主动重启, 默认 unexpected，设置子过程挂掉后主动重启的状况，有三个选项，false,unexpected 和 true。如果为 false 的时候，无论什么状况下，都不会被重新启动，如果为 unexpected，只有当过程的退出码不在上面的 exitcodes 外面定义的
autorestart=false
#这个选项是子过程启动多少秒之后，此时状态如果是 running，则咱们认为启动胜利了。默认值为 1
startsecs=1

#脚本运行的用户身份 
user = test

#日志输入 
stderr_logfile=/tmp/blog_stderr.log 
stdout_logfile=/tmp/blog_stdout.log 
#把 stderr 重定向到 stdout，默认 false
redirect_stderr = true
#stdout 日志文件大小，默认 50MB
stdout_logfile_maxbytes = 20M
#stdout 日志文件备份数
stdout_logfile_backups = 20

子过程配置示例：

# 阐明同上
[program:test] 
directory=/opt/bin 
command=/opt/bin/test
autostart=true 
autorestart=false 
stderr_logfile=/tmp/test_stderr.log 
stdout_logfile=/tmp/test_stdout.log 
#user = test  

五、supervisor 命令阐明

常用命令

supervisorctl status        // 查看所有过程的状态
supervisorctl stop es       // 进行 es
supervisorctl start es      // 启动 es
supervisorctl restart       // 重启 es
supervisorctl update        // 配置文件批改后应用该命令加载新的配置
supervisorctl reload        // 重新启动配置中的所有程序

注：把 es 换成 all 能够治理配置中的所有过程。间接输出 supervisorctl 进入 supervisorctl 的 shell 交互界面，此时下面的命令不带 supervisorctl 可间接应用。

注意事项

应用 supervisor 过程治理命令之前先启动 supervisord，否则程序报错。
应用命令 supervisord -c /etc/supervisord.conf 启动。
若是 centos7：

systemctl start supervisord.service     // 启动 supervisor 并加载默认配置文件
systemctl enable supervisord.service    // 将 supervisor 退出开机启动项

##### 常见问题

1. unix:///var/run/supervisor.sock no such file
   问题形容：装置好 supervisor 没有开启服务间接应用 supervisorctl 报的错
   解决办法：supervisord -c /etc/supervisord.conf
2. command 中指定的过程曾经起来，但 supervisor 还一直重启
   问题形容：command 中启动形式为后盾启动，导致辨认不到 pid，而后一直重启，这里应用的是 elasticsearch，command 指定的是 $path/bin/elasticsearch -d
   解决办法：supervisor 无奈检测后盾启动过程的 pid，而 supervisor 自身就是后盾启动守护过程，因而不必放心这个
3. 启动了多个 supervisord 服务，导致无奈失常敞开服务
   问题形容：在运行 supervisord -c /etc/supervisord.conf 之前，间接运行过 supervisord -c /etc/supervisord.d/xx.conf 导致有些过程被多个 superviord 治理，无奈失常敞开过程。
   解决办法：应用 ps -fe | grep supervisord 查看所有启动过的 supervisord 服务，kill 相干的过程。

更多信息请移步 Supervisor 官网：http://supervisord.org