由于项目有需要是用supervisorctl 来做进程守护的,但是服务器挂的时候虽然会自动拉起,但是如果一直挂下去则不行,并且也没有办法知道。
所以做了一个利用supervisorctl listener来做进程守护。
supervisor的event机制其实,就是一个监控/通知的框架。抛开这个机制实现的过程来说的话,event其实就是一串数据,这串数据里面有head和body两部分。咱们先弄清楚event数据结构,咱们才能做后续的处理。先看看header长啥样的吧
先来看看打印出来的header是怎么样的吧
{‘ver’: ‘3.0’, ‘poolserial’: ‘11430’, ‘len’: ‘15’, ‘server’: ‘supervisor’, ‘eventname’: ‘TICK_60’, ‘serial’: ‘17334’, ‘pool’: ‘listener’}
来说说上面的这个header每一项,都是什么?
ver
:表示event协议的版本,目前是3.0
server
:表示supervisor的标识符,也就是咱们上一篇中[supervisord]块中的identifier选项中的东西默认为supervisor
serial
:这个东西是每个event的序列号,supervisord在运行过程中,发送的第一个event的序列号就是1,接下来的event依次类推
pool
:这个是你的listener的pool的名字,一般你的listener只启动一个进程的的话,其实也就没有 pool的概念了。名字就是[eventlistener:theeventlistenername]这个东西
poolserial
:上面的serial是supervisord给每个event的编号。 而poolserial则是,eventpool给发送到我这个pool过来的event编的号
eventname
:这个是event的类型名称,这个后面说。
len
:这个长度,表示的是header后面的body部分的长度。header之后,我们会取len长度的内容作为 body。
关于event类型,咱们就不展开说了,因为太多了,具体大伙可以去参阅一下官网。
来看看常用的几个类型
PROCESS_STATE_EXITED
看着这名字,大伙差不多也就知道它是干什么的了。PROCESS_STATE_EXITED其实就是,当supervisord管理的子进程退出的时候,supervisord就会产生PROCESS_STATE_EXITED这么个event。
processname:XXXX groupname:XXXXX from_state:STOPPING pid:30748
来说说具体含义
processname
:就是进程名字,这里名字不是我们实际进程的名字,而是咱们[program:x]配置成的名字
groupname
:组名,这个一个样
from_state
:这个是,我们的进程退出前的状态是什么状态
expected
:这个咱们前面也讲过,默认情况下exitcodes是0和2,也就是说0和2是expected。其它的退出码,也就是unexpected了
pid
:这个大伙想必都知道。
OK,说到了这里,我们知道了event的产生,然后给我们的listener这么一种结构的数据。
现在我们有数据了,就看咱们怎么去处理这些数据了,这个过程就仁者见仁,智者见智了。我们可以利用接收的数据,加工后,进行报警,等等操作。
处理数据之前,咱们还得要来了解一下,listener和supervisord之间的通信过程
在这里我们首先要搞清楚,event的发起方和接收方。
event的发起方是supervisord进程,接收方是一个叫listener的东西,listener怎么配置,上一篇参数详解里面已经写的很清楚了,大伙可以去参考下,这里就不赘述了。其实listener和program一样,都是supervisord的子进程。两者的在配置上,很多选项也都一样。
其实,event还有另外一个过程,我们的program也就是我们要管理的进程,也可以发送event,进而和supervisord主动通信。不过program程序一般都是程序员们搞,咱们搞运维的就不管他们的事情了
OK,看看event协议。
协议其实很简单。
- 当supervisord启动的时候,如果我们的listener配置为autostart=true的话,listener就会作为supervisor的子进程被启动。
- listener被启动之后,会向自己的stdout写一个"READY"的消息,此时父进程也就是supervisord读取到这条消息后,会认为listener处于就绪状态。
- listener处于就绪状态后,当supervisord产生的event在listener的配置的可接受的events中时,supervisord就会把该event发送给该listener。
- listener接收到event后,我们就可以根据event的head,body里面的数据,做一些列的处理了。我们根据event的内容,判断,提取,报警等等操作。
- 该干的活都干完之后,listener需要向自己的stdout写一个消息"RESULT\nOK",supervisord接受到这条消息后。就知道listener处理event完毕了。
接着来看看我这边写的python实例
#!/usr/bin/ python
# -*- coding: utf-8 -*-
# @Author : 黑羽青衣
# @File : new_listener.py
import sys
import os
import requests
from supervisor import childutils
from optparse import OptionParser
__doc__ = "\033[32m%s,捕获PROCESS_STATE_EXITED事件类型,当异常退出时触发报警\033[0m" % sys.argv[0]
def write_stdout(s):
sys.stdout.write(s)
sys.stdout.flush()
def write_stderr(s):
sys.stderr.write(s)
sys.stderr.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 WeChat(msg):
webhook = "这里填机器人通知的webhook"
header = {"Content-Type": "application/json"}
if not webhook:
return
else:
data = {
"msgtype": "text",
"text": {
"content": msg,
}
}
r = requests.post(url=webhook, headers=header, json=data)
if r.status_code == 200:
print("发送成功")
else:
print("发送失败,返回码为:" + str(r.status_code) + "\n")
def runforever(self):
#定义一个无限循环,可以循环处理event,当然也可以不用循环,把listener的autorestart#配置为true,处理完一次event就让该listener退出,然后supervisord重启该listener,这样listen#er就可以处理新的event了
while 1:
#下面这个东西,是向stdout发送"READY",然后就阻塞在这里,一直等到有event发过来
#headers,payload分别是接收到的header和body的内容
headers, payload = childutils.listener.wait(self.stdin, self.stdout)
#判断event是否是咱们需要的,不是的话,向stdout写入"RESULT\NOK",并跳过当前
#循环的剩余部分
if not headers['eventname'] == 'PROCESS_STATE_EXITED' or headers['eventname'] == 'PROCESS_STATE_FATAL' or headers['eventname'] == 'PROCESS_STATE_STOPPED' or headers['eventname'] == 'PROCESS_LOG_STDERR':
childutils.listener.ok(self.stdout)
continue
pheaders,pdata = childutils.eventdata(payload+'\n')
#判读event是否是expected是否是expected的,expected的话为1,否则为0
#这里的判断是过滤掉expected的event
if int(pheaders['expected']):
childutils.listener.ok(self.stdout)
continue
#构造报警信息结构
msg = "[Host:%s][Process:%s][pid:%s][exited unexpectedly fromstate:%s]" % (ip,pheaders['processname'],pheaders['pid'],pheaders['from_state'])
#调用报警接口,这个接口是我们公司自己开发的,大伙不能用的,要换成自己的接口
#stdout写入"RESULT\nOK",并进入下一次循环
self.WeChat(msg)
childutils.listener.ok(self.stdout)
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_stderr("Error occurred,value: %s\n" % e.value)
return
prog = ProcessesMonitor()
prog.runforever()
if __name__ == '__main__':
main()
以上就是实例,就是通过监听有这几个event类型然后来触发报警的。
然后我们来看看具体的配置文件:
[eventlistener:listener]
directory = /usr/local/listenerdeamon
command = /usr/bin/python new_listener.py
events = PROCESS_STATE_EXITED,PROCESS_STATE_STOPPED,PROCESS_STATE_FATAL,PROCESS_LOG_STDERR,TICK_60
user = root
autostart = true
autorestart = unexpected
stdout_logfile = /usr/local/listenerdeamon/listener.stdout.log
stderr_logfile = /usr/local/listenerdeamon/listener.stderr.log
serverurl=AUTO
eventlistener 是指进程名称
directory是指进程守护脚本的路径
command 这里表示启用的脚本或者执行的程序,这里踩过一个坑就是没有成功的运行,导致进程经常过
这里要特别注意的是不能直接来运行py脚本程序,而是要前面先调用python 然后再来调用对应的脚本
events 事件的类型,这里是加了tick_60每60秒刷新监听一次,或者触发一次消息。
user 执行用户
autostart 是否自动启动
autorestart 这里是是否自动重起,这里由于加了循环,就没有选true
stdout_logfile/stderr_logfile 这两个不多说,日志的地址
serverurl 这里给脚本做了一个是否监听进程启动的
OK配置上就已经完成了,接着刷新配置就使用supervisorctl update来刷新一下配置即可。
会自动重起,注意修改配置的话是最好使用update更新一下配置,会自动restart来启动程序。
今天就输出到这里吧!