Supervisor 使用详解

Supervisor 使用详解

原文地址 https://www.jianshu.com/p/0b9054b33db3
本文在原文的基础上进行了更改

一、supervisor 简介

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


注：本文以 Ubuntu18.04为例，supervisor3.3.1版本

二、supervisor 安装

1. Debian/Ubuntu 可通过 apt 安装

sudo apt update
sudo apt install supervisor

1. pip 安装
2. easy_install 安装

三、supervisor 使用

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

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

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

注：默认子进程配置文件为 ini 格式，可在 supervisor 主配置文件中修改。
该目录下的所有配置文件，默认被包含在supervisord.conf中，因此只需要每个子进程都写一个配置文件即可；子文件的文件名结尾默认格式为.conf

四、配置文件说明

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:/
;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

子进程配置文件说明：

给需要管理的子进程 (程序) 编写一个配置文件，放在/etc/supervisor/conf.d/目录下，以.conf作为扩展名。如任意定义一个和脚本相关的项目名称的选项组（/etc/supervisord.d/test.conf）：

[program:blog]
directory=/opt/bin
command=/usr/bin/python /opt/bin/test.py
autostart=true
autorestart=false
startsecs=1
user = test
stderr_logfile=/tmp/blog_stderr.log 
stdout_logfile=/tmp/blog_stdout.log 
redirect_stderr = true
stdout_logfile_maxbytes = 20M
stdout_logfile_backups = 20

五、supervisor 命令说明

常用命令

supervisorctl status        
supervisorctl stop es       
supervisorctl start es      
supervisorctl restart       
supervisorctl update        
supervisorctl reload

注：把es换成all可以管理配置中的所有进程。直接输入supervisorctl进入 supervisorctl 的 shell 交互界面，此时上面的命令不带 supervisorctl 可直接使用。
启动supervisord
注意：如果不加-c 及后边的配置文件，则默认使用

/etc/supervisor/supervisord.conf

supervisord -c /etc/supervisord.conf

常见问题

1. unix:///var/run/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 本身就是后台启动守护进程，因此不用担心这个

更多信息请移步 Supervisor 官网：http://supervisord.org