supervisor 文档

简单小结

上手非常快, 日志输出会是运维中的一大帮手, 自动重启是防止服务异常中断的第一重保障.非常适合服务不断增多的系统, 管理上非常nice！

安装

pip install supervisor

启动

# 指定配置文件
supervisord -c <conf_path>

进入控制台

supervisorctl -c <conf_path> -u <user> -p <password>

常用命令

以下命令均在控制台执行, 也可以直接在命令行执行, 如supervisorctl -c <conf_path> -u <user> -p <password> start all

1. 启动、停止和重启进程：

   • 启动所有进程：

     start all

   • 启动特定进程：

     start <process_name>

   • 停止所有进程：

     stop all

   • 停止特定进程：

     stop <process_name>

   • 重启所有进程：

     restart all

   • 重启特定进程：

     restart <process_name>

2. 查看进程状态：

   • 查看所有进程状态：

     status

   • 查看特定进程状态：

     status <process_name>

3. 重新加载配置文件：

   • 重新读取配置文件，应用配置更改：
     PS: 更新的进程会生成新的日志文件.

     update

   • 重载进程(update 无效时使用)

     reload

4. 查看日志：

   • 查看特定进程的日志：

     tail -f <process_name>

配置示例

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[unix_http_server]
file=/run/server.sock
chmod=0700
chown=root:root

[supervisorctl]
serverurl=unix:///run/server.sock

[supervisord]
user=root
logfile=/tmp/server.log
logfile_maxbytes=96MB
logfile_backups=3
loglevel=info
pidfile=/run/server.pid
directory=/server
stopasgroup=true
killasgroup=true
environment=
    PATH='/usr/local/miniconda/envs/py/bin',
    RUN='DEV'

[group:api]
programs=api-1,api-2
priority=100

[program:api-1]
command=python app
autostart=false
autorestart=true
redirect_stderr=true
environment=
    API_PORT=9000,

[program:api-2]
command=python app
autostart=false
autorestart=true
redirect_stderr=true
environment=
    API_PORT=9010,
    
[program:worker]
command=celery -A app.worker worker -l info -B -c 10
autostart=false
autorestart=true
redirect_stderr=true

配置文件说明

[rpcinterface:supervisor]	# 标准配置, 需要手动添加
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[unix_http_server]
file=/run/supervisor.sock   # UNIX socket 文件
chmod=0700                  # socket文件的权限，默认是0700
chown=root:root             # socket文件的owner，格式：uid:gid

[supervisorctl]
serverurl=unix:///run/supervisor.sock # 通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
serverurl=http://127.0.0.1:9001       # or 通过HTTP的方式连接supervisord

[inet_http_server]         # HTTP服务器，提供web管理界面(不建议使用)
port=127.0.0.1:9001        # Web管理后台运行的IP和端口，如果开放到公网，需要注意安全性
username=user              # 登录管理后台的用户名
password=pawd              # 登录管理后台的密码

[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
directory=/root/project      # 默认启动路径
environment=                 # 全局环境变量, 使用逗号进行分隔
	PATH='/root/project/bin',
	ENV='TEST',
 
# 对进程进行分组管理
[group:g_name]
programs=api,worker  # 组内的进程, 用逗号分隔

# [program:api]是被管理的进程配置参数，xx是进程的名称
[program:api]
command=python api   # 程序启动命令
autostart=true       # 在supervisord启动的时候也自动启动, 默认为true
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=/tmp/api.log
stopasgroup=false     # 默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false     # 默认为false，向进程组发送kill信号，包括子进程
 
# 包含其它配置文件
[include]
files = confs/*.conf  # 可以指定一个或多个配置文件

---

Supervisor documentation (supervisord.org)