Supervisor的介绍
Supervisor (http://supervisord.org) 是一个用 Python 写的进程管理工具，可以很方便的用来启动、重启、关闭进程（不仅仅是 Python 进程）。除了对单个进程的控制，还可以同时启动、关闭多个进程，比如很不幸的服务器出问题导致所有应用程序都被杀死，此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。
此外，它还有一个用途，当你有一个进程需要每时每刻不断的跑，但是这个进程又有可能由于各种原因有可能中断时，Supervisor可以在当进程中断的时候自动重新启动它。
Supervisor的安装与配置
一、安装：
Supervisor的安装非常简单，可以根据自己的喜好选择合适的安装方式。实在不行，可以去官网下载安装包进行安装。
|
|
#可以通过pip进行安装
sudo
pip
install
supervisor
#easy_install工具
easy_install
supervisor
#Ubuntu\Debian下安装
sudo
apt
-
get
install
supervisor
|
二、配置：
Supervisor 是一个 C/S 模型的程序，supervisord 是server 端，对应的有 client 端：supervisorctl。Supervisor 的配置文件是/etc/supervisord.conf，通常情况下我们不需要修改它。在安装完 supervisor 之后，我们可以运行echo_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
34
|
#去除里面大部分注释和“不相关”的部分，主要看下这些配置：
[
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
=
relative
/
directory
/
*
.
ini
;可以是
*
.
conf或
*
.
ini
|
supervisord配置文件的启动顺序是：$CWD/supervisord.conf，$CWD/etc/supervisord.conf，/etc/supervisord.conf，也可以通过 -c 选项指定配置文件路径。
我们可以把所有配置项都写到 supervisord.conf 文件里，也可以把每个进程的配置文件单独分拆，放在/etc/supervisor/conf.d/目录下，以.conf作为扩展名来添加我们需要监管的程序。如果想要把配置文件存放在其他的路径下，也可以通过 include 的方式把不同的程序（组）写到不同的配置文件里（修改/etc/supervisord.conf 里 include 部分的的配置）。
因为我的目的仅仅只在于让python脚本随着Linux系统开机自启动，而且能够在出现错误的时候自动重启，所以我使用的是最简的配置：
|
|
[
program
:
py_website
]
command
=
python
/
home
/
shawn
/
Desktop
/
test
/
website
.
py
autorestart
=
true
autostart
=
true
user
=
nobody
|
其中，进程名称的定义在[program:py_website]中，command是命令，autorestart是当程序崩溃时自动重启程序，autostart是在supervisor开启时自动启动，user是进程运行的用户身份。当然，我们也可以根据自己的需求添加一些配置，如下所示：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
[
program
:
usercenter
]
directory
=
/
home
/
leon
/
projects
/
usercenter
;程序的启动目录
command
=
gunicorn
-
c
gunicorn
.
py
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
;可以通过
environment来添加需要的环境变量，一种常见的用法是修改
PYTHONPATH
;
environment
=
PYTHONPATH
=
$
PYTHONPATH
:
/
path
/
to
/
somewhere
|
更多配置可以查询supervisor的官方文档 http://supervisord.org/configuration.html
Supervisor的使用
Supervisor 的配置文件修改好了之后，我们就可以启动程序了。输入supervisorctl，就可以进入特定的 shell 界面，然后可以执行不同的命令了。
|
|
>
status
# 查看程序状态
>
stop
usercenter
# 关闭 usercenter 程序
>
start
usercenter
# 启动 usercenter 程序
>
restart
usercenter
# 重启 usercenter 程序
>
reread
＃读取有更新（增加）的配置文件，不会启动新添加的程序
>
update
＃重启配置文件修改过的程序
|
当然，我们也可以在bash终端下直接输入以下命令：
|
|
$
supervisorctl
status
$
supervisorctl
stop
usercenter
$
supervisorctl
start
usercenter
$
supervisorctl
restart
usercenter
$
supervisorctl
reread
$
supervisorctl
update
|
以上两种方法的效果是一样的，对于刚接触supervisor的朋友建议使用第一种，相对直观一些。
最后
如果纯粹把 Supervisor 作为一款进程管理软件，用来实现设置开机自启动及崩溃后自动重启的功能，是一件非常简单的事情。仅仅只需要根据这篇文章一步步的操作下去，它当然还有很多非常强大的功能，诸如：
除了 supervisorctl 之外，还可以配置 supervisrod 启动 web 管理界面，这个 web 后台使用 Basic Auth 的方式进行身份认证。
除了单个进程的控制，还可以配置 group，进行分组管理。
经常查看日志文件，包括 supervisord 的日志和各个 pragram 的日志文件，程序 crash 或抛出异常的信息一半会输出到 stderr，可以查看相应的日志文件来查找问题。
更多的内容可以翻阅官方的文档（http://supervisord.org/index.html），或者借助搜索引擎进行拓展阅读。
Supervisor的错误记录
最早之前设置好 Supervisor 后，我的网站可用性监控脚本就一直随着开机自动启动，没有出现啥问题。今天为了测试Nginx + Supervisor + Gunicorn的Flask项目环境配置，重新建了一个配置文件，然后出现了一堆问题。
unix:///tmp/supervisor.sock 不存在的错误
默认的配置文件是下面这样的，但是这里有个坑需要注意，supervisord.pid 以及 supervisor.sock 是放在 /tmp 目录下，但是 /tmp 目录是存放临时文件，里面的文件是会被 Linux 系统删除的，一旦这些文件丢失，就无法再通过 supervisorctl 来执行 restart 和 stop 命令了，将只会得到 unix:///tmp/supervisor.sock 不存在的错误。
|
|
file
=
/
var
/
run
/
supervisor
.
sock
;
(
the
path
to
the
socket
file
)
logfile
=
/
var
/
log
/
supervisor
/
supervisord
.
log
;
(
main
log
file
;
default
$
CWD
/
supervisord
.
log
)
pidfile
=
/
var
/
run
/
supervisord
.
pid
;
(
supervisord
pidfile
;
default
supervisord
.
pid
)
serverurl
=
unix
:
///var/run/supervisor.sock ; use a unix:// URL for a unix socket
|
权限问题
设置好配置文件后，应先创建上述配置文件中新增的文件夹。如果指定了启动用户 user，这里以 oxygen 为例，那么应注意相关文件的权限问题，包括日志文件，否则会出现没有权限的错误。例如设置了启动用户 oxygen，然后启动 supervisord 出现错误
Error: Cannot open an HTTP server: socket.error reported errno.EACCES (13)
就是由于上面的配置文件中 /var/run 文件夹，没有授予启动 supervisord 的用户 oxygen 的写权限。/var/run 文件夹实际上是链接到 /run，因此我们修改 /run 的权限。
sudo chmod 777 /run
一般情况下，我们可以用 root 用户启动 supervisord 进程，然后在其所管理的进程中，再具体指定需要以那个用户启动这些进程。
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
解决方法：
|
|
find
/
-
name
supervisor
.
sock
unlink
/
name
/
supervisor
.
sock
|
error: <class 'socket.error'="">, [Errno 13] Permission denied: file: /usr/lib/python2.7/socket.py line: 224