一、supervisor简介
项目中需要将一些自己开发的服务放到系统进程中在后台运行。一开始使用的是screen工具配合写了一个shell脚本,基本实现了启动、重启、停止操作,但是对于进程守护方面不是太稳定,经常遇到进程停止导致服务异常的情况。于是想借助于一个成熟的进程管理工具,来管理这些服务进程。经过筛选,决定使用supervisor。
supervisor是基于python开发的一套进程管理工具,能将普通的命令行进程放到系统后台运行,并对进程进行监控,出现异常时可以自动重启进程。使用起来也非常方便,安装好supervisor后,将要管理的进程的执行文件以及路径写进配置文件中即可实现进程守护。
二、supervisor安装
因为我的系统是ubuntu server 16.04,所以可以直接apt安装,(Debian/Ubuntu都可通过apt安装)
apt-get install supervisor
Centos可以yum安装,配置好yum源后,可以直接安装
yum install supervisor
还有另外两种安装方式(没有验证过,大家自行测试):
pip安装
pip install supervisor
easy_install安装
easy_install supervisor
三、supervisor配置文件位置
supervisor主要的配置文件在:
/etc/supervisor/supervisord.conf
ubuntu安装好supervisor后,默认的supervisord.conf配置文件中包含的配置项较少,更多的配置参数说明可以参考“配置文件说明”中的“supervisor.conf配置文件说明”
子进程配置文件路径:/etc/supervisor/conf.d/
每个需要守护的进程,建一个子进程配置文件。配置说明参考“配置文件说明”中的“子进程配置文件说明”
四、配置文件说明
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/*.conf ;可以指定一个或多个以.conf结束的配置文件
子进程配置文件说明:
每个子进程配置文件对应一个或者多个相关的需要进程守护的程序,在命名时可以定义一个相关的名称,方便记忆管理,如下面的配置
/etc/supervisor/conf.d/test.conf文件对应的是/opt/bin/test.py:
#项目名
[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 = 20M
#stdout日志文件备份数
stdout_logfile_backups = 20
子进程配置示例:
#说明同上
[program:test]
directory=/opt/bin
command=/opt/bin/test
autostart=true
autorestart=false
stderr_logfile=/tmp/test_stderr.log
stdout_logfile=/tmp/test_stdout.log
#user = test
五、supervisor命令说明
常用命令
supervisorctl status //查看所有进程的状态
supervisorctl stop test //停止test
supervisorctl start test //启动test
supervisorctl restart test //重启test
supervisorctl update //配置文件修改后使用该命令加载新的配置
supervisorctl reload //重新启动配置中的所有程序
将上面配置中的test换成all,是对所有的进程进行操作,如:
supervisorctl stop all //停止所有进程
supervisorctl start all //启动所有进程
supervisorctl restart all //重启所有进程
以上就是supervisor简单介绍和使用方法,后面会结合项目系统性地介绍一下supervisor的配合应用。