Supervisor 安装与配置

安装 supervisor

Yum 安装

1
2
3
4
5
6
7
8
# 配置 yum 源安装
yum install epel-release #安装yum源
yum install -y supervisor

# 启动 supervisor
/usr/bin/supervisord -c /etc/supervisord.conf
### 如果报错:error:class 'socket.error' [Errno 2] No such file or directory: file: /usr/lib64/python2.7/socket
/usr/bin/python2 /usr/bin/supervisord -c /etc/supervisord.conf

二进制安装

1
2
3
4
5
6
7
cd /usr/local/src
wget https://pypi.python.org/packages/7b/17/88adf8cb25f80e2bc0d18e094fcd7ab300632ea00b601cbbbb84c2419eae/supervisor-3.3.2.tar.gz

tar -zxvf supervisor-3.3.2.tar.gz
cd supervisor-3.3.2
python setup.py install #本地python版本为python2.7
# python2.7 setup.py install #本地python版本为python3以上

py工具安装

1
2
3
4
5
6
7
8
9
10
11
12
# 安装easy_install       
sudo yum install python-setuptools-devel

# 安装Supervisor
easy_install supervisor

# 生成配置文件
echo_supervisord_conf > /etc/supervisord.conf

# 启动
supervisord -c /etc/supervisord.conf
ps aux | grep supervisord

Supervisor 配置文件路径

1
2
supervisor配置文件:/etc/supervisord.conf
子进程配置文件路径:/etc/supervisord.d/

Supervisor 配置详解

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
[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

#包含其它配置文件
[include]
files = relative/directory/*.ini #可以指定一个或多个以.ini结束的配置文件

子进程配置文件说明

给需要管理的子进程(程序)编写一个配置文件,放在/etc/supervisor.d/目录下,以.ini作为扩展名(每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起)

如任意定义一个和脚本相关的项目名称的选项组(/etc/supervisord.d/test.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
#项目名
[program:blog]
#脚本目录
directory=/opt/bin
#脚本执行命令
command=/usr/bin/python /opt/bin/test.py

#supervisor启动的时候是否随着同时启动,默认True
autostart=true
#当程序exit的时候,这个program不会自动重启,默认unexpected,设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的退出码不在下面的exitcodes里面定义的
autorestart=false
#这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启动成功了。默认值为1
startsecs=1

#脚本运行的用户身份
user = test

#日志输出
stderr_logfile=/tmp/blog_stderr.log
stdout_logfile=/tmp/blog_stdout.log
#把stderr重定向到stdout,默认 false
redirect_stderr = true
#stdout日志文件大小,默认 50MB
stdout_logfile_maxbytes = 20MB
#stdout日志文件备份数
stdout_logfile_backups = 20

写个例子

1
2
3
4
5
6
7
8
[program:test] 
directory=/opt/bin
command=/usr/bin/python /opt/bin/test.py #最好使用绝对路径
autostart=true
autorestart=false
stderr_logfile=/tmp/test_stderr.log
stdout_logfile=/tmp/test_stdout.log
#user = test

以 Nginx 进程配置为例

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
35
[program: nginx]    
;管理的子进程。后面的是名字,最好写的具有代表性,避免日后”认错“

command=/usr/local/nginx/sbin/nginx -g 'daemon off;'
;我们的要启动进程的命令路径,可以带参数。

directory=/root ;
;进程运行前,会先切换到这个目录

autorestart=true;
;设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。false表示无论什么情况下,都不会被重新启动;unexpected表示只有当进程的退出码不在下面的exitcodes里面定义的退出码的时候,才会被自动重启。当为true的时候,只要子进程挂掉,将会被无条件的重启

autostart=true ;
;如果是true的话,子进程将在supervisord启动后被自动启动,默认就是true

stderr_logfile=/home/work/super/nginx_error.log ;
stdout_logfile=/home/work/super/nginx_stdout.log ;

environment=ASPNETCORE_ENVIRONMENT=Production ;
;这个是子进程的环境变量,默认为空

user=nginx ;
;可以用来管理该program的用户

stopsignal=INT
;进程停止信号,可以为TERM, HUP, INT, QUIT, KILL, USR1等,默认为TERM

startsecs=10 ;
;子进程启动多少秒之后,此时状态如果是running,我们认为启动成功了,默认值1

startretries=5 ; 当进程启动失败后,最大尝试的次数。当超过5次后,进程的状态变为FAIL

stopasgroup=true
;这个东西主要用于,supervisord管理的子进程,这个子进程本身还有子进程。那么我们如果仅仅干掉supervisord的子进程的话,子进程的子进程有可能会变成孤儿进程。所以可以设置这个选项,把整个该子进程的整个进程组干掉。默认false

Supervisor 常用命令

1
2
3
4
5
6
7
8
9
10
11
12
supervisorctl status        //查看所有进程的状态

supervisord //启动supervisord
supervisorctl start all //启动supervisord管理的所有进程
supervisorctl stop all //停止supervisord管理的所有进程
supervisorctl restart all // 重启所有进程
supervisorctl stop zedis //停止zedis, name为[program:xx]中的xx
supervisorctl start zedis //启动zedis
supervisorctl restart zedis //重启zedis
supervisorctl update //配置文件修改后使用该命令加载新的配置
supervisorctl reload //重新加载配置文件并启动
supervisorctl shutdown //停止supervisord