supervisor 进程管理工具使用详解

精选原创

是逍遥哥哥啊 2023-05-05 12:23:40 博主文章分类：supervisor ©著作权

©著作权归作者所有：来自51CTO博客作者是逍遥哥哥啊的原创作品，请联系作者获取转载授权，否则将追究法律责任

简介

supervisor是用Python开发的一个client/server服务，是Linux/Unix系统下的一个进程管理工具。可以很方便的监听、启动、停止、重启一个或多个进程。用supervisor管理的进程，当一个进程意外被杀死，supervisor监听到进程死后，会自动将它重启，很方便的做到进程自动恢复的功能，不再需要自己写shell脚本来控制。

安装

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

yum install supervisor

配置

安装好后在/etc/会生成一个supervisord.conf文件及一个supervisord.d文件目录

supervisor配置文件详解

[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=65535                ;可以打开的文件描述符的最小值，默认 1024,在生产环境里这个值一般都需要改成65535
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结束的配置文件
注意：[include]默认配置是制定*.ini，因个人习惯命名为*.conf文件，因此修改配置如下：

[include]
files = relative/directory/*.conf
supervisord.d目录用来存放用户自定义的进程配置，参考：

[program:es]
command=/opt/software/elasticsearch/bin/elasticsearch
user=es
stdout_logfile=/opt/supervisor_test/run.log
autostart=true
autorestart=true
startsecs=60
stopasgroup=true
ikillasgroup=true
startretries=1
redirect_stderr=true
注意: supervisor不能监控后台进程，command 不能为后台运行命令

supervisorctl命令详解

服务段启动
supervisord -c /etc/supervisord.conf 
常用命令介绍
supervisorctl 是 supervisord的命令行客户端工具

supervisorctl status：查看所有进程的状态
supervisorctl stop es：停止es
supervisorctl start es：启动es
supervisorctl restart es: 重启es
supervisorctl update ：配置文件修改后可以使用该命令加载新的配置
supervisorctl reload: 重新启动配置中的所有程序

踩过的坑

1、unix:///var/run/supervisor/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 进程管理工具使用详解_重启

supervisor报警

superlance介绍

superlance就是基于supervisor的事件机制实现的一系列命令行的工具集，它实现了许多supervisor本身没有实现的实用的进程监控和管理的特性，包括内存监控，http接口监控，邮件和短信通知机制等。同样的，superlance本身也是使用python编写的

superlance命令

superlance是一系列命令行工具的集合，其包括以下这些命令：

httpok

通过定时对一个HTTP接口进行GET请求，根据请求是否成功来判定一个进程是否处于正常状态，如果不正常则对进程进行重启。

crashmail

当一个进程意外退出时，发送邮件告警。

memmon

当一个进程的内存占用超过了设定阈值时，发送邮件告警。

crashmailbatch

类似于crashmail的告警，但是一段时间内的邮件将会被合成起来发送，以避免邮件轰炸。

fatalmailbatch

当一个进程没有成功启动多次后会进入FATAL状态，此时发送邮件告警。与crashmailbatch一样会进行合成报警。

crashsms

当一个进程意外退出时发送短信告警，这个短信也是通过email网关来发送的

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的head，body里面的数据，做一系列的处理了。我们根据event的内容，判断，提取，报警等等操作。5.该干的活都干完之后，listener需要向自己的stdout写一个消息"RESULTnOK"，supervisord接受到这条消息后。就知道listener处理event完毕了。

Supervisord支持的Event

PROCESS_STATE    进程状态发生改变
PROCESS_STATE_STARTING  进程状态从其他状态转换为正在启动(Supervisord的配置项中有startsecs配置项， 是指程序启动时需要程序至少稳定运行x秒才认为程序运行正常，在这x秒中程序状态为正在启动)
PROCESS_STATE_RUNNING   进程状态由正在启动转换为正在运行
PROCESS_STATE_BACKOFF   进程状态由正在启动转换为失败
PROCESS_STATE_STOPPING   进程状态由正在运行转换为正在停止
PROCESS_STATE_EXITED   进程状态由正在运行转换为退出
PROCESS_STATE_STOPPED   进程状态由正在停止转换为已经停止(exited和stopped的区别是exited是程序自行退出，而stopped为人为控制其退出)
PROCESS_STATE_FATAL   进程状态由正在运行转换为失败
PROCESS_STATE_UNKNOWN   未知的进程状态
REMOTE_COMMUNICATION   使用Supervisord的RPC接口与Supervisord进行通信
PROCESS_LOG   进程产生日志输出，包括标准输出和标准错误输出
PROCESS_LOG_STDOUT   进程产生标准输出
PROCESS_LOG_STDERR   进程产生标准错误输出
PROCESS_COMMUNICATION   进程的日志输出包含 和
PROCESS_COMMUNICATION_STDOUT   进程的标准输出包含 和
PROCESS_COMMUNICATION_STDERR   进程的标准错误输出包含 和
SUPERVISOR_STATE_CHANGE_RUNNING Supervisord  启动
SUPERVISOR_STATE_CHANGE_STOPPING Supervisord  停止
TICK_5   每隔5秒触发
TICK_60   每隔60秒触发
TICK_3600   每隔3600触发
PROCESS_GROUP   Supervisord的进程组发生变化
PROCESS_GROUP_ADDED   新增了Supervisord的进程组
PROCESS_GROUP_REMOVED   删除了Supervisord的进程组

安装superlance

也是python程序，直接pip 安装

pip install superlance

既然有了上面的event特性，下面就配置一个发邮件报警，当nginx莫名其妙的重启后就立刻发邮件通知。

这里在说一下，centos下如何用命令行直接发邮件的，我一直都没有用过默认自带的，也不好用。推荐一个比较好用的。

sendEmail,用perl语言写好的也都封装好了，只需要提供发件人邮箱账号密码 smtp服务收件人就可以了。

先配置一下

wget http://caspian.dotconf.net/menu/Software/SendEmail/sendEmail-v1.56.tar.gz tar zxvf sendEmail-v1.56.tar.gz cp sendEmail-v1.56/sendEmail /usr/bin/sendemail

ok，发邮件测试一下，这里我把邮箱信息隐藏一下了.....

sendemail -f 发件人邮箱 -t 收件人邮箱 -s 发件人邮箱smtp服务器 -u "sendEmail" -m "haha" -xu 发件人邮箱 -xp 发件人邮箱密码 -f 发件人 -t 收件人 -s 发件人smtp服务器 -u 主题 -m 内容 -xu 发件人用户名 -xp 发件人密码

我这里用的163发的 qq邮箱收件的，测试没啥问题的。

supervisor 进程管理工具使用详解_进程状态_02

ok 现在要做的就是配置一个supervisor配置文件，来一直监听进程的状态变化

配置报警，以nginx为例

supervisor 进程管理工具使用详解_perl_03

接下来就是测试:

supervisor 进程管理工具使用详解_进程状态_04

当然对于supervisor进程监控你也可以通过编写脚本的方式来达到目的,以下示例:

#!/usr/bin/env python3
#coding=utf-8
#master:peng
#modified by 2019-08-09
import os
import json
import requests
import  time
import sys
import socket
def send_msg(data,phone='xxxxxxxxx'):
    webhook="https://oapi.dingtalk.com/robot/send?access_token=d48130aa3d43dbb403843deb2fd6ede33fe4c32f246f05a9c190bfe04da41427"
    header = {
        "Content-Type":"application/json",
    }
    data ={
     "msgtype":"text",
     "text":{
        "content":data
        },
     "at":{
        "atMobiles":[
            phone,
           ],
        "isAtAll":False
      }
   }

    r = requests.post(url=webhook,headers=header,data=json.dumps(data))
def check():
    proc_list=['qsdk']
    msg=''
    for proc in proc_list:
        proc_state1=os.popen("/usr/bin/supervisorctl status | grep -w %s |awk  '{print $2}'" %proc).read().strip()
        time.sleep(3)
        proc_state2=os.popen("/usr/bin/supervisorctl status | grep -w %s |awk  '{print $2}'" %proc).read().strip()
        print("qsdk: " + " " + proc_state2)
        #print proc_state
        if (proc_state1 in ("EXITED", "FATAL", "BACKOFF") and proc_state2 in ("EXITED", "FATAL", "BACKOFF")):
            hostname=socket.gethostname()
            msg+='%s %s进程异常,请检查\n'%(hostname, proc)
    return msg

if __name__ == "__main__":
    b = check()
    #print (b)
    if b != "":
        send_msg(b)