supervisor是一个管理进程的工具,使用python语言开发的通用的管理程序,可以管理和监控Linux上的指定进程,能将进程变成后台的daemon,并监控进程状态,出现异常退出时能自动重启。
本文使用的是 supervisor-3.3.5.tar.gz 版本的supervisor进程管理工具。有需要的可以到下方的连接处获取。
安装
首先确保已安装Python2.7.5,一般linux系统自带安装,然后安装三个包确保supervisor能成功安装。
cd /data/software/supervisor/ tar -zxvf meld3-1.0.2.tar.gz tar -zxvf setuptools-0.6c11.tar.gz tar -zxvf supervisor-3.3.5.tar.gz cd meld3-1.0.2/ python setup.py build && python setup.py install cd ../setuptools-0.6c11/ python setup.py build && python setup.py install cd ../supervisor-3.3.5/ python setup.py build && python setup.py install
安装好后 初始化配置文件
mkdir -p /etc/supervisor/init.d
mkdir -p /etc/supervisor/tmp
echo_supervisord_conf > /etc/supervisor/supervisord.conf
初始化好配置文件后,编辑配置文件,按以下位置修改配置文件
vim /etc/supervisor/supervisord.conf # 1处 [unix_http_server] file=/etc/supervisor/tmp/supervisor.sock ; the path to the socket file # 2处 两个文件位置需要修改 [supervisord] logfile=/etc/supervisor/tmp/supervisord.log ; main log file; default $CWD/supervisord. loglogfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MBlogfile_backups=10 ; # of main logfile backups; 0 means none, default 10 loglevel=info ; log level; default info; others: debug,warn,trace pidfile=/etc/supervisor/tmp/supervisord.pid ; supervisord pidfile; default supervisord.pid # 3处 [supervisorctl] serverurl=unix:///etc/supervisor/tmp/supervisor.sock ; use a unix:// URL for a unix socket # 4处 指定 ini配置文件位置 [include] files = /etc/supervisor/init.d/*.ini
保存退出。
启动服务
supervisord -c /etc/supervisor/supervisord.conf # 启动服务
设置开机启动
创建文件 /usr/lib/systemd/system/supervisord.service 内容如下:
[Unit] Description=Supervisor daemon After=network.target [Service] Type=forking User=root ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf ExecReload=/usr/bin/supervisorctl shutdown ExecStop=/usr/bin/supervisorctl reload KillMode=process Restart=on-failure RestartSec=42s [Install] WantedBy=multi-user.target
保存退出。
设置开机启动
systemctl daemon-reload # 重新加载 systemctl配置 systemctl enable supervisord.service # 设置开机启动 systemctl disable supervisord.service # 禁止开机启动 systemctl is-active supervisord.service #(仅显示是否Active) systemctl list-units --type=service # 显示所有已启动的服务 systemctl is-enabled supervisord.service 验证一下是否为开机启动
进程配置说明:
[program:tomcat] ;这个就是咱们要管理的子进程了,":"后面的是名字,最好别乱写和实际进程有点关联最好。这样的program我们可以设置一个或多个,一个program就是要被管理的一个进程 command=/usr/local/tomcat/bin/startup.sh ; 这个就是我们的要启动进程的命令路径了,可以带参数例子:/home/test.py -a 'hehe' 有一点需要注意的是,我们的command只能是那种在终端运行的进程,不能是守护进程。这个想想也知道了,比如说command=service httpd start。httpd这个进程被linux的service管理了,我们的supervisor再去启动这个命令这已经不是严格意义的子进程了。这个是个必须设置的项 ;process_name=%(program_name)s ; 这个是进程名,如果我们下面的numprocs参数为1的话,就不用管这个参数了,它默认值%(program_name)s,也就是上面的那个program冒号后面的名字,但是如果numprocs为多个的话,那就不能这么干了。 ;numprocs=1 ; 启动进程的数目。当不为1时,就是进程池的概念,注意process_name的设置,默认为1,非必须 directory=/tmp ; 进程运行前,会先切换到这个目录,默认不设置。。。非必须设置 ;umask=022 ; 进程掩码,默认none,非必须 priority=999 ; 子进程启动关闭优先级,优先级低的,最先启动,关闭的时候最后关闭,默认值为999 。。非必须 autostart=true ; 如果是true的话,子进程将在supervisord启动后被自动启动,默认就是true 。。非必须 autorestart=true ; 这个是设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的退出码不在下面的exitcodes里面定义的退出码的时候,才会被自动重启。当为true的时候,只要子进程挂掉,将会被无条件的重启 ;startsecs=1 ; 这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启动成功了,默认值为1 。。非必须 ;startretries=3 ; 当进程启动失败后,最大尝试启动的次数。。当超过3次后,supervisor将把此进程的状态置为FAIL,默认值为3 。。非必须 ;exitcodes=0,2 ; 注意和上面的的autorestart=unexpected对应。。exitcodes里面的定义的退出码是expected的。 ;stopsignal=QUIT ; 进程停止信号,可以为TERM, HUP, INT, QUIT, KILL, USR1, or USR2等信号,默认为TERM 。当用设定的信号去干掉进程,退出码会被认为是expected.非必须 ;stopwaitsecs=10 ; 这个是当我们向子进程发送stopsignal信号后,到系统返回信息给supervisord,所等待的最大时间。超过这个时间,supervisord会向该子进程发送一个强制kill的信号。默认为10秒。。非必须 ;stopasgroup=false ; 这个东西主要用于supervisord管理的子进程,这个子进程本身还有子进程。那么我们如果仅仅干掉supervisord的子进程的话,子进程的子进程有可能会变成孤儿进程。所以咱们可以设置该选项,把整个该子进程的整个进程组都干掉。设置为true的话,一般killasgroup也会被设置为true。需要注意的是,该选项发送的是stop信号默认为false。。非必须 ;killasgroup=false ; 这个和上面的stopasgroup类似,不过发送的是kill信号 user=centos ; 如果supervisord是root启动,我们在这里设置这个非root用户,可以用来管理该program,默认不设置。非必须 redirect_stderr=true ; 如果为true,则stderr的日志会被写入stdout日志文件中,默认为false,非必须 stdout_logfile=/a/path ; 子进程的stdout的日志路径,可以指定路径,AUTO,none等三个选项。设置为none的话,将没有日志产生。设置为AUTO的话,将随机找一个地方生成日志文件,而且当supervisord重新启动的时候,以前的日志文件会被清空。当 redirect_stderr=true的时候,sterr也会写进这个日志文件 stdout_logfile_maxbytes=50MB ; 日志文件最大大小,和[supervisord]中定义的一样。默认为50 stdout_logfile_backups=10 ; 和[supervisord]定义的一样。默认10 ;stdout_capture_maxbytes=1MB ; 这个东西是设定capture管道的大小,当值不为0的时候,子进程可以从stdout发送信息,而supervisor可以根据信息,发送相应的event。默认为0,为0的时候表达关闭管道。。。非必须 ;stdout_events_enabled=false ; 当设置为ture的时候,当子进程由stdout向文件描述符中写日志的时候,将触发supervisord发送PROCESS_LOG_STDOUT类型的event,默认为false。。。非必须 ;stderr_logfile=/a/path ; 这个东西是设置stderr写的日志路径,当redirect_stderr=true。这个就不用设置了,设置了也是白搭。因为它会被写入stdout_logfile的同一个文件中默认为AUTO,也就是随便找个地存,supervisord重启被清空。。非必须 ;stderr_logfile_maxbytes=1MB ; 这个出现好几次了,就不重复了 ;stderr_logfile_backups=10 ; 这个也是 ;stderr_capture_maxbytes=1MB ; 这个一样,和stdout_capture一样。默认为0,关闭状态 ;stderr_events_enabled=false ; 这个也是一样,默认为false ;environment=A="1",B="2" ; 这个是该子进程的环境变量,和别的子进程是不共享的 ;serverurl=AUTO ;
常用命令
supervisorctl start ${program} # 启动进程
supervisorctl stop ${program} # 停止进程
supervisorctl restart ${program} # 重启进程
supervisorctl update # 更新进程配置
supervisorctl status ${program} # 查看进程状态
supervisorctl shutdown #关闭supervisord服务
supervisorctl reload #重启supervisord服务
supervisorctl stop all #停止所有进程
以上为使用进程管理工具时常用的一些配置及命令等,如需要更详细的使用说明,请登录官网查看。
官网地址:http://www.supervisord.org/index.html
常见错误:
1. supervisor ERROR (spawn error)
可以查看运行的日志tmp cat /tmp/supervisord.log 并不是详细的错误数据 查看详细错误: supervisorctl tail 任务名称 stdout