supervisor, supervisorctl

常用命令

1
2
3
4
5

supervisorctl status
supervisorctl stop service0
supervisorctl stop all
supervisorctl start all
supervisorctl restart all

supervisor 配置文件

/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

[program:program_0]
#程序的启动目录
directory = /home/user_0/projects/
# 启动命令, 跟命令行启动的命令是一样的
command = python foo.py
# 在 supervisord 启动的时候也自动启动
autostart = true
# 启动 5 秒后没有异常退出, 就当作已经正常启动了, 这个选项是子进程启动多少秒之后，此时状态如果是running，则我们认为启  动成功了
# number of secs prog must stay running (def. 10)
# 进程持续运行多久才认为是启动成功
startsecs = 5
# 这个是当我们向子进程发送 stopsignal 信号后，到系统返回信息给 supervisord，所等待的最大时间。 超过这个时间，supervisord 会向该 子进程发送一个强制 kill的信号。 默认为10秒。。非必须设置
stopwaitsecs=10               ; 
autorestart = true ; 程序异常退出后自动重启
  
startretries = 3 ; 启动失败自动重试次数,默认是 3
  
user = leon ; 用哪个用户启动
  
redirect_stderr = true ; 把 stderr 重定向到 stdout,默认 false
  
stdout_logfile_maxbytes = 20MB ; stdout 日志文件大小,默认 50MB
  
stdout_logfile_backups = 20 ; stdout 日志文件备份数
  
; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录 (supervisord 会自动创建日志文件)
  
stdout_logfile = /data/logs/usercenter_stdout.log

使用 supervisor 管理进程

