前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >Supervisor | 笔记

Supervisor | 笔记

作者头像
yiyun
发布2022-04-01 17:03:57
发布2022-04-01 17:03:57
1.1K00
代码可运行
举报
文章被收录于专栏:yiyun 的专栏yiyun 的专栏
运行总次数:0
代码可运行

引言

安装

这里使用 pip 安装,需要确保安装了 pip

代码语言:javascript
代码运行次数:0
运行
复制
pip install supervisor

这里我额外安装了 pip3 ,因此使用的 pip3

supervisor安装完成后会生成三个执行程序: supervisortd、supervisorctl、echo_supervisord_conf, 分别是supervisor的 守护进程服务(用于接收进程管理命令)、客户端(用于和守护进程通信,发送管理进程的指令)、生成初始配置文件程序。

补充:

通过 yum 安装的版本有点老了

代码语言:javascript
代码运行次数:0
运行
复制
yum info supervisor

通过 yum install supervisor 安装的自带开机自启动service,无需再创建

创建配置文件

安装完成后,可以通过执行 echo_supervisord_conf ,得到一个示例配置文件。

代码语言:javascript
代码运行次数:0
运行
复制
echo_supervisord_conf > /etc/supervisord.conf

补充: 如果你没有 root 访问权限,你不能放 supervisord.conf 文件在 /etc/supervisord.conf, 这时,你可以放在当前目录 (echo_supervisord_conf > supervisord.conf), 并且 启动 supervisord 使用 -c 指定配置文件的位置, 例如,supervisord -c supervisord.conf

运行 Supervisor

参考:

supervisor配置文件:/etc/supervisord.conf 子进程配置文件路径:/etc/supervisord.d/

supervisor.conf 配置文件

注意:此配置文件的注释采用 ;

