supervisor 介绍
概念理解
supervisor 是类似于一个监管员,它在系统中是一个进程管理工具,当系统进程中断的时候 supervisor能自动重新启动它。可以运行在各种类unix的机器上;supervisor是用Python开发的一套通用的进程管理程序,能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。
supervisor是 Linux/Unix系统下(不支持Windows系统) 用Python开发的一套通用的进程管理程序(client/server服务),它能将一个普通的命令行进程变为后台daemon进程,并监控进程状态,异常退出时能自动重启(它可以很方便的监听、启动、停止、重启一个或多个进程。用Supervisor管理的进程,当一个进程意外被杀死,supervisort监听到进程死后,会自动将它重新拉起,很方便的做到进程自动恢复的功能,不再需要自己写shell脚本来控制)。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,可以选择是否自己启动和报警。supervisor还提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的user,这个user就可以管理它对应的进程。
由来及应用背景
在PHP项目中我们很可能会遇到有些脚本需要通过后台进程运行,比如:异步任务、定时器等等;如何保证这写进程被异常中断后能自动重启,不会影响应用的正常运作,我们之前可能都是通过nohup、&、screen来实现,管理起来比较麻烦;Supervisor可以让我们能将这些进程做成一个 start/stop/restart/reload的服务进行启动并进行管理,使用起来非常方便并且自动化。
supervisor 安装(以 Ubuntu 5.4.0-6ubuntu1~16.04.12 为例,supervisor版本3.2.0)
apt-get install supervisor
yum install supervisor #如果配置好了yum源后,可以直接使用yum安装
supervisor 配置文件
1,主配置文件:安装完成后我们就要进行配置了,打开 supervisor的主配置文件:/etc/supervisor/supervisord.conf(supervisor的配置文件中的配置参数默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足)
[unix_http_server] file=/var/run/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=/var/log/supervisor/supervisord.log ;日志文件,默认是 $CWD/supervisord.log logfile_maxbytes=50MB ;日志文件大小,超出会rotate,默认 50MB,如果设成0,表示不限制大小 logfile_backups=10 ;日志文件保留备份数量默认10,设为0表示不备份 loglevel=info ;日志级别,默认info,其它: debug,warn,trace pidfile=/var/run/supervisord.pid ;进程 pid 文件 nodaemon=false ;是否在前台启动,默认是false,即以 daemon 的方式启动 minfds=1024 ;可以打开的文件描述符的最小值,默认 1024 minprocs=200 ;可以打开的进程数的最小值,默认 200 [supervisorctl] serverurl=unix:///var/run/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 ;可以指定一个或多个以.conf结束的配置文件
2,我们可以将每一个需要让 supervisor 来管理的进程单独的进行配置放到子进程配置文件路径中:/etc/supervisor/conf.d/(默认子进程配置文件为.conf格式,可在supervisor主配置文件中修改),我们单独将需要配置的进程,都分别配置到单独的子进程配置文件中,这样管理起来分成方便
#项目名 [program:test] #脚本目录 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=/var/run/test_stderr.log stdout_logfile=/var/run/test_stdout.log #把stderr重定向到stdout,默认 false redirect_stderr = true #stdout日志文件大小,默认 50MB stdout_logfile_maxbytes = 20M #stdout日志文件备份数 stdout_logfile_backups = 20
supervisor 使用
1,使用命令 supervisord -c /etc/supervisor/supervisord.conf启动supervisor自身服务进程
2,使用命令 supervisorctl 来管理我们配置的进程
supervisorctl status //查看所有进程的状态 supervisorctl stop test //停止test supervisorctl start test //启动test supervisorctl restart test //重启test supervisorctl update //配置文件修改后使用该命令加载新的配置 supervisorctl reload //重新启动配置中的所有程序
把
test
换成all
可以管理配置中的所有进程。直接输入supervisorctl
进入supervisorctl的shell交互界面,此时上面的命令不带 supervisorctl可直接使用supervisor 常见问题
1、unix:///var/run/supervisor.sock no such file- 问题描述:安装好supervisor没有开启服务直接使用supervisorctl报的错
- 解决办法:supervisord -c /etc/supervisor/supervisord.conf
- 问题描述:command中启动方式为后台启动,导致识别不到pid,然后不断重启,这里使用的是elasticsearch,command指定的是$path/bin/elasticsearch -d
- 解决办法:supervisor无法检测后台启动进程的pid,而supervisor本身就是后台启动守护进程,因此不用担心这个
- 问题描述:在运行supervisord -c /etc/supervisor/supervisord.conf之前,直接运行过supervisord -c /etc/supervisor/conf.d/xx.conf导致有些进程被多个superviord管理,无法正常关闭进程
- 解决办法:使用ps -fe | grep supervisord查看所有启动过的supervisord服务,kill相关的进程