Supervisor使用详解
一、supervisor简介
Supervisor是用Python开发的一套通用的进程管理程序,能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,可以选择是否自己启动和报警。supervisor还提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的user,这个user就可以管理它对应的进程。
二、supervisor安装
1、配置好apt-get源后,可以直接安装
apt-get install supervisor
2、pip安装
pip install supervisor
3、easy_install安装
easy_install supervisor
三、supervisor使用
创建目录,初始化配置文件
mkdir /etc/supervisor/
echo_supervisord_conf > /etc/supervisor/supervisord.conf
*注:1、为了不将所有新增配置信息全写在一个配置文件里,这里新建一个文件夹
mkdir /etc/supervisor/conf.d/
2、修改系统配置文件
vim /etc/supervisor/supervisord.conf
3、include 2.1中新建的conf.d文件夹下所有的conf
[include]
files = /etc/supervisor/conf.d/*.conf
supervisor配置文件:/etc/supervisor/supervisord.conf
*注:supervisor的配置文件默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足。*
子进程配置文件路径:/etc/supervisor/supervisord.d/
*注:默认子进程配置文件为ini格式,可在supervisor主配置文件中修改。*
四、配置文件说明
supervisor.conf配置文件说明:
1 [unix_http_server] 2 file=/tmp/supervisor.sock ;UNIX socket 文件,supervisorctl 会使用 3 ;chmod=0700 ;socket文件的mode,默认是0700 4 ;chown=nobody:nogroup ;socket文件的owner,格式:uid:gid 5 6 ;[inet_http_server] ;HTTP服务器,提供web管理界面 7 ;port=127.0.0.1:9001 ;Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性 8 ;username=user ;登录管理后台的用户名 9 ;password=123 ;登录管理后台的密码 10 11 [supervisord] 12 logfile=/tmp/supervisord.log ;日志文件,默认是 $CWD/supervisord.log 13 logfile_maxbytes=50MB ;日志文件大小,超出会rotate,默认 50MB,如果设成0,表示不限制大小 14 logfile_backups=10 ;日志文件保留备份数量默认10,设为0表示不备份 15 loglevel=info ;日志级别,默认info,其它: debug,warn,trace 16 pidfile=/tmp/supervisord.pid ;pid 文件 17 nodaemon=false ;是否在前台启动,默认是false,即以 daemon 的方式启动 18 minfds=1024 ;可以打开的文件描述符的最小值,默认 1024 19 minprocs=200 ;可以打开的进程数的最小值,默认 200 20 21 [supervisorctl] 22 serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord,路径与unix_http_server部分的file一致 23 ;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord 24 25 ; [program:xx]是被管理的进程配置参数,xx是进程的名称 26 [program:xx] 27 command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run ; 程序启动命令 28 autostart=true ; 在supervisord启动的时候也自动启动 29 startsecs=10 ; 启动10秒后没有异常退出,就表示进程正常启动了,默认为1秒 30 autorestart=true ; 程序退出后自动重启,可选值:[unexpected,true,false],默认为unexpected,表示进程意外杀死后才重启 31 startretries=3 ; 启动失败自动重试次数,默认是3 32 user=tomcat ; 用哪个用户启动进程,默认是root 33 priority=999 ; 进程启动优先级,默认999,值小的优先启动 34 redirect_stderr=true ; 把stderr重定向到stdout,默认false 35 stdout_logfile_maxbytes=20MB ; stdout 日志文件大小,默认50MB 36 stdout_logfile_backups = 20 ; stdout 日志文件备份数,默认是10 37 ; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件) 38 stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out 39 stopasgroup=false ;默认为false,进程被杀死时,是否向这个进程组发送stop信号,包括子进程 40 killasgroup=false ;默认为false,向进程组发送kill信号,包括子进程 41 42 ;包含其它配置文件 43 [include] 44 files = relative/directory/*.ini ;可以指定一个或多个以.ini结束的配置文件
子进程配置文件说明:
给需要管理的子进程(程序)编写一个配置文件,放在/etc/supervisor/conf.d/
目录下,以.ini
作为扩展名(每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起)。如任意定义一个和脚本相关的项目名称的选项组(/etc/supervisor/conf.d/test.conf)
1 #项目名 2 [program:blog] 3 #脚本目录 4 directory=/opt/bin 5 #脚本执行命令 6 command=/usr/bin/python /opt/bin/test.py 7 8 #supervisor启动的时候是否随着同时启动,默认True 9 autostart=true 10 #当程序exit的时候,这个program不会自动重启,默认unexpected,设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的退出码不在下面的exitcodes里面定义的 11 autorestart=false 12 #这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启动成功了。默认值为1 13 startsecs=1 14 15 #脚本运行的用户身份 16 user = test 17 18 #日志输出 19 stderr_logfile=/tmp/blog_stderr.log 20 stdout_logfile=/tmp/blog_stdout.log 21 #把stderr重定向到stdout,默认 false 22 redirect_stderr = true 23 #stdout日志文件大小,默认 50MB 24 stdout_logfile_maxbytes = 20M 25 #stdout日志文件备份数 26 stdout_logfile_backups = 20
子进程配置示例:
[program:test_one]
command=java -jar /data/smallvideo/supervisor/taskApp-exec.jar TaskTestOne ; 被监控的进程路径
priority=1 ; 数字越高,优先级越高
numprocs=1 ; 启动几个进程
autostart=true ; 随着supervisord的启动而启动
autorestart=true ; 自动重启
startretries=10 ; 启动失败时的最多重试次数
exitcodes=0 ; 正常退出代码
stopsignal=KILL ; 用来杀死进程的信号
stopwaitsecs=10 ; 发送SIGKILL前的等待时间
redirect_stderr=true ; 重定向stderr到stdout
[program:test_two]
command=java -jar /data/smallvideo/supervisor/taskApp-exec.jar TaskTestTwo ; 被监控的进程路径
priority=1 ; 数字越高,优先级越高
numprocs=1 ; 启动几个进程
autostart=true ; 随着supervisord的启动而启动
autorestart=true ; 自动重启
startretries=10 ; 启动失败时的最多重试次数
exitcodes=0 ; 正常退出代码
stopsignal=KILL ; 用来杀死进程的信号
stopwaitsecs=10 ; 发送SIGKILL前的等待时间
redirect_stderr=true ; 重定向stderr到stdout
五、supervisor命令说明
常用命令
supervisorctl status //查看所有进程的状态 supervisorctl stop es //停止es supervisorctl start es //启动es supervisorctl restart //重启es supervisorctl update //配置文件修改后使用该命令加载新的配置 supervisorctl reload //重新启动配置中的所有程序
注:把es
换成all
可以管理配置中的所有进程。直接输入supervisorctl
进入supervisorctl的shell交互界面,此时上面的命令不带supervisorctl可直接使用。
注意事项
使用supervisor进程管理命令之前先启动supervisord,否则程序报错。
使用命令supervisord -c /etc/supervisor/supervisord.conf
启动。
若是centos7
1 systemctl start supervisord.service //启动supervisor并加载默认配置文件 2 systemctl enable supervisord.service //将supervisor加入开机启动项
若是Ubuntu
1.在/lib/systemd/system/中添加supervisord.service文件
[Unit] Description=Supervisord Service [Service] Restart=on-failure RestartSec=42s User=myuser ExecStart=/home/myuser/.pyenv/versions/3.6.8/bin/supervisord -n -c /home/myuser/etc/supervisord.conf [Install]
User替换成你的用户名,ExecStart 命令中supervisord的路径替换成你自己的路径 supervisord.conf同样替换成你自己的配置路径,常用路径是/etc/supervisord.conf,因权限问题我在用户目录里添加了配置。
2.执行如下命令
sudo systemctl daemon-reload
sudo systemctl enable supervisord.service
sudo systemctl start supervisord.service
3.最后重启就可以看到,supervisor已经自启动
常见问题
- unix:///var/run/supervisor/supervisor.sock no such file
问题描述:安装好supervisor没有开启服务直接使用supervisorctl报的错
解决办法:supervisord -c /etc/supervisor/supervisord.conf
- command中指定的进程已经起来,但supervisor还不断重启
问题描述:command中启动方式为后台启动,导致识别不到pid,然后不断重启,这里使用的是elasticsearch,command指定的是$path/bin/elasticsearch -d
解决办法:supervisor无法检测后台启动进程的pid,而supervisor本身就是后台启动守护进程,因此不用担心这个 - 启动了多个supervisord服务,导致无法正常关闭服务
问题描述:在运行supervisord -c /etc/supervisor/supervisord.conf
之前,直接运行过supervisord -c /etc/supervisor/conf.d/xx.conf
导致有些进程被多个superviord管理,无法正常关闭进程。
解决办法:使用ps -fe | grep supervisord
查看所有启动过的supervisord服务,kill相关的进程。