Supervisor相关命令

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

supervisord管理的进程必须由supervisord来启动, 并且管理的程序必须要是非Daemon程序, Supervisor会帮你把它转化为Daemon程序. 比如想要使用Supervisor来管理Nginx进程, 就必须在Nginx配置文件中加入 daemon off让Nginx以非Daemon方式运行.

1. 安装

Supervisor 可以运行在 Linux、Mac OS X 上. 如前所述, supervisor 是 Python 编写的, 所以安装起来也很方便, 可以直接用pip或是用yum安装, 如果是 Ubuntu 系统, 还可以使用 apt-get 安装:

$ pip install supervisor
$ yum install supervisor
$ sudo apt-get install supervisor

验证是否安装成功
supervisorctl --help

2. 配置

Supervisor 相当强大, 提供了很丰富的功能, 不过大部分情况下只需要用到其中一小部分. 安装完成之后, 可以编写配置文件, 来满足自己的需求. 为了方便, 一般把配置分成两部分: supervisord本身的配置(也相当于全局配置)和待管理的应用程序自己的配置.

supervisor 是一个C/S模型的程序, supervisord是server端, 对应的有client端supervisorctl.

2.1 supervisord的配置及启动

首先来看 supervisord 的配置文件. 安装完supervisor之后, 可以运行echo_supervisord_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]
; 通过 UNIX socket 连接 supervisord, 路径与 unix_http_server 部分的 file 一致
serverurl=unix:///tmp/supervisor.sock 
通过 HTTP 的方式连接 supervisord
;serverurl=http://127.0.0.1:9001 ; 

; 包含其他的配置文件, 即待管理的应用程序各自的配置, 可以是对这个文件而言的相对路径.
[include]
; 可以是 *.conf 或 *.ini
files = relative/directory/*.ini    

我们把上面这部分配置保存到/etc/supervisord.conf（或其他任意有权限访问的文件）, 然后启动 supervisord（通过-c选项指定配置文件路径, 如果不指定会按照这个顺序查找配置文件: $CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf）:

$ supervisord -c /etc/supervisord.conf

3. 客户端操作-supervisorctl

supervisorctl是supervisord的一个命令行客户端工具, 用以查看被管理的应用程序列表, 状态, 及对其执行操作等. 执行此命令时需要指定与supervisord使用同一份配置文件, 否则与supervisord一样按照顺序查找配置文件.

supervisorctl -c /etc/supervisord.conf

上面这个命令会进入supervisorctl的shell界面, 然后可以执行不同的命令了:

status    # 查看程序状态
stop usercenter   # 关闭 usercenter 程序
start usercenter  # 启动 usercenter 程序
restart usercenter    # 重启 usercenter 程序
reread    ＃ 读取有更新（增加）的配置文件, 不会启动新添加的程序
update    ＃ 重启配置文件修改过的程序

上面这些子命令都有相应的输出, 除了进入supervisorctl的shell界面, 也可以直接在终端运行:

# 更新新的配置到supervisord    
supervisorctl update

# 重新启动配置中的所有程序
supervisorctl reload

# 启动某个进程
supervisorctl start program_name

# 查看正在守候的进程
supervisorctl

# 停止某一进程 (program_name=你配置中写的程序名称)
supervisorctl stop program_name

# 重启某一进程 (program_name=你配置中写的程序名称)
supervisorctl restart program_name

# 停止全部进程
supervisorctl stop all

**

配置文件参数说明

**

[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 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false     ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false     ;默认为false，向进程组发送kill信号，包括子进程

;包含其它配置文件
[include]
files = /etc/supervisor/conf.d/*.conf  ;可以指定一个或多个以.ini结束的配置文件

[program:hanxin-prd-worker]
user = hanxin
environment = HOME="/srv/hanxin",USER="hanxin"
command = /srv/hanxin/bin/run-parts.sh prd worker
startsecs = 8
autostart = true
stdout_logfile = /var/log/supervisor/%(program_name)s_stdout.log
stdout_logfile_maxbytes = 0
stdout_logfile_backups = 0
stderr_logfile = /var/log/supervisor/%(program_name)s_stderr.log
stderr_logfile_maxbytes = 0
stderr_logfile_backups = 0

supervisor