一.简介
Supervisor是一套用Python开发的进程管理程序,能将以命令启动的进程以后台守护方式运行(注:只支持将前台运行的程序转为后台,不支持后台转后台),并监控当前后台进程状态,异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的相关信息和命令配置进去即可。可用来将相关服务挂掉的时候自动启动起来,将supervisor配置开机自启动后可使服务进程像小强一样坚强——开机跟随自启,挂掉自动重开!
注:本文环境使用CenterOS 7 + Python 3.7 + Supervisor 4.2.0
二.安装
1.使用python的pip安装
pip install supervisor
2.使用centos的yum安装
yum -y install supervisor
三.说明
1.使用yum安装的supervisor
通过yum安装方式安装的supervisor相关配置文件已经安装OK,可使用命令查看
注:supervisor的配置文件注释是“;”
vi /etc/supervisor/supervisord.conf
2.使用pip安装的supervisor
通过pip安装的supervisor是没有将相关配置文件配置到相关路径的,需要自己手动配置。先找到supervisor路径,一般在当前python环境的bin目录下。
1)先进入supervisor文件目录
cd /usr/local/python-3.7/bin/
2)找到echo_supervisord_conf文件,新建目录并生成supervisor配置文件
mkdir /etc/supervisor /etc/supervisor/conf.d
/usr/local/python-3.7/bin/echo_supervisord_conf > /etc/supervisor/supervisord.conf
3)设置supervisord和supervisorctl的软连接到/user/bin目录下,方便调用
ln -s /usr/local/python-3.7/bin/supervisord /usr/bin/suppervisord
ln -s /usr/local/python-3.7/bin/supervisorctl /usr/bin/suppervisorctl
四.配置文件说明
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,如果设成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 = relative/directory/*.ini ;可以指定一个或多个以.ini结束的配置文件
需要管理的服务配置文件说明
在/etc/supervisor下创建conf.d用于放置需要管理的服务配置文件
[program:blog] ; 项目名
directory=/opt/bin ; 脚本目录
command=/usr/bin/python /opt/bin/test.py ; 脚本执行命令
autostart=true ; supervisor启动的时候是否随着同时启动,默认True
autorestart=false ; 当程序exit的时候,这个program不会自动重启,默认unexpected,设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的退出码不在下面的exitcodes里面定义的
startsecs=1 ; 这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启动成功了。默认值为1
user = test ; 脚本运行的用户身份
stderr_logfile=/tmp/blog_stderr.log ; 错误日志输出
stdout_logfile=/tmp/blog_stdout.log ; 输出日志输出
redirect_stderr = true ; 把stderr重定向到stdout,默认 false
stdout_logfile_maxbytes = 20M ; stdout日志文件大小,默认 50MB
stdout_logfile_backups = 20 ; stdout日志文件备份数
五.常用命令
supervisord -v //查看supervisor版本
supervisord -c /etc/supervisor/supervisord.conf //启动supervisor
supervisorctl status //查看所有进程的状态
supervisorctl stop all //停止es
supervisorctl start all //启动es
supervisorctl restart //重启es
supervisorctl update //配置文件修改后使用该命令加载新的配置
supervisorctl reload //重新启动配置中的所有程序
六.常见问题
1.出现unix:///var/run/supervisor.sock no such file
将supervisor配置文件将file=/tmp/supervisor.sock改为file=/var/run/supervisor.sock,并在/var/run/下新建supervisor.sock文件,并chmod -R 777 supervisor.sock 给予读写权限
2.使用supervisorctl status查看发现有进程被不断重启
supervisor只支持前台程序的托管到后台,例如redis就需要把配置文件中的daemonize设置为no,nginx就需要在命令行后缀增加-g ‘daemon off;’
; uwsgi
[program:featech_v2_0] ; 进程名
command = /root/.virtualenvs/featech_v2_0/bin/uwsgi --ini uwsgi.ini ; 启动命令
directory = /home/featech_v2_0/ ; 项目路径
stderr_logfile=/opt/qy/featech_v2_0/supervisord.uwsgi.err.log ; 错误日志文件
stdout_logfile=/opt/qy/featech_v2_0/supervisord.uwsgi.out.log ; 输出日志文件
autostart=true ; 跟随supervisor启动
autorestart=true ; 自动重启
;redirect_stderr=true ; 重定向stderr到stdout
; redis
[program:redis] ; 进程名
command = redis-server redis.conf ; 启动命令
directory = /usr/local/redis-3.2.3/ ; 项目路径
stderr_logfile=/opt/qy/featech_v2_0/supervisord.redis.err.log ; 错误日志文件
stdout_logfile=/opt/qy/featech_v2_0/supervisord.redis.out.log ; 输出日志文件
autostart=true ; 跟随supervisor启动
autorestart=true ; 自动重启
;redirect_stderr=true ; 重定向stderr到stdout
; mysql
[program:mysql] ; 进程名
command = /usr/local/mysql/bin/mysqld --basedir=/usr/local/mysql --datadir=/db/mysql --plugin-dir=/usr/local/mysql/lib/plugin --user=mysql --log-error=/db/mysql/error.log --open-files-limit=3072 --pid-file=/db/mysql/VM_16_10_centos.pid --socket=/tmp/mysql.sock --port=3306 ; 启动命令
directory = /home/featech_v2_0 ; 项目路径
stdout_logfile=/opt/qy/featech_v2_0/supervisord.mysql.out.log ; 输出日志文件
autostart=true ; 跟随supervisor启动
autorestart=true ; 自动重启
;redirect_stderr=true ; 重定向stderr到stdout
; nginx
[program:nginx] ; 进程名
command = nginx -g 'daemon off;' ; 启动命令
directory = /home/featech_v2_0 ; 项目路径
stdout_logfile=/opt/qy/featech_v2_0/supervisord.nginx.out.log ; 输出日志文件
autostart=true ; 跟随supervisor启动
autorestart=true ; 自动重启
;redirect_stderr=true ; 重定向stderr到stdout
; celery
[program:celery] ; 进程名
command = /root/.virtualenvs/featech_v2_0/bin/celery -A celery_tasks.sms.tasks worker -l info -c 10 ; 启动命令
directory = /home/featech_v2_0 ; 项目路径
stdout_logfile=/opt/qy/featech_v2_0/supervisord.celery.out.log ; 输出日志文件
autostart=true ; 跟随supervisor启动
autorestart=true ; 自动重启
;redirect_stderr=true ; 重定向stderr到stdout
注:uwsgi因为有自重启功能,挂载到supervisor是为了开机自启也便于统一管理
七.配置supervisor开机自启
a) 新建一个“supervisord.service”文件
# dservice for systemd (CentOS 7.0+)
# by ET-CS (https://github.com/ET-CS)
[Unit]
Description=Supervisor daemon
[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisorctl shutdown
ExecReload=/usr/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
[Install]
WantedBy=multi-user.target
b) 将文件拷贝至"/usr/lib/systemd/system/supervisord.service"
c) 执行命令
systemctl enable supervisord
d) 执行命令来验证是否为开机启动
systemctl is-enabled supervisord
e) 执行刷新配置
systemctl daemon-reload
f) 测试是否能正常运行
systemctl start supervisord.service
参考链接:
https://www.jianshu.com/p/0b9054b33db3
https://www.jianshu.com/p/39b476e808d8