Supervisor介绍
Supervisor 允许其用户在UNIX类操作系统上控制多个进程。 块如下：
方便
需要为每个进程实例编写rc.d脚本通常是不方便的。 rc.d脚本是进程初始化/自动启动/管理的常用形式，但写入和维护可能会很痛苦。此外，rc.d脚本不能自动重新启动崩溃的进程，并且许多程序在崩溃时不会正常重新启动。Supervisord启动进程作为其子进程，并可以配置为在崩溃时自动重新启动它们。它也可以自动配置为在其自身的调用中启动进程。
准确性
在UNIX上的进程通常很难获得准确的上/下状态。Pidfiles经常说谎。Supervisord启动进程作为子进程，所以它总是知道它的子进程的真正的上/下状态，可以方便地查询这些数据。
进程组
进程通常需要以组为单位启动和停止，有时甚至在“优先级顺序”中。人们常常难以解释这一点。Supervisor 允许您为进程分配优先级，并允许用户通过supervisorctl客户端发出命令，如“全部启动”和“重新启动所有”，以预分配的优先级顺序启动它们。此外，进程可以分组为“进程组”，一组逻辑关联进程可以作为一个单元停止并启动。
特征
简单
Supervisor通过简单的INI风格的配置文件进行配置，易于学习。它提供了许多每个进程选项，使您的生活更容易，如重新启动失败的进程和自动日志轮换。
集中
进程可以单独或分组控制。您可以配置Supervisor以提供本地或远程命令行和Web界面。
高效
Supervisor通过fork / exec启动其子进程，子进程不进行后台进程。
扩展性强
Supervisor有一个简单的事件通知协议，用任何语言编写的程序都可以用来管理它，还有一个用于控制的XML-RPC接口。它还使用可以由Python开发人员利用的扩展点构建。
兼容
supervisor除Windows之外。它在Linux，Mac OS X，Solaris和FreeBSD上进行了测试和支持。它完全用Python编写，因此安装不需要C编译器。
稳定性
Supervisor已经存在多年，并已在许多服务器上使用。
Supervisor 组件
supervisord服务端程序。它负责在自己的调用中启动子程序，响应客户端的命令，重新启动崩溃或退出的子进程，记录其子进程stdout和stderr 输出，以及生成和处理对应于子进程生命周期中的“事件”。
配置文件。这通常位于/etc/supervisord.conf中。此配置文件是“Windows-INI”样式的配置文件。适当的文件系统权限来保护此文件非常重要，因为它可能包含未加密的用户名和密码。
supervisorctl
supervisor的命令行客户端名为 supervisorctl。它为supervisor提供的功能提供了一个类似shell的界面。从supervisorctl，用户可以连接到不同的 supervisord，停止和启动的子进程，并获得运行的进程的列表supervisord。
命令行客户端通过UNIX域套接字或Internet（TCP）套接字与服务器通信。服务器可以断言客户端的用户在允许他执行命令之前应该出现认证凭证。客户端进程通常使用与服务器相同的配置文件，但其中具有[supervisorctl]部分的任何配置文件都可以正常工作。
Web Server
Web Server 可以通过浏览器访问查看和控制进程状态，在置文件的 [inet_http_server]块里配置，访问服务器URL（例如 http：// localhost：9001 /）以通过Web界面查看和控制进程状态。
XML-RPC接口
服务于Web UI的相同的HTTP服务器提供了一个XML-RPC接口，可用于询问和控制supervisor及其运行的程序。请参阅XML-RPC API文档。
安装Supervisor的方法有很多种 具体请到Supervisor 官网
链接如下 http://supervisord.org/installing.html
YUM安装Supervisor
|
1
2
3
4
5
|
[
root
@
wuguiyunwei
~
]
# yum -y install epel-release wget
[
root
@
wuguiyunwei
~
]
# yum -y install supervisor
[
root
@
wuguiyunwei
~
]
# echo_supervisord_conf > /etc/supervisord.conf
[
root
@
wuguiyunwei
~
]
# systemctl start supervisord
[
root
@
wuguiyunwei
~
]
# systemctl status supervisord
|
supervisord 配置
Supervisor 相当强大，提供了很丰富的功能，不过我们可能只需要用到其中一小部分。安装完成之后，可以编写配置文件，来满足自己的需求。为了方便，我们把配置分成两部分：supervisord（supervisor 是一个 C/S 模型的程序，这是 server 端，对应的有 client 端：supervisorctl）和应用程序（即我们要管理的程序）。
首先来看 supervisord 的配置文件。安装完 supervisor 之后，可以运行echo_supervisord_conf 命令输出默认的配置项，也可以重定向到一个配置文件里：
echo_supervisord_conf > /etc/supervisord.conf
去除里面大部分注释和“不相关”的部分，我们可以先看这些配置：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
[
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
p
must
remain
in
the
config
file
for
RPC
;
(
supervisorctl
/
web
interface
)
to
work
,
additional
interfaces
may
be
;
added
by
defining
them
in
separate
rpcinterface
:
ps
[
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
=
relative
/
directory
/
*
.ini
;
可以是
*
.conf
或
*
.ini
|
我们把上面这部分配置保存到 /etc/supervisord.conf（或其他任意有权限访问的文件），然后启动 supervisord（通过 -c 选项指定配置文件路径，如果不指定会按照这个顺序查找配置文件：$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf）：
|
1
|
supervisord
-
c
/
etc
/
supervisord
.conf
|
查看 supervisord 是否在运行：
|
1
|
ps
aux
|
grep
supervisord
|
program 配置
上面我们已经把 supervisrod 运行起来了，现在可以添加我们要管理的进程的配置文件。这些配置可以都写到 supervisord.conf 文件里，如果应用程序很多，最好通过 include 的方式把不同的程序（组）写到不同的配置文件里。
为了举例，我们新建一个目录 /etc/supervisor/ 用于存放这些配置文件，相应的，把 /etc/supervisord.conf 里 include 部分的的配置修改一下：
|
1
2
|
[
include
]
files
=
/
etc
/
supervisor
/
*
.conf
|
假设有个用 Flask 开发的用户系统 usercenter, 生产环境使用 gunicorn 运行。项目代码位于 /home/leon/projects/usercenter，WSGI 对象位于 wsgi.py。在命令行启动的方式是这样的：
|
1
2
|
cd
/
home
/
leon
/
projects
/
usercenter
gunicorn
-
w
8
-
b
0.0.0.0
:
17510
wsgi
:
app
|
对应的配置文件可能是：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
[
program
:
usercenter
]
directory
=
/
home
/
leon
/
projects
/
usercenter
;
程序的启动目录
command
=
gunicorn
-
w
8
-
b
0.0.0.0
:
17510
wsgi
:
app
;
启动命令
autostart
=
true
;
在
supervisord
启动的时候也自动启动
startsecs
=
5
;
启动
5
秒后没有异常退出，就当作已经正常启动了
autorestart
=
true
;
程序异常退出后自动重启
startretries
=
3
;
启动失败自动重试次数，默认是
3
user
=
leon
;
用哪个用户启动
redirect_stderr
=
true
;
把
stderr
重定向到
stdout，默认
false
stdout_logfile_maxbytes
=
20MB
;
stdout
日志文件大小，默认
50MB
stdout_logfile_backups
=
20
;
stdout
日志文件备份数
;
stdout
日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（
supervisord
会自动创建日志文件）
stdout_logfile
=
/
data
/
logs
/
usercenter_stdout
.
log
|
其中 [program:usercenter] 中的 usercenter 是应用程序的唯一标识，不能重复。对该程序的所有操作（start, restart 等）都通过名字来实现。
Tips 1: Python 环境
有两种方式指定程序使用的 Python 环境：
command 使用绝对路径。假设使用 pyenv 来管理 Python 环境，上面例子中的 gunicorn 路径可以替换为 /home/leon/.pyenv/versions/usercenter/bin/gunicorn. 这种方式一目了然，推荐。
通过 environment 配置 PYTHONPATH.environment=PYTHONPATH=$PYTHONPATH:/home/leon/.pyenv/versions/usercenter/bin/.environment 这个配置项非常有用，可以用来给程序传入环境变量。
Tips 2: 后台进程
Supervisor 只能管理在前台运行的程序，所以如果应用程序有后台运行的选项，需要关闭。
Tips 3: 子进程
有时候用 Supervisor 托管的程序还会有子进程（如 Tornado），如果只杀死主进程，子进程就可能变成孤儿进程。通过这两项配置来确保所有子进程都能正确停止：
|
1
2
|
stopasgroup
=
true
killasgroup
=
true
|
使用 supervisorctl
Supervisorctl 是 supervisord 的一个命令行客户端工具，启动时需要指定与 supervisord 使用同一份配置文件，否则与 supervisord 一样按照顺序查找配置文件。
|
1
|
supervisorctl
-
c
/
etc
/
supervisord
.conf
|
上面这个命令会进入 supervisorctl 的 shell 界面，然后可以执行不同的命令了：
|
1
2
3
4
5
6
|
>
status
# 查看程序状态
>
stop
usercenter
# 关闭 usercenter 程序
>
start
usercenter
# 启动 usercenter 程序
>
restart
usercenter
# 重启 usercenter 程序
>
reread
＃
读取有更新（增加）的配置文件，不会启动新添加的程序
>
update
＃
重启配置文件修改过的程序
|
上面这些命令都有相应的输出，除了进入 supervisorctl 的 shell 界面，也可以直接在 bash 终端运行：
|
1
2
3
4
5
6
|
$
supervisorctl
status
$
supervisorctl
stop
usercenter
$
supervisorctl
start
usercenter
$
supervisorctl
restart
usercenter
$
supervisorctl
reread
$
supervisorctl
update
|
其它
除了 supervisorctl 之外，还可以配置 supervisrod 启动 web 管理界面，这个 web 后台使用 Basic Auth 的方式进行身份认证。
除了单个进程的控制，还可以配置 group，进行分组管理。
经常查看日志文件，包括 supervisord 的日志和各个 pragram 的日志文件，程序 crash 或抛出异常的信息一半会输出到 stderr，可以查看相应的日志文件来查找问题。
Supervisor 有很丰富的功能，还有其他很多项配置，可以在官方文档获取更多信息：http://supervisord.org/index.html
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
