进程管理之supervisor
-
进程管理工具之supervisor(完整版)
Supervisor 介绍
Supervisor是用Python开发的一套通用的进程管理程序,能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,可以选择是否自己启动和报警。
官网
http://supervisord.org/installing.html
终于在Python3下可以正常使用pip安装了。
由于Supervisor是用Python开发的程序,在安装前,请确保系统已安装Python
pip install supervisor
upervisor安装完成后,会生成三个执行程序:supervisortd
、supervisorctl
、echo_supervisord_conf
,分别是supervisor的守护进程服务(用于接收进程管理命令)、客户端(用于和守护进程通信,发送管理进程的指令)、生成初始配置文件程序。
生成配置文件:mkdir Supervisor cd Supervisor/ echo_supervisord_conf > supervisord.conf
配置文件:
[unix_http_server] file=/tmp/supervisor.sock ;UNIX socket 文件,supervisorctl会使用其与supervisord通信 ;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/*.ini ;可以指定一个或多个以.ini结束的配置文件
配置管理进程
进程管理配置参数,不建议全都写在s upervisord.conf 文件中,建议每个进程写一个配置文件,并放在
include
配置块中files
指定的目录下,通过include
包含进 supervisord.conf 文件中。(ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# vim supervisord.conf # 最后加上 [include] ;files = relative/directory/*.ini files = /home/user/ITNest/Supervisor/*.ini
# 注意点:一定开启include启动Supervisor服务
(ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisord -c supervisord.conf (ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# tail /tmp/websocket.log
管理用户进程
交互终端
supervisord启动成功后,通过supervisorctl客户端来管理用户进程:启动、停止、重启。运行supervisorctl命令,会进入supervisor客户端的交互终端,并会列出当前所管理的所有进程。
输入help
,可以查看命令列表。如果想看某个命令的作用,运行“help 命令名称”,如:help stop
。stop daphne
表示停止daphne
进程,stop all
表示停止所有进程supervisorctl管理:命令 说明 help
打印可用操作的列表 help <action>
打印帮助<action> add <name> [...]
激活进程/组配置中的任何更新 remove <name> [...]
从活动配置中删除进程/组 update
重新加载配置和添加/删除必要的,并将重新启动受影响的程序 update all
重新加载配置和添加/删除必要的,并将重新启动受影响的程序 update <gname> [...]
更新特定的组,并将重新启动受影响的程序 clear <name>
清除进程的日志文件 clear <name> <name>
清除多个进程的日志文件 clear all
清除所有进程的日志文件 fg <process>
连接到前台模式下的进程,按Ctrl+C退出前台 pid
得到主控制器的PID pid <name>
按名称获取单个子进程的PID pid all
获取每个子进程的PID,每行一个 reload
重新启动远程监控程序 reread
重新加载守护进程的配置文件,无需添加/删除(无需重新启动) restart <name>
重启进程,注意:Restart不会重新读取配置文件。对此,请参阅reread和update restart <gname>:*
重启组内所有进程,注意:Restart不会重新读取配置文件。对此,请参阅reread和update restart <name> <name>
重新启动多个进程或组,注意:Restart不会重新读取配置文件。对此,请参阅reread和update restart all
重启所有进程,注意:Restart不会重新读取配置文件。对此,请参阅reread和update signal
start <name>
启动进程 start <gname>:*
在一个组中启动所有进程 start <name> <name>
启动多个进程或组 start all
开始所有进程 status
获取所有进程状态信息 status <name>
按名称获取单个进程的状态 status <name> <name>
获取多个已命名进程的状态 stop <name>
停止一个进程 stop <gname>:*
停止组中的所有进程 stop <name> <name>
停止多个进程或组 stop all
停止所有进程 `tail [-f] <name> [stdout stderr] (default stdout)` 输出进程日志的最后一部分,例如: tail -f <name>
按 Ctrl-C退出。tail -100 <name>
最后100个字节的进程非交互命令操作:(ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisorctl -c supervisord.conf restart Error: restart requires a process name restart <name> Restart a process restart <gname>:* Restart all processes in a group restart <name> <name> Restart multiple processes or groups restart all Restart all processes Note: restart does not reread config files. For that, see reread and update. (ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisorctl -c Supervisor/supervisord.conf restart all daphne: stopped daphne: started (ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisorctl -c supervisord.conf stop (ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisorctl -c supervisord.conf start
Web管理界面
出于安全考虑,默认配置没有开启web管理界面,需要修改 supervisord.conf 配置文件,以打开http访权限。
修改配置
将下面的配置
;[inet_http_server] ; inet (TCP) server disabled by default ;port=127.0.0.1:9001 ; ip_address:port specifier, *:port for all iface ;username=user ; default is no username (open server) ;password=123 ; default is no password (open server)
修改为:
[inet_http_server] ; inet (TCP) server disabled by default port=0.0.0.0:9001 ; ip_address:port specifier, *:port for all iface username=user ; default is no username (open server) password=user@user.com ; default is no password (open server)
浏览器访问 IP:9001
重启supervisor服务
(ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisorctl shutdown Shut down (ITNest) root@PxeCtrlSys:/home/user/ITNest/Supervisor# supervisord -c supervisord.conf
问题:
1.
Server requires authentication
error: <class 'xmlrpc.client.ProtocolError'>, <ProtocolError for 127.0.0.1/RPC2: 401 Unauthorized>: file: /data/python_envs/es-service/lib/python3.7/site-packages/supervisor/xmlr
pc.py line: 545场景:执行命令:supervisorctl shutdown 之后
这是因为开启了权限验证导致,可以通过执行supervisorctl 回车输入用户名+密码 进入之后进行shutdown操作
2.
http://localhost:9001 refused connection
启动方式:
supervisorctl -c supervisord.conf
服务加入系统:添加服务配置 vim /lib/systemd/system/supervisor.service [Unit] Description=supervisor After=network.target [Service] Type=forking ExecStart=/data/python_envs/es-service/bin/supervisord -c /data/Supervisor/supervisord.conf ExecStop=/data/python_envs/es-service/bin/supervisorctl $OPTIONS shutdown ExecReload=/data/python_envs/es-service/bin/supervisorctl $OPTIONS reload KillMode=process Restart=on-failure RestartSec=42s [Install] WantedBy=multi-user.target
设置文件权限: chmod 766 supservisor.service
3. unknown error making dispatchers for解决:原因是日志文件权限问题, 指定具体输出文件并设置对应的日志权限即可