supervisor

前言

很久没更新了呢。

supervisor是用Python开发的一套通用的进程管理程序,可以将一个普通的命令行进程变为后台进程并监控

,异常时可以自动拉起。多的就不说了,我一般用来管理后端程序。

安装

可以用包管理工具安装,centos ubuntu都差不多。

我个人比较喜欢使用pip安装。

1
# pip install supervisor

21-12-24修正

21-12-24发现

pip安装的supervisor 并不会自己生成需要的配置文件,需要手动生成配置文件

命令如下

1
2
3
4
5
6
7
8
9
10
11
12
# 使用which 命令找到pip命令的路径
which pip
# 进入目录后可以看到
cd /usr/local/bin/
# 使用echo_supervisord_conf命令生成主配置
/usr/local/bin/echo_supervisord_conf > /etc/supervisord.conf
# 创建子配置存放目录
mkdir -p /etc/supervisord.d
# 修改主配置 配置子配置的存放目录
echo "[include]" >> /etc/supervisord.conf
echo "files = supervisord.d/*.ini" >> /etc/supervisord.conf
# 后面的与下方描述一致

使用

主配置

一般在/etc/supervisord.conf

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
[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结束的配置文件

默认配置基本满足需求

子配置

目录/etc/supervisord.d/

目录一般为空需要自己新建配置

一般放在目录下,后缀.ini 存放目录和后缀等可在主配置修改

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#项目名
[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

贴一个fastapi的例子

fastapi 使用 gunicorn + uvicorn 配置

1
2
3
4
5
6
7
8
9
10
11
[program:lancet]
command=gunicorn run:lancet --workers 4 --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000
# run:lancet -- 启动文件run.py app为lancet
directory=/opt/Lancet
# 运行路径
stdout_logfile=/var/log/supervisor/lancet/xops.log
stderr_logfile=/var/log/supervisor/lancet/err.log
stdout_logfile_maxbytes = 20MB
stdout_errfile_maxbytes = 20MB
autostart=true
autorestart=false

常用命令

1
2
3
4
5
6
supervisorctl status        //查看所有进程的状态
supervisorctl stop es //停止es
supervisorctl start es //启动es
supervisorctl restart //重启es
supervisorctl update //配置文件修改后使用该命令加载新的配置
supervisorctl reload //重新启动配置中的所有程序

运行

启动supervisor supervisord -c /etc/supervisord.conf

错误:unix:///var/run/supervisor.sock no such file就是因为没有启动

包管理工具安装的情况下,可以使用systemctl管理

例子

像上方例子,就可以使用supervisorctl start lancet来管理进程

作者

Rui plus

发布于

2021-12-23

更新于

2021-12-24

许可协议

评论