前言
之前在论坛里看到有小伙伴写了关于使用supervisor来管理platon节点的文章https://forum.latticex.foundation/t/topic/1399,读完之后感觉很受用,这里也来详细说一下关于supervisor使用的一些细节。重点是关于supervisor的日志管理以及使用中的一些异常问题。
注:本文以Ubuntu18.04为例。
一、supervisor安装
apt安装
sudo apt-get install supervisor
二、supervisor使用
supervisor主配置文件:/etc/supervisord.conf
注:supervisor的配置文件默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足。
子进程配置文件路径:/etc/supervisord.d/
注:默认子进程配置文件为ini格式,可在supervisor主配置文件中修改。
三、配置文件说明
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管理界面,如果不使用http管理页面可以不配
;port=127.0.0.1:9001 ;Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性
;username=user ;登录管理后台的用户名
;password=123 ;登录管理后台的密码
[supervisord]
logfile=/var/log/supervisor/supervisord.log ;日志文件,默认是 /var/log/supervisor/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
子配置文件配置说明:
[include]
files =/etc/supervisor/conf.d/*.conf ;可以指定一个或多个以.confi结束的配置文件
子进程配置文件说明:
子配置文件即主配置文件include项中指定的配置用于配置具体的服务,这里放在/etc/supervisor/conf.d下,命名为platon.conf
[program:platon] ;platon为用户指定的服务名称
command=/usr/bin/bin/platon --identity platon --datadir /opt/platon/data --port 16789 --testnet --rpcport 6789 --rpcapi “db,platon,net,web3,admin,personal” --rpc --nodekey /opt/platon/data/nodekey --cbft.blskey /opt/platon/data/blskey --verbosity 3 --rpcaddr 127.0.0.1 --syncmode fast ; 程序启动命令
autostart=true ; 在supervisord启动的时候也自动启动
startsecs=10 ; 启动10秒后没有异常退出,就表示进程正常启动了,默认为1秒
autorestart=true ; 程序退出后自动重启,可选值:[unexpected,true,false],默认为unexpected,表示进程意外杀死后才重启
startretries=3 ; 启动失败自动重试次数,默认是3
user=pchuant ; 用哪个用户启动进程,默认是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/splaton/platon.log
stopasgroup=false ;默认为false,进程被杀死时,是否向这个进程组发送stop信号,包括子进程
killasgroup=false ;默认为false,向进程组发送kill信号,包括子进程
四、supervisor命令说明
常用命令
sudo supervisorctl status //查看所有进程的状态
sudo supervisorctl stop platon //停止platon进程
sudo supervisorctl start platon //启动platon
sudo supervisorctl restart //重启platon
sudo supervisorctl update //配置文件修改后使用该命令加载新的配置
sudo supervisorctl reload //重新启动配置中的所有程序
注:把platon换成all可以管理配置中的所有进程。直接输入supervisorctl进入supervisorctl的shell交互界面,此时上面的命令不带supervisorctl可直接使用。
systemctl start supervisor //启动supervisor并加载默认配置文件
systemctl enable supervisor //将supervisor加入开机启动项
五、关于supervisor配置中的日志管理
supervisor中的日志管理可以在配置文件中指定服务日志的保留份数和每份的大小,logfile_maxbytes设置每份日志大小,为0表示不限制大小,stdout_logfile_backups设置日志备份数,当备份数达到设置的数量时最早的日志将会被覆盖。而supervisor是没有对日志进行压缩归档设置的,这里就存在一个问题,如果单纯使用supervisor进行切分日志将会导致日志只能记录部分最近的日志,之前的日志很有可能被覆盖了。所以如果服务对日志切分归档有需求,建议将stdout_logfile_maxbyte和stdout_logfile_backup都设为0即不使用supervisor进行日志切分归档而是使用比如logrotate服务对节点日志进行切分压缩归档。关于logrotate服务的使用配置之后会单独用一篇文章来进行说明。
六、常见问题
问题1: unix:///var/run/supervisor/supervisor.sock no such file
问题描述:安装好supervisor没有开启服务直接使用supervisorctl报的错
解决办法:sudo systemctl start supervisord
问题2: command中指定的进程已经起来,但supervisor还不断重启
问题描述:command中启动方式为后台启动,导致识别不到pid,然后不断重启,例如es后台服务,command指定的是$path/bin/elasticsearch -d
解决办法:supervisor无法检测后台启动进程的pid,而supervisor本身就是后台启动守护进程,因此不用担心这个,解决方式将后台启动命令改为前台启动
问题3: 启动了多个supervisord服务,导致无法正常关闭服务
问题描述:在运行supervisord -c /etc/supervisord.conf之前,直接运行过supervisord -c /etc/supervisord.d/xx.conf导致有些进程被多个superviord管理,无法正常关闭进程。
解决办法:使用ps -fe | grep supervisord查看所有启动过的supervisord服务,kill相关的进程。