代码语言:javascript
代码运行次数:0
运行
复制
[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/*.ini    ;可以指定一个或多个以.ini结束的配置文件

创建文件夹用于 存放 子进程配置文件

代码语言:javascript
代码运行次数:0
运行
复制
mkdir /etc/supervisord.d/

修改系统配置文件

代码语言:javascript
代码运行次数:0
运行
复制
vi /etc/supervisord.conf

添加一行 include 新建的supervisord.d文件夹下所有的conf

代码语言:javascript
代码运行次数:0
运行
复制
[include]
files = /etc/supervisord.d/*.conf

子进程配置文件说明

给需要管理的子进程(程序)编写一个配置文件,放在/etc/supervisor.d/目录下, 以.ini作为扩展名(每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起)。 如任意定义一个和脚本相关的项目名称的选项组( /etc/supervisord.d/test.conf

代码语言:javascript
代码运行次数:0
运行
复制
# 项目名
[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 = 20MB
# stdout日志文件备份数
stdout_logfile_backups = 20

子进程配置示例

program: 是唯一不可重复的,用来唯一标识一个服务

/etc/supervisord.d/test.conf

代码语言:javascript
代码运行次数:0
运行
复制
[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=root

ngrok配置supervisor进程守护

/etc/supervisord.d/ngrokd.conf

代码语言:javascript
代码运行次数:0
运行
复制
[program:ngrokd]
command = /usr/ngrok/bin/ngrokd -domain="tunnel.51ngrok.cn" -httpAddr=":8080" -httpsAddr=":8081" -tlsKey="/usr/ngrok/bin/51ngrok.key" -tlsCrt="/usr/ngrok/bin/51ngrok.crt"
directory = /usr/ngrok/bin
process_name = %(program_name)s_%(process_num)s
numprocs = 1 ;注意这里只能为1
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 5        ; 启动 5 秒后没有异常退出,就当作已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数,默认是 3
user = root          ; 用哪个用户启动
stdout_logfile=/logs/ngroklog/ngrok.out.log
stdout_logfile_maxbytes = 10MB
stderr_logfile=/logs/ngroklog/ngrok.err.log
stderr_logfile_maxbytes = 10MB

/etc/supervisord.d/mirai.conf

代码语言:javascript
代码运行次数:0
运行
复制
[program:mirai]
directory=/root/mirai/
command=bash /root/mirai/mcl
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 5        ; 启动 5 秒后没有异常退出,就当作已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数,默认是 3
user = root          ; 用哪个用户启动
stderr_logfile=/tmp/mirai_stderr.log
stdout_logfile=/tmp/mirai_stdout.log
user=root

其中路径,建议尽量使用绝对路径

supervisor命令说明

常用命令

代码语言:javascript
代码运行次数:0
运行
复制
supervisorctl status        // 查看所有进程的状态
supervisorctl stop es       // 停止es
supervisorctl start es      // 启动es
supervisorctl restart       // 重启es
supervisorctl update        // 配置文件修改后使用该命令加载新的配置
supervisorctl reload        // 重新启动配置中的所有程序

注:把es换成all可以管理配置中的所有进程。 直接输入supervisorctl进入supervisorctl的shell交互界面, 此时上面的命令不带supervisorctl可直接使用。

supervisorctl 管理客户端

上面配置好 Supervisord 服务端后,平时对被托管的服务的管理操作,需要使用 supervisorctl 客户端工具。

托管服务管理

代码语言:javascript
代码运行次数:0
运行
复制
supervisorctl status # 查看当前管理的子进程
supervisorctl reload # 当配置发生改变时,进行热部署
supervisorctl restart [program_name] # 重启某个子进程
supervisorctl start [program_name] # 启动某个子进程
supervisorctl remove # 移除某个托管服务
supervisorctl update # 更新配置
supervisorctl fg # 连接一个在后台运行的进程
supervisorctl tail # 查看托管服务进程的标准输出信息

使用 supervisorctl fg mirai 即可再次连接在后台运行的 mirai 进程, 如果进程Mirai Console接收输入,即可通过此方式切换过去输入命令

Supervisord 进程管理

代码语言:javascript
代码运行次数:0
运行
复制
supervisorctl open # 链接一个远程 Supervisord 服务
supervisorctl shutdown # 关闭某个原创的 Supervisord 服务
supervisorctl pid # 获取 Supervisord 服务或托管服务的进程号
supervisorctl signal # 对 Supervisord 服务或者托管服务发送信号
supervisorctl add # 添加托管的服务进程
supervisorctl avail # 展示所有托管服务进程信息
supervisorctl maintail # 查看 Supervisord 进程的标准输出信息

注意事项

参考:

使用supervisor进程管理命令之前先启动supervisord,否则程序报错。 使用命令supervisord -c /etc/supervisord.conf启动。 若是centos7:

开机启动项

CentOS 7 开机启动

代码语言:javascript
代码运行次数:0
运行
复制
vi /usr/lib/systemd/system/supervisord.service
代码语言:javascript
代码运行次数:0
运行
复制
[Unit] 
Description=Supervisor daemon

[Service] 
Type=forking 
ExecStart=/usr/local/python3/bin/supervisord -c /etc/supervisord.conf 
ExecStop=/usr/local/python3/bin/supervisorctl shutdown 
ExecReload=/usr/local/python3/bin/supervisorctl reload 
KillMode=process 
Restart=on-failure 
RestartSec=42s
User=root

[Install] 
WantedBy=multi-user.target

或者下方配置, 注意安装地址

代码语言:javascript
代码运行次数:0
运行
复制
[Unit]
Description=Supervisor daemon

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisord.conf
ExecStop=/usr/bin/supervisorctl shutdown
ExecReload=/usr/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
User=root

[Install]
WantedBy=multi-user.target
代码语言:javascript
代码运行次数:0
运行
复制
systemctl start supervisord     // 启动supervisor并加载默认配置文件
systemctl enable supervisord    // 将supervisor加入开机启动项

注意: supervisord.service 中不要添加 # 注释内容, 不知道为什么加了后,会导致 systemctl enable supervisord 报错

验证一下是否为开机启动

代码语言:javascript
代码运行次数:0
运行
复制
systemctl is-enabled supervisord

可以看到 supervisord 运行中

Q&A

补充

代码语言:javascript
代码运行次数:0
运行
复制
unix:///tmp/supervisor.sock no such file

解决:

参考:

1.修改 supervisor 主配置文件

代码语言:javascript
代码运行次数:0
运行
复制
vi /etc/supervisord.conf

把所有的路径 /tmp/ 更改:

/tmp/supervisor.sock 改为 /var/run/supervisor.sock/tmp/supervisord.log 改为 /var/log/supervisor.log/tmp/supervisord.pid 改为 /var/run/supervisor.pid

注意,还有一处

这样就不容易被 Linux 自动清掉

2.修改权限

代码语言:javascript
代码运行次数:0
运行
复制
sudo chmod 777 /var/run
sudo chmod 777 /var/log

如果没改,启动报错 IOError: [Errno 13] Permission denied: '/var/log/supervisord.log'

3.创建 supervisor.sock

代码语言:javascript
代码运行次数:0
运行
复制
sudo touch /var/run/supervisor.sock
sudo chmod 777 /var/run/supervisor.sock

4.重启

代码语言:javascript
代码运行次数:0
运行
复制
supervisorctl stop all
supervisorctl start all

补充:如果如下:

则强制停止,

代码语言:javascript
代码运行次数:0
运行
复制
ps -ef|grep supervisor

supervisor 相关进程杀掉

代码语言:javascript
代码运行次数:0
运行
复制
kill -9 $(ps -ef|grep supervisor | awk '{print $2}')

补充:通过 systemctl 关闭 supervisord

代码语言:javascript
代码运行次数:0
运行
复制
systemctl stop supervisord
systemctl status supervisord

Docker 中运行 Supervisor

参考:

使用像 supervisord . 这是一种中等重量级的方法,需要您 supervisord 在映像中打包及其配置(或基于包含 的映像 supervisord )以及它管理的不同应用程序。然后您开始 supervisord ,它会为您管理您的流程。

这是一个使用这种方法的 Dockerfile 示例,假设预先编写 supervisord.confmy_first_process 、 和 my_second_process 文件都与您的 Dockerfile 存在于同一目录中。

代码语言:javascript
代码运行次数:0
运行
复制
# syntax=docker/dockerfile:1
FROM ubuntu:latest
RUN apt-get update && apt-get install -y supervisor
RUN mkdir -p /var/log/supervisor
COPY supervisord.conf /etc/supervisor/conf.d/supervisord.conf
COPY my_first_process my_first_process
COPY my_second_process my_second_process
CMD ["/usr/bin/supervisord"]

参考

感谢帮助!

本文作者: yiyun

本文链接: https://moeci.com/posts/分类-linux/supervisor-notebook/

版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2021-07-07,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 引言
  • 安装
  • 创建配置文件
  • 运行 Supervisor
    • supervisor.conf 配置文件
    • 子进程配置文件说明
    • 子进程配置示例
  • supervisor命令说明
    • 常用命令
  • supervisorctl 管理客户端
    • 托管服务管理
    • Supervisord 进程管理
  • 注意事项
    • 开机启动项
  • Q&A
  • 补充
    • Docker 中运行 Supervisor
  • 参考
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档