supervisor 进程管理

大家好，又见面了，我是你们的朋友全栈君。

简介：

Supervisor (http://supervisord.org) 是一个用 [Python] 写的进程管理工具，可以很方便的用来启动、重启、关闭进程(不仅仅是 Python 进程)。除了对单个进程的控制，还可以同时启动、关闭多个进程，比如很不幸的服务器出问题导致所有应用程序都被杀死，此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。

安装：

centos

sudo yum install python-setuptools-devel
easy_install supervisor 或 sudo pip install supervisor

ubuntu

apt-get install supervisor

supervisord 配置

supervisord（supervisor 是一个 C/S 模型的程序，这是 server 端，对应的有 client 端：supervisorctl）

安装完成后执行echo_supervisord_conf或者重定向到一个配置文件里，命令如下：

echo_supervisord_conf > /etc/supervisor/supervisord.conf

cat /etc/supervisor/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
logfile_backups=10           ; 日志文件保留备份数量默认 10
loglevel=info                ; 日志级别，默认 info，其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ; pid 文件
nodaemon=false               ; 是否在前台启动，默认是 false，即以 daemon 的方式启动
minfds=1024                  ; 可以打开的文件描述符的最小值，默认 1024
minprocs=200                 ; 可以打开的进程数的最小值，默认 200
 
; the below section must remain in the config file for RPC
; (supervisorctl/web interface) to work, additional interfaces may be
; added by defining them in separate rpcinterface: sections
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
 
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; 通过 UNIX socket 连接 supervisord，路径与 unix_http_server 部分的 file 一致
;serverurl=http://127.0.0.1:9001 ; 通过 HTTP 的方式连接 supervisord
 
; 包含其他的配置文件
[include]
files = conf/*.conf    ;可以是 *.conf 或 *.ini

上面部分配置保存到 /etc/supervisor/supervisord.conf

（或其他任意有权限访问的文件），

然后启动 supervisord

supervisord -c /etc/supervisor/supervisord.conf   或  supervisord

（通过 -c 选项指定配置文件路径，如果不指定会按照这个顺序查找配置文件：$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf）：

查看是否启动成功

ps -ef | grep supervisord

program 配置

可以把所有配置项都写到 supervisord.conf 文件里，（不推荐）
通过 include 的方式把不同的程序（组）写到不同的配置文件里。（推荐）

如下：
在这里插入图片描述
配置文件如下：

[program:usercenter]
directory = /home/leon/projects/usercenter       ; 程序的启动目录
command = gunicorn -c gunicorn.py wsgi:app         ; 启动命令，可以看出与手动在命令行启动的命令是一样的
process_name=%(program_name)s       ; process_name expr (default %(program_name)s)
numprocs=1           ; number of processes copies to start (def 1)
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 1        ; 启动 1 秒后没有异常退出，就当作已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数，默认是 3
user = leon          ; 用哪个用户启动
redirect_stderr = true          ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 10     ; stdout 日志文件备份数
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile = /data/logs/usercenter_stdout.log
;这一配置项的作用是：如果supervisord管理的进程px又产生了若干子进程，
;使用supervisorctl停止px进程，停止信号会传播给px产生的所有子进程，确保子进程也一起停止。
;这一配置项对希望停止所有进程的需求是非常有用的。
stopasgroup=true
 
; 可以通过 environment 来添加需要的环境变量，一种常见的用法是修改PYTHONPATH ;process environment additions      
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

配置详解
stopasgroup=true
这一配置项的作用是：如果supervisord管理的进程px又产生了若干子进程，使用supervisorctl停止px进程，停止信号会传播给px产生的所有子进程，确保子进程也一起停止。这一配置项对希望停止所有进程的需求是非常有用的。
autostart=true
这一配置项的作用是：当启动supervisord的时候会将该配置项设置为true的所有进程自动启动。
[program:usercenter]
一份配置文件至少需要一个 [program:x]部分的配置，来告诉 supervisord 需要管理那个进程。[program:x]语法中的 x 表示 program name，会在客户端（supervisorctl 或 web 界面）显示，在 supervisorctl 中通过这个值来对程序进行 start、restart、stop 等操作。

laravel 项目事例：

vim /etc/supervisor/conf/laravel-api-worker.conf

[program:laravel-api-worker]
command=php /w3c/api/artisan queue:work --timeout=60 --sleep=3 --tries=1
autostart=true
autorestart=true
startretries = 3
user=root
startsecs = 5
stderr_logfile=/w3c/api/storage/logs/queue-error.log
stdout_logfile=/w3c/api/storage/logs/queue-worker.log