Supervisor配置和使用

一、使用背景

目前在公司搭建了一套基于Django的管理后台，同时使用了celery做了调度部分爬虫任务的定时调度，由于涉及到起到的进程指令过多，需要个工具来统一管理配置，找了半天…最后找了相对较火热的Supervisor(其实最开始使用的是docker，基于docker-compose本地都调测好了,但是公司服务器对容器管控严格，镜像源申请一眼难尽…)

二、工具简介

supervisor作用是对运行在类Linux系统上的指定进程进行管理，由python编写，可以理解是一个平台工具，不是一个简单的类库。支持像docker一样的对运行的程序启动、终止，重启等操作，也支持对进程运行的稳定性有很大的帮助，可以自动对异常终止的程序自动启动。

三、安装

找到两种相对简单的安装方式（本人比较懒…）
第一种是Mac带的brew安装

brew install supervisor

第二种是pip安装

pip install supervisor

四、配置文件

1. 位置

配置文件位置一般会在你pip的的安装目录下，一下是我电脑的位置

如果找不到自己的pip位置还有只简单的方法

2. 步骤

设置supervisor配置目录

mkdir -p /etc/supervisor/conf.d

cd到安装目录，执行命令，生成配置文件

./echo_supervisord_conf > /etc/supervisor/conf.d/supervisored.conf

supervisored.conf配置文件修改

配置项有点多但是实际配置内容不多，需要注意的是网上有许多教程只设置了图一的配置，也能运行，但是由于后面几个文件路径配置morning的设置为/tmp临时文件目录，这个目录容易被删除，导致后面在启动时容易出现pid文件，sock文件找不到的异常，强烈建议修改位置

进程管理配置文件目录设置，将上面创建的配置目录设置好，以后的进程配置文件都要放在这个文件夹里面
![在这里插入图片描述](https://img-blog.csdnimg.cn/a802ca3dd82f43ab81afc6f97f6efd3b.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAeWFud2VudGFvXw==,size_20,color_FFFFFF,t_70,g_se,x_1
supervisor.sock文件位置设置

supervisor.d配置项文件设置

supervisorctl配置项文件设置

五、服务启动

supervisord -c /etc/supervisor/supervisored.conf #注意：要以配置文件的方式开启服务

六、supervisorctl客户端管理

客户端启动

supervisorctl -c /etc/supervisor/supervisored.conf #注意：要以配置文件的方式启动客户端

七、常用操作指令

指令	说明
重启	restart 进程名
开启	start 进程名
终止	stop 进程名
状态查看	status
配置更新后让配置生效	update
新增配置后使生效	reread
任务重载	reload

八、示例

编辑一个进程配置，以一个flask程序为例，首先配置一个flask.conf文件到设置的conf.d文件目录

进程文件配置如下：

[program:flask_run]
command=/Users/ywt/.local/share/virtualenvs/owner-2UBBwPbN/bin/python server.py
user=ywt
directory=/Users/ywt/PycharmProjects/owner
autostart=false
autorestart=true
startsecs=20
startretries=3
redirect_stderr=true
stdout_logfile=/var/log/supervisor/supervisor.log
std_logfile_maxbytes=20MB
std_logfile_backups=20

九、配置项说明

supervisored.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_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false ;默认为false，向进程组发送kill信号，包括子进程
[include]
files = relative/directory/*.ini ;可以指定一个或多个以.ini结束的配置文件

进程任务配置项说明

[program:yourprogramname]
command=python meipaiUser.py
directory=/home/tomcat/pyscripts/recommendation/videoWebsiteCrawler/videoWebsiteCrawler
stdout_logfile=/home/tomcat/pyscripts/recommendation/videoWebsiteCrawler/meipaiuser.log
;autostart = true ; 在 supervisord 启动的时候也自动启动
;startsecs = 5 ; 启动 5 秒后没有异常退出，就当作已经正常启动了
;autorestart = true ; 程序异常退出后自动重启
;startretries = 3 ; 启动失败自动重试次数，默认是 3
;user = leon ; 用哪个用户启动
;redirect_stderr = true ; 把 stderr 重定向到 stdout，默认 false
;stdout_logfile_maxbytes = 20MB ; stdout 日志文件大小，默认 50MB
;stdout_logfile_backups = 20 ; stdout 日志文件备份数
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
; 可以通过 environment 来添加需要的环境变量，一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

十、web页面监控

进入supervisored.conf配置inet_http_server选项，将注释打开，设置需要的账号密码

监控页面如下：