Supervisor (http://supervisord.org) 是一个用 Python 写的进程管理工具,可以很方便的用来启动、重启、关闭进程 (不仅仅是 Python 进程) 。除了对单个进程的控制,还可以同时启动、关闭多个进程,比如很不幸的服务器出问题导致所有应用程序都被杀死,此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。

安装

Supervisor 可以运行在 Linux、Mac OS X 上。如前所述,supervisor 是 Python 编写的,所以安装起来也很方便,可以直接用 pip :

sudo pip install supervisor

如果是 Ubuntu 系统,还可以使用 apt-get 安装。

supervisord 配置

Supervisor 相当强大,提供了很丰富的功能,不过我们可能只需要用到其中一小部分。安装完成之后,可以编写配置文件,来满足自己的需求。为了方便,我们把配置分成两部分: supervisord (supervisor 是一个 C/S 模型的程序,这是 server 端,对应的有 client 端: supervisorctl) 和应用程序 (即我们要管理的程序) 。

首先来看 supervisord 的配置文件。安装完 supervisor 之后,可以运行echo_supervisord_conf 命令输出默认的配置项,也可以重定向到一个配置文件里:

echo_supervisord_conf > /etc/supervisord.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 管理界面

;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

logfile_backups=10 ; 日志文件保留备份数量默认 10

loglevel=info ; 日志级别,默认 info,其它: debug,warn,trace

pidfile=/tmp/supervisord.pid ; pid 文件

nodaemon=false ; 是否在前台启动,默认是 false,即以 daemon 的方式启动

minfds=1024 ; 可以打开的文件描述符的最小值,默认 1024

minprocs=200 ; 可以打开的进程数的最小值,默认 200

; the below section must remain in the config file for RPC

; (supervisorctl/web interface) to work, additional interfaces may be

; added by defining them in separate rpcinterface: sections

[rpcinterface:supervisor]

supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[supervisorctl]

serverurl=unix:///tmp/supervisor.sock ; 通过 UNIX socket 连接 supervisord,路径与 unix_http_server 部分的 file 一致

;serverurl=http://127.0.0.1:9001 ; 通过 HTTP 的方式连接 supervisord

; 包含其他的配置文件

[include]

files = relative/directory/_.ini ; 可以是 *.conf 或 *.ini

我们把上面这部分配置保存到 /etc/supervisord.conf (或其他任意有权限访问的文件) ,然后启动 supervisord (通过 -c 选项指定配置文件路径,如果不指定会按照这个顺序查找配置文件: $CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf) :

supervisord -c /etc/supervisord.conf

查看 supervisord 是否在运行:

ps aux | grep supervisord

program 配置

上面我们已经把 supervisrod 运行起来了,现在可以添加我们要管理的进程的配置文件。可以把所有配置项都写到 supervisord.conf 文件里,但并不推荐这样做,而是通过 include 的方式把不同的程序 (组) 写到不同的配置文件里。

为了举例,我们新建一个目录 /etc/supervisor/ 用于存放这些配置文件,相应的,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:

[include]

files = /etc/supervisor/_.conf

假设有个用 Python 和 Flask 框架编写的用户中心系统, 取名 usercenter,用 gunicorn (http://gunicorn.org/) 做 web 服务器。项目代码位于 /home/leon/projects/usercenter, gunicorn 配置文件为 gunicorn.py, WSGI callable 是 wsgi.py 里的 app 属性。所以直接在命令行启动的方式可能是这样的:

cd /home/leon/projects/usercenter

gunicorn -c gunicorn.py wsgi:app

现在编写一份配置文件来管理这个进程 (需要注意: 用 supervisord 管理时,gunicorn 的 daemon 选项需要设置为 False) :

; 可以通过 environment 来添加需要的环境变量,一种常见的用法是修改 PYTHONPATH

; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

一份配置文件至少需要一个 [program:x] 部分的配置,来告诉 supervisord 需要管理那个进程。[program:x] 语法中的 x 表示 program name,会在客户端 (supervisorctl 或 web 界面) 显示,在 supervisorctl 中通过这个值来对程序进行 start、restart、stop 等操作。

使用 supervisorctl

Supervisorctl 是 supervisord 的一个命令行客户端工具,启动时需要指定与 supervisord 使用同一份配置文件,否则与 supervisord 一样按照顺序查找配置文件。

supervisorctl -c /etc/supervisord.conf

上面这个命令会进入 supervisorctl 的 shell 界面,然后可以执行不同的命令了:

status # 查看程序状态

stop usercenter # 关闭 usercenter 程序

start usercenter # 启动 usercenter 程序

restart usercenter # 重启 usercenter 程序

reread ＃ 读取有更新 (增加) 的配置文件,不会启动新添加的程序

update ＃ 重启配置文件修改过的程序

上面这些命令都有相应的输出,除了进入 supervisorctl 的 shell 界面,也可以直接在 bash 终端运行:

supervisorctl stop usercenter
supervisorctl start usercenter
supervisorctl restart usercenter
supervisorctl reread
supervisorctl update

其它

除了 supervisorctl 之外,还可以配置 supervisrod 启动 web 管理界面,这个 web 后台使用 Basic Auth 的方式进行身份认证。

除了单个进程的控制,还可以配置 group,进行分组管理。

经常查看日志文件,包括 supervisord 的日志和各个 pragram 的日志文件,程序 crash 或抛出异常的信息一半会输出到 stderr,可以查看相应的日志文件来查找问题。

Supervisor 有很丰富的功能,还有其他很多项配置,可以在官方文档获取更多信息: http://supervisord.org/index.html

http://liyangliang.me/posts/2015/06/using-supervisor/

supervisor

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

注：本文以centos7为例，supervisor版本3.4.0。

二、supervisor安装 配置好yum源后，可以直接安装

yum install supervisor Debian/Ubuntu可通过apt安装

apt-get install supervisor pip安装

pip install supervisor easy_install安装

easy_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管理界面 ;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/supervisor.d/目录下，以.ini作为扩展名 (每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起）。如任意定义一个和脚本相关的项目名称的选项组 (/etc/supervisord.d/test.conf）：

项目名

[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: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 = test

五、supervisor命令说明 常用命令 supervisorctl status //查看所有进程的状态 supervisorctl stop es //停止es supervisorctl start es //启动es supervisorctl restart //重启es supervisorctl update //配置文件修改后使用该命令加载新的配置 supervisorctl reload //重新启动配置中的所有程序 注：把es换成all可以管理配置中的所有进程。直接输入supervisorctl进入supervisorctl的shell交互界面，此时上面的命令不带supervisorctl可直接使用。

注意事项 使用supervisor进程管理命令之前先启动supervisord，否则程序报错。 使用命令supervisord -c /etc/supervisord.conf启动。 若是centos7：

systemctl start supervisord.service //启动supervisor并加载默认配置文件 systemctl enable supervisord.service //将supervisor加入开机启动项 常见问题 unix:///var/run/supervisor.sock no such file 问题描述：安装好supervisor没有开启服务直接使用supervisorctl报的错 解决办法：supervisord -c /etc/supervisord.conf

command中指定的进程已经起来，但supervisor还不断重启 问题描述：command中启动方式为后台启动，导致识别不到pid，然后不断重启，这里使用的是elasticsearch，command指定的是$path/bin/elasticsearch -d 解决办法：supervisor无法检测后台启动进程的pid，而supervisor本身就是后台启动守护进程，因此不用担心这个

启动了多个supervisord服务，导致无法正常关闭服务 问题描述：在运行supervisord -c /etc/supervisord.conf之前，直接运行过supervisord -c /etc/supervisord.d/xx.conf导致有些进程被多个superviord管理，无法正常关闭进程。 解决办法：使用ps -fe | grep supervisord查看所有启动过的supervisord服务，kill相关的进程。

更多信息请移步Supervisor官网：http://supervisord.org 参考文章： 1.进程管理supervisor的简单说明 - jyzhou -博客园 2.supervisor 使用详解 - 11111 - CSDN博客

作者：风吹我已散博客 链接：https://www.jianshu.com/p/0b9054b33db3 来源：简书 著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

https://www.huweihuang.com/article/linux/supervisor-usage/