官网地址：
https://pypi.org/project/supervisor/
http://supervisord.org/
本文参考：https://www.jianshu.com/p/0b9054b33db3
一、supervisor简介
supervisor是用Python开发的一套通用的进程管理程序，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程。
- supervisord
运行supervisor时会启动一个进程supervisord，它负责启动所管理的进程，并将所管理的进程作为自己的子进程来启动，而且可以在所管理的进程出现崩溃时自动重启。 - supervisorctl
是命令行管理工具，可以用来执行 stop、start、restart 等命令，来对这些子进程进行管理。
supervisor是所有进程的父进程，管理着启动的子进程，supervisor以子进程的PID来管理子进程，当子进程异常退出时supervisor可以收到相应的信号量。
supervisor的好处：
-
1.简单
管理linux进程的时候，一般来说需要自己编写一个能够实现进程start/stop/restart/reload功能的脚本，然后放在/etc/init.d/下面。这么做有很多不好的地方，第一要编写这个脚本。第二，当这个进程挂掉的时候，linux不会自动重启，想要自动重启的话，还要写一个监控重启脚本。而supervisor则可以解决这些问题。supervisor管理进程是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动。只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去就行了。省下linux管理进程时写控制脚本的麻烦了。第二，被管理进程作为supervisor的子进程，当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息，所以可以对挂掉的子进程进行自动重启，当然重启还是不重启要看配置文件里面是否设置autostart=true了。 -
2.精确
linux对进程状态的反馈有时不太准确。而supervisor监控子进程，得到的子进程状态是准确的。 -
3.进程组
supervisor可以对进程组统一管理，也就是可以把需要管理的进程写到一个组里面，然后把这个组作为一个对象进行管理，如启动，停止，重启等等操作。而linux系统则是没有这种功能的，要停止一个进程，只能一个一个的去停止，要么就写个脚本去批量停止。 -
4.集中式管理
supervisor管理的进程，进程组信息，全写在一个ini格式的文件里。管理supervisor的时候可以在本地进行管理，也可以远程管理，而且supervisor提供了一个web界面，可以在web界面上监控，管理进程。本地，远程和web管理的时候，需要调用supervisor的xml_rpc接口。 -
5.有效性
当supervisor的子进程挂掉的时候，操作系统会直接给supervisor发信号。而其他类似supervisor的工具是通过进程的pid文件来发送信号，然后定期轮询来重启失败的进程。显然supervisor更加高效。类似supervisor的工具有god，director。 -
6.可扩展性
supervisor是个开源软件，主要提供了两个可扩展的功能。一个是event机制，再一个是xml_rpc，supervisor的web管理端和远程调用的时候。 -
7.权限
linux进程，特别是侦听在1024端口之下的进程，一般用户大多数情况下是不能对其进行控制的。想要控制的话必须要有root权限。而supervisor提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程了。 -
8.兼容性
-
9.稳定性
二、supervisor安装
centos/redhat系统中，配置好yum源后，可以直接安装
yum install supervisor –y
三、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结束的配置文件
注：配置文件一般为下面这样的配置：
grep -v ^';' supervisord.conf|grep -v ^'$'
[unix_http_server]
file=/var/run/supervisor/supervisor.sock ; (the path to the socket file)
[supervisord]
logfile=/var/log/supervisor/supervisord.log ; (main log file;default $CWD/supervisord.log)
logfile_maxbytes=50MB ; (max main logfile bytes b4 rotation;default 50MB)
logfile_backups=10 ; (num of main logfile rotation backups;default 10)
loglevel=info ; (log level;default info; others: debug,warn,trace)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
nodaemon=false ; (start in foreground if true;default false)
minfds=65536 ; (min. avail startup file descriptors;default 1024)
minprocs=200 ; (min. avail process descriptors;default 200)
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]
serverurl=unix:///var/run/supervisor/supervisor.sock ; use a unix:// URL for a unix socket
[include]
files = supervisord.d/*.ini
files = supervisord.d/*.conf
子进程配置文件说明
给需要管理的子进程(程序)编写一个配置文件，放在/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 = 20MB
#stdout日志文件备份数
stdout_logfile_backups = 20
子进程配置示例
[program:elasticsearch]
command=/usr/local/elasticsearch-7.1.0/bin/elasticsearch
directory=/usr/local/elasticsearch-7.1.0
autostart=true
autorestart=true
stdout_logfile=/var/log/supervisor/elasticsearch.log
redirect_stderr=true
user=elasticsearch
五、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，否则程序报错。
centos 7中，使用命令
systemctl start supervisord.service //启动supervisor并加载默认配置文件
systemctl enable supervisord.service //将supervisor加入开机启动项
常见问题
1.unix:///var/run/supervisor.sock no such file
问题描述：安装好supervisor没有开启服务直接使用supervisorctl报的错
解决办法：systemctl start supervisord.service
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相关的进程。
六、event
supervisor的event机制，是一个监控/通知的框架。抛开这个机制实现的过程来说的话，event其实就是一串数据，这串数据里面有header和body两部分。先弄清楚event数据结构，才能做后续的处理，header长这样：
ver:3.0 server:supervisor serial:21 pool:listener poolserial:10 eventname:PROCESS_COMMUNICATION_STDOUT len:54
具体含义：
- ver：表示event协议的版本，目前是3.0。
- server：表示supervisor的标识符，也就是[supervisord]块中的identifier选项中的东西，默认为supervisor。
- serial：每个event的序列号，supervisord在运行过程中，发送的第一个event的序列号就是1，接下来的event依次类推。
- pool：listener的pool的名字，一般listener只启动一个进程的的话，其实也就没有pool的概念了，名字就是[eventlistener:eventlistenername]这个东西。
- poolserial：上面的serial是supervisord给每个event的编号。 而poolserial则是，eventpool给发送到我这个pool过来的event的编号。
- eventname：是event的类型名称。
- len：这个长度，表示的是header后面的body部分的长度。header之后，取len长度的内容作为body。
body的数据结构，其实是和event的具体类型相关的，不同的event的类型，header的结构都一样，但是body的结构大多就不一样了。关于event类型，可以参阅一下官网http://supervisord.org/events.html#writing-an-event-listener，这里介绍一下PROCESS_STATE_EXITED这个类型。PROCESS_STATE_EXITED就是当supervisord管理的子进程退出的时候，supervisord就会产生PROCESS_STATE_EXITED这么个event。
来看看PROCESS_STATE_EXITED长啥样吧，header都一样，来看看body部分。
processname:cat groupname:cat from_state:RUNNING expected:0 pid:2766
具体含义：
- processname：就是进程名字，这里名字不是实际进程的名字，而是[program:x]配置成的名字
- groupname：组名
- from_state：进程退出前的状态是什么状态
- expected：默认情况下exitcodes是0和2，也就是说0和2是expected。其它的退出码就是unexpected了。
- pid：进程号
知道了event的产生，然后给listener这么一种结构的数据。现在有数据了，就看怎么去处理这些数据了。可以利用接收的数据加工后，进行报警等操作。处理数据之前，还得要来了解一下，listener和supervisord之间的通信过程。在这里首先要搞清楚，event的发起方和接收方。
event的发起方是supervisord进程，接收方是一个叫listener的东西，其实listener和program一样，都是supervisord的子进程。两者的在配置上，很多选项也都一样。event还有另外一个过程，program也就是要管理的进程，也可以发送event，进而和supervisord主动通信。
event协议：
- 1.当supervisord启动的时候，如果listener配置为autostart=true的话，listener就会作为supervisor的子进程被启动。
- 2.listener被启动之后，会向stdout写一个"READY"的消息，此时父进程也就是supervisord读取到这条消息后，会认为listener处于就绪状态。
- 3.listener处于就绪状态后，当supervisord产生的event在listener的配置的可接受的events中时，supervisord就会把该event发送给该listener。
- 4.listener接收到event后，就可以根据event的header，body里面的数据，做一些列的处理了。根据event的内容，判断，提取，报警等等操作。
- 5.该干的活都干完之后，listener需要向自己的stdout写一个消息"RESULT\nOK"，supervisord接受到这条消息后。就知道listener处理event完毕了。
看看例子：
#!/usr/bin/env python3
#coding:utf-8
import sys
import os
import subprocess
# childutils这个模块是supervisor的一个模型，可以方便处理event消息。当然也可以自己按照协议，用任何语言来写listener，只不过用childutils更加简便罢了。
from supervisor import childutils
from optparse import OptionParser
import socket
import fcntl
import struct
__doc__ = "\033[32m%s,捕获PROCESS_STATE_EXITED事件类型,当异常退出时触发告警\033[0m" %(sys.argv[0])
def write_stdout(s):
sys.stdout.write(s)
sys.stdout.flush()
# 定义异常
class CallError(Exception):
def __init__(self,value):
self.value = value
def __str__(self):
return repr(self.value)
# 定义处理event的类
class ProcessesMonitor():
def __init__(self):
self.stdin = sys.stdin
self.stdout = sys.stdout
def runforever(self):
# 定义一个无限循环，可以循环处理event，当然也可以不用循环，把listener的autorestart配置为true，处理完一次event就让该listener退出，然后supervisord重启该listener，这样listener就可以处理新的event了。
while 1:
# 向stdout发送"READY"，然后就阻塞在这里，一直等到有event发过来
# headers，payload分别是接收到的header和body的内容
headers,payload = childutils.listener.wait(self.stdin,self.stdout)
# 判断event事件类型是否是PROCESS_STATE_EXITED，不是的话，向stdout写入"RESULT\nOK"，并跳过当前循环剩余部分
if not headers['eventname'] == 'PROCESS_STATE_EXITED':
childutils.listener.ok(self.stdout)
continue
pheaders,pdata = childutils.eventdata(payload+'\n')
# 判断event是否是expected，是expected的话为1，否则为0
# 这里的判断是过滤掉expected的event
if int(pheaders['expected']):
childutils.listener.ok(self.stdout)
continue
ip = self.get_ip('eth0')
# 构造报警信息结构
msg = "[Host:%s][Process:%s][pid:%s][exited unexpectedly fromstate:%s]" %(ip,pheaders['processname'],pheaders['pid'],pheaders['from_state'])
# 调用报警接口，换成自己公司的接口
subprocess.call("/usr/local/bin/alert.py -m '%s' %msg , shell=True")
# stdout写入"RESULT\nOK"，并进入下一次循环
childutils.listener.ok(self.stdout)
'''def check_user(self):
userName = os.environ['USER']
if userName != 'root':
try:
raise MyError('must be run by root!')
except MyError as e:
write_stderr("Error occurred,value:%s\n" % e.value)
sys.exit(255)'''
def get_ip(self,ifname):
s = socket.socket(socket.AF_INET,socket.SOCK_DGRAM)
inet = fcntl.ioctl(s.fileno(),0x8915,struct.pack('256s',ifname[:15]))
ret = socket.inet_ntoa(inet[20:24])
return ret
def main():
parser = OptionParser()
if len(sys.argv) == 2:
if sys.argv[1] == '-h' or sys.argv[1] == '--help':
print(__doc__)
sys.exit(0)
# (options,args) = parser.parse_args()
# 只有supervisord才能调用该listener，否则退出
if not 'SUPERVISOR_SERVER_URL' in os.environ:
try:
raise CallError("%s must be run as a supervisor event" %sys.argv[0])
except CallError as e:
write_stdout("Error occurred,value: %s\n" %e.value)
return
prog = ProcessesMonitor()
prog.runforever()
if __name__ == "__main__":
main()
fcntl模块没法pip下载，这里可以将内容写在文件fcntl.py里，再import导入就可以了。
#!/usr/bin/python3
def fcntl(fd,op,arg=0):
return 0
def ioctl(fd,op,arg=0,mutable_flag=True):
if mutable_flag:
return 0
else:
return ""
def flock(fd,op):
return
def lockf(fd,operation,length=0,start=0,whence=0):
return
/etc/supervisord.d/test.conf文件内容：
[program:test]
command=/usr/bin/sh /root/test.sh
directory=/root
stdout_logfile=/tmp/test_stdout.log
stderr_logfile=/tmp/test_stderr.log
redirect_stderr=true
user=root
[eventlistener:supervisor_alert]
command=/usr/bin/python3 /root/event/event.py
directory=/root/event
events=PROCESS_STATE_RUNNING,PROCESS_STATE_EXITED,PROCESS_STATE_FATAL
stdout_logfile=/tmp/supervisor_alert_stdout.log
stderr_logfile=/tmp/supervisor_alert_stderr.log
user=root
/root/test.sh文件内容：
#!/bin/bash
while true
do
echo `date`
sleep 10
done
其他常用的event类型，以及listener的三种状态，以及怎么转换的，可以在官网http://supervisord.org/events.html查看。
