supervisor 使用配置相关详解

1.平台要求

Supervisor已经过测试，并且可以在Linux (Ubuntu 9.10), Mac OS X (10.4/10.5/10.6), and Solaris (10 for Intel) and FreeBSD 6.1上运行。在大多数UNIX系统上，它可能会正常工作。

Supervisor 完全不会 支持在任何Windows版本下运行。

Supervisor旨在在Python 3版本3.4或更高版本以及Python 2版本2.7上工作。

2.安装

1：easy_install 安装：

easy_install supervisor

2：pip 安装：

pip install supervisor

3：Debian / Ubuntu可以直接通过apt安装：

apt-get install supervisor

3.创建配置文件

Supervisor安装完成后，运行 echo_supervisord_conf。这会将 示例 Supervisor配置文件 打印到终端的标准输出。

一旦看到文件回显到终端，请重新调用命令 echo_supervisord_conf > /etc/supervisor/supervisord.conf。如果您没有root用户访问权限，则无法使用。

如果你没有root访问权限，或者你不想把 supervisord.conf文件/etc/supervisor/supervisord.conf，你可以将它放在当前目录（echo_supervisord_conf > supervisord.conf），并开始supervisord与 -c 标志以指定配置文件位置。

例如，如果刚才你输入的文件在当前目录下，supervisord -c supervisord.conf。使用-c 标志其实就是在这种情况下多余的，因为 supervisord搜索当前目录下的 supervisord.conf之前，它会搜索该文件的任何其他地方，但它会奏效。有关-c标志的更多信息，请参见运行Supervisor。

在文件系统上拥有配置文件后，即可开始根据自己的喜好对其进行修改。

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

/etc/supervisor/conf.d/*.conf

然后，开始给自己需要的脚本程序编写一个子进程配置文件，让supervisor来管理它，放在/etc/supervisor/conf.d/目录下，以.conf作为扩展名（每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起）。如任意定义一个和脚本相关的项目名称的选项组。

比如我需要守护 frp 进程，我需要创建一个配置文件（建议直接使用 root 账户操作）：

sudo vim /etc/supervisor/conf.d/frp.conf

配置文件内容如下：

[program:frp]
directory=/home/edge/frp_0.30.0_linux_amd64
command=sh frp.sh
autostart=true
autorestart=true
startretries=100
redirect_stderr=true
stdout_logfile=/home/edge/frp_0.30.0_linux_amd64/out.log

3.1配置文件参数详解

3.1.1主程序配置文件

安装完成程序默认生成配置文件：supervisord.conf

位置：etc/supervisord.conf

内容如下：

# 指定了socket file的位置
[unix_http_server]
file=/tmp/supervisor.sock   ;UNIX socket 文件，supervisorctl 会使用
;chmod=0700                 ;socket文件的mode，默认是0700
;chown=nobody:nogroup       ;socket文件的owner，格式：uid:gid
 
 #用于启动一个含有前端的服务，可以从Web页面中管理服务。其中，port用于设置访问地址，username和password用于设置授权认证。
;[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信号，包括子进程
 # 对事件进行的管理
;[eventlistener:theeventlistenername]

# 对任务组的管理 ,包含其它配置文件
;[group:thegroupname]
;programs=progname1,progname2  ; each refers to 'x' in [program:x] definitions
;priority=999                  ; the relative start priority (default 999)

[include]
files = supervisord.d/*.ini    ;可以指定一个或多个以.ini结束的配置文件

3.1.2子程序配置文件

位置：supervisord.d目录用来存放用户自定义的进程配置，默认的子进程配置文件结尾为include配置的 .ini

内容如下：

# 程序名称，在 supervisorctl 中通过这个值来对程序进行一系列的操作
[program:qqc_one]
# 启动命令，与手动在命令行启动的命令是一样的
command=gunicorn wsgi:application -b 0.0.0.0:8000 -k gevent -w 2 -t 10 -n yun-gunicorn -m 0022 --log-level=info --access-logfile=- --error-logfile=- --max-requests=5000
# 程序的启动目录
directory=/home/yun/projects/yun
# 可以通过 environment 来添加需要的环境变量，一种常见的用法是使用指定的 virtualenv 环境
environment=DJANGO_SETTINGS_MODULE=settings.test
# 指定用户名
user=opt
# 日志目录 需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile=/var/log/supervisor/yun-gunicorn.stdout.log
stderr_logfile=/var/log/supervisor/yun-gunicorn.stderr.log
# 日志备份数量
stdout_logfile_backups = 20
# 指定日志文件大小
stdout_logfile_maxbytes = 20MB 
# 把 stderr 重定向到 stdout，默认 false,错误日志也会写进stdout_logfile中
redirect_stderr=True
# 在 supervisord 启动的时候也自动启动
autostart=True    
# 程序异常退出后自动重启
autorestart=True

[program:qqc_two]
...
[program:qqc_free]
...

# 集中管理多个进程
[group:qqc]
programs=qqc_one,qqc_two,qqc_free

4.启动Supervisor服务

supervisord -c /etc/supervisor/supervisord.conf

如果出现错误：

Error: Another program is already listening on a port that one of our HTTP servers is configured to use. Shut this program down first before starting supervisord.

解决办法：

sudo unlink /tmp/supervisor.sock

or

sudo unlink /var/run/supervisor.sock

5.supervisorctl 常用命令：

命令	说明
supervisorctl stop program_name	停止某个进程
supervisorctl start program_name	启动某个进程
supervisorctl restart program_name	重启某个进程
supervisorctl stop all	停止全部进程
supervisorctl reload	载入最新的配置文件，停止原有进程并按新的配置启动、管理所有进程
supervisorctl update	根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启

6.设置 Supervisor 开机自动启动

如果我们是使用 apt 安装的，一般来说会自动设置好开机启动。但是如果你重启之后发现没有开机自动启动，可以按照下面的方法配置。

把下面的命令写进 rc.local 即可：

/usr/bin/supervisord

7.supervisorctl 交互操作：

输入命令 supervisorctl 进入 supervisorctl 的 shell 交互界面：
help # 查看帮助
status # 查看程序状态
stop program_name # 关闭 指定的程序
start program_name # 启动 指定的程序
restart program_name # 重启 指定的程序
tail -f program_name # 查看 该程序的日志
update # 重启配置文件修改过的程序（修改了配置，通过这个命令加载新的配置)

8.帮助集锦：

8.1结束 supervisor 进程

[root@localhost /]# ps -aux|grep supervisord
root      5135  0.1  0.8 226152 16736 ?        Ss   22:13   0:00 /usr/bin/python /usr/bin/supervisord -c /etc/supervisord.conf
root      5137  0.0  0.0 112724   992 pts/0    R+   22:13   0:00 grep --color=auto supervisord

9.ref:

• supervisord官方文档

• 进程管理工具-Supervisord 使用

• Ubuntu 18.04 安装使用 Supervisor 进程守护并设置开机自动启动