Supervisor的安装与使用

简介

Supervisor 是用 Python 开发的一套通用的 进程管理程序 ，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启 。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程。

(一)安装步骤

1.1 安装Supervisor

# 根目录下执行安装命令
yum install supervisor

# 安装生成路径：
# \etc\supervisor.d  
# \etc\supervisor.conf 主配置文件

## 查看版本
supervisord -v

1.2 修改主配置

操作路径： \etc\supervisor.conf

# 找到最后一行：去掉注file释；
[include]
files = supervisord.d/*.ini

1.3 设置开机自启

• 配置 supervisord.service

vim /usr/lib/systemd/system/supervisord.service

# 编辑文件如下
[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisorctl shutdown
ExecReload=/usr/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
 
[Install]
WantedBy=multi-user.target

• 设置开机自启动

systemctl enable supervisord

## 验证是否开机自启
systemctl is-enabled supervisord
# 返回：enabled|unenabled

1.4 子进程配置

创建文件： \etc\supervisor.d\task_queue.ini

[program:task_queue]
# 执行命令
command=php think queue:work --queue taskQueue
# 运行目录
directory=/www/wwwroot/GameAdmin
# 自动启动
autostart=true
# 自动重启
autorestart=true
#启动 3 秒后没有异常退出，就当作已经正常启动了
startsecs=3
startretries=3
# 日志记录以及日志文件配置
stdout_logfile=/www/wwwlogs/queque_log/task_queue.out.log
stderr_logfile=/www/wwwlogs/queque_log/task_queue.log
stdout_logfile_maxbytes=2MB
stderr_logfile_maxbytes=2MB
# 用户权限
user=www
# 优先级
priority=999
# 进程数
numprocs=2
# 进程名称
process_name=%(program_name)s_%(process_num)02d

1.5 创建日志目录

cd /www/wwwlogs/
mkdir queque_log

# 日志文件supervisor会自动创建

1.6 重启服务

systemctl restart  supervisord

# 查看服务状态：active启动
[root@root]# systemctl status supervisord
● supervisord.service - Process Monitoring and Control Daemon
   Loaded: loaded (/usr/lib/systemd/system/supervisord.service; enabled; vendor preset: disabled)
   Active: active (running) 

1.8 重载配置

# 重启指定的进程服务
supervisord -c /etc/supervisord.conf

# 如果执行该命令出现：项目已经启动，可以采用命令行工具更新配置
supervisorctl update 

1.9 查看服务状态

supervisorctl status 

1.10 验证配置

配置文件 ( task_queue.ini ) 中设置服务挂掉，自动启动的，这里大家可以看看配置是否生效

# 杀死进程
pkill supervisord
# 查看进程状态：状态自动运行中则生效
ps aux | grep supervisord

(二)命令行工具

supervisorctl是supervisord的命令行客户端管理工具，实现对子进程的管理。
友情提醒：在使用该工具时，请先启动 supervisord 服务

命令	释义
supervisorctl status	守护进程状态
supervisorctl stop 进程名	关闭进程 （不会重新读取配置文件）
supervisorctl stop 进程名:*	关闭某类进程
supervisorctl stop all	关闭所有的进程
supervisorctl start 进程名	开启进程 （不会重新读取配置文件）
supervisorctl start 进程名:*	开启某类进程
supervisorctl start all	开启所有的进程
supervisorctl restart 进程名	重启进程 （不会重新读取配置文件）
supervisorctl restart进程名:*	重启某类进程
supervisorctl restart all	重启所有的进程
supervisorctl reload	重启supervisord（更新所有服务的配置文件，并重启所有服务 ）
supervisorctl update	更新配置文件(重启配置文件有更新的进程，相当于 reread + restart，服务会使用新配置 )
supervisorctl reread	只会更新配置文件 ，不会重启进程，服务实际未使用新配置

(三)问题&解决

3.1 服务已经存在

Error: Another program is already listening on a port that one of our HTTP servers is configured to use.  S...ervisord

• 解决方案

  (1) 查看服务进程

  ps aux | grep supervisord
  

  (2) 杀死进程

  pkill supervisord
  

  (3) 重启服务

  supervisorctl restart all
  

  (4) 查看进程状态

  supervisorctl status 
  
  ## 结果如示：running运行中
  task_queue:task_queue_00         RUNNING   pid 24138, uptime 0:17:28
  task_queue:task_queue_01         RUNNING   pid 24137, uptime 0:17:28
  

3.2 开启服务失败

unix:///var/run/supervisor/supervisor.sock no such file

• 解决方案：启动服务

systemctl start  supervisord

3.3 Exited too quickly (process log may have details)

# 启动所有的进程
supervisorctl start all
# 查看所有的进程状态
supervisorctl status
# 显示running则成功
task_queue:task_queue_00         RUNNING   pid 18381, uptime 1:04:53
task_queue:task_queue_01         RUNNING   pid 18380, uptime 1:04:53

3.4 错误定位

往往我们在启动服务的时候或多或少会有问题，可以去自定义的(子进程配置文件)日志存储路径查看具体的详细错误

操作路径： /www/wwwlogs/queque_log/task_queue.log

cd /www/wwwlogs/queque_log/
tail -f task_queue.log