Supervisor使用详解

一、supervisor简介

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

 

 

supervisor是所有项目的父进程：

supervisor(pid=29208)会成为主进程，管理各个项目的进程。

当项目A(pid=11531)挂掉，supervisor根据设置autorestart、startretries是否重启。

若要重启，则会重启项目A(pid=13357)，

若不重启，则项目A(pid=0)。

当supervisor被kill，管理的项目全部死掉，重启supervisor(pid=14140)，管理的项目都重启；

supervisor是如何知道某项目挂掉的？

子进程异常退出的时候，作为父进程肯定是能收到信号的。

1. 简单

   为啥简单呢？因为咱们通常管理linux进程的时候，一般来说都需要自己编写一个能够实现进程start/stop/restart/reload功能的脚本，然后丢到/etc/init.d/下面。这么做有很多不好的地方，第一我们要编写这个脚本，这就很耗时耗力了。第二，当这个进程挂掉的时候，linux不会自动重启它的，想要自动重启的话，我们还要自己写一个监控重启脚本。而，supervisor则可以完美的解决这些问题。好，怎么解决的呢，其实supervisor管理进程，就是通过fork/exec的方式把这些被管理的进程，当作supervisor的子进程来启动。这样的话，我们只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去就OK了。这样就省下了我们如同linux管理进程的时候，自己写控制脚本的麻烦了。第二，被管理进程作为supervisor的子进程，当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，所以当然也就可以对挂掉的子进程进行自动重启了，当然重启还是不重启，也要看你的配置文件里面有木有设置autostart=true了，这是后话。

2. 精确

   为啥说精确呢？因为linux对进程状态的反馈，有时候不太准确。为啥不准确？这个楼主也不知道啊，官方文档是这么说的，知道的告诉楼主一下吧，感激不尽。而supervisor监控子进程，得到的子进程状态无疑是准确的。

3. 进程组

   supervisor可以对进程组统一管理，也就是说咱们可以把需要管理的进程写到一个组里面，然后我们把这个组作为一个对象进行管理，如启动，停止，重启等等操作。而linux系统则是没有这种功能的，我们想要停止一个进程，只能一个一个的去停止，要么就自己写个脚本去批量停止。

4. 集中式管理

   supervisor管理的进程，进程组信息，全部都写在一个ini格式的文件里就OK了。而且，我们管理supervisor的时候的可以在本地进行管理，也可以远程管理，而且supervisor提供了一个web界面，我们可以在web界面上监控，管理进程。 当然了，本地，远程和web管理的时候，需要调用supervisor的xml_rpc接口，这个也是后话。

5. 有效性

   当supervisor的子进程挂掉的时候，操作系统会直接给supervisor发信号。而其他的一些类似supervisor的工具，则是通过进程的pid文件，来发送信号的，然后定期轮询来重启失败的进程。显然supervisor更加高效。。。至于是哪些类似supervisor工具，这个楼主就不太清楚了，楼主还听说过god,director，但是没用过。有兴趣的朋友可以玩玩

6. 可扩展性

   supervisor是个开源软件，牛逼点的，可以直接去改软件。不过咱们大多数人还是老老实实研究supervisot提供的接口吧，supervisor主要提供了两个可扩展的功能。一个是event机制，这个就是楼主这两天干的活要用到的东西。再一个是xml_rpc,supervisor的web管理端和远程调用的时候，就要用到它了。

7. 权限

   大伙都知道linux的进程，特别是侦听在1024端口之下的进程，一般用户大多数情况下，是不能对其进行控制的。想要控制的话，必须要有root权限。而supervisor提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程了。

   不过这功能，用不用就看大伙自己的环境了

二、Supervisor的安装

• 配置好yum源后，可以直接安装

  yum install supervisor
  

• Debian/Ubuntu可通过apt安装

  apt-get install supervisor
  

• pip安装（不推荐）

  pip install supervisor
  

• easy_install安装（不推荐）

  easy_install supervisor
  

三、Supervisor的使用

Supervisor 是一个 C/S 模型的程序，supervisord 是 server 端，supervisorctl 是 client 端。

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

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

子进程配置文件路径：/etc/supervisord.d/

注：默认子进程配置文件为ini格式，可在supervisor主配置文件中修改。

 

四、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是进程的名称，在 supervisorctl 中通过这个值来对程序进行一系列的操作
[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 = /etc/supervisor/conf.d/*.ini    ;可以指定一个或多个以.ini结束的配置文件,当然也可以是其他类型的文件

子进程配置文件说明：

给需要管理的子进程(程序)编写一个配置文件，放在/etc/supervisor.d/目录下，以.ini作为扩展名：

#项目名
[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:openfire]
environment = JAVA_HOME="/usr/local/xoa/jdk1.8"
command=/usr/local/xoa/openfire/bin/openfire run
startsecs=30

五、supervisorctl命令说明

supervisorctl 是 supervisord 的命令行客户端工具，使用的配置和 supervisord 一样，这里就不再说了。下面，主要介绍 supervisorctl 操作的常用命令：

输入命令 supervisorctl 进入 supervisorctl 的 shell 交互界面，就可以在下面输入命令了。：

• help # 查看帮助
• status # 查看程序状态
• stop program_name # 关闭 指定的程序
• start program_name # 启动 指定的程序
• restart program_name # 重启 指定的程序
• tail -f program_name # 查看 该程序的日志
• update # 重启配置文件修改过的程序（修改了配置，通过这个命令加载新的配置)

也可以直接通过 shell 命令操作：

supervisorctl status        //查看所有进程的状态
supervisorctl stop program_name       //停止指定程序
supervisorctl start program_name      //启动指定程序
supervisorctl restart program_name    //重启指定程序
5 supervisorctl update //配置文件修改后使用该命令加载新的配置 
supervisorctl reload //重新启动配置中的所有程序

注：把program_name换成all可以管理配置中的所有进程。

注意事项

使用supervisor进程管理命令之前先启动supervisord，否则程序报错。
使用命令supervisord -c /etc/supervisord.conf启动。
若是centos6：

service supervisord start
chkconfig supervisord on

若是centos7：

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

 六、常见错误

1、supervisor ERROR (spawn error)

 参考：https://blog.csdn.net/qq_33468857/article/details/86711841  

2、gave up: redis entered FATAL state, too many start retries too quickly

一般是因为进程启动太慢造成，在superisor的conf中的[program:xxxx]加入启动时间“startsecs=50”，如果还不行再加大。默认是1秒，重试3次。 

一般守护进程的做法就是fork一个子进程，父进程马上退出，以致于supervisor无法得到子进程的ID。

3、supervisor 没有保活程序的原因：

1、command中执行的程序是 后台进程、或者是立刻结束的shell脚本，或者是cron表达式，这些command马上就结束的，supervisor会认为程序已结束，并且重试3次（默认），发现始终起不来，就不再守护进程。supervisorctl命令能看出进程的监控状态，RUNNING是正常的。

2、看配置文件里面有木有设置autostart=true

注意：

1、supervisor主要适用于监控前台服务。书写命令时最好以前台命令运行

2、supervisor子进程如需要依赖环境变量才可启动，写上environment 参数

更多好文：

https://www.cnblogs.com/549294286/p/9229868.html