Supervisor 概述
supervisor 是一个 Client/Server 模式的零碎,容许用户在类 unix 操作系统上监督和管制多个过程,或者能够说是多个程序。supervisor 与 launchd,daemontools,runit 等程序有着雷同的性能,与其中某些程序不同的是,它并不作为“id 为 1 的过程”而代替 init。相同,它用于控制应用程序,像启动其它程序一样,艰深了解就是,把 Supervisor 服务治理的过程程序,它们作为 supervisor 的子过程来运行,而 supervisor 是父过程。supervisor 来监控治理子过程的启动敞开和异样退出后的主动启动。
Supervisor 组成部分
1)supervisord: 服务守护过程
supervisor 服务器的过程名是 supervisord。它次要负责在本人的调用中启动子程序,响应客户端的命令,重新启动解体或退出的过程,记录其子过程 stdout 和 stderr 的输入,以及生成和解决对应于子过程生命周期中的 ”event” 服务器过程应用的配置文件,通常门路寄存在 /etc/supervisord.confa 中。此配置文件是 INI 格局的配置文件。
2) supervisorctl:命令行客户端
supervisor 命令行的客户端名称是 supervisorctl。它为 supervisord 提供了一个相似于 shell 的交互界面。应用 supervisorctl,用户能够查看不同的 supervisord 过程列表,获取管制子过程的状态,如进行和启动子过程
3) Web Server:提供与 supervisorctl 性能相当的 WEB 操作界面
一个能够通过 Web 界面来查看和管制过程的状态,默认监听在 9091 上。
4) XML-RPC Interface:XML-RPC 接口
supervisor 用于管制的 XML-RPC 接口
Supervisor 装置
$ cat /etc/redhat-release
CentOS Linux release 7.5.1804 (Core)
$ rpm -ivh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
# 通过 yum 形式装置 supervisor
$ yum install -y supervisor
# 开机自启动
$ systemctl enable supervisord
# 启动
$ systemctl start supervisord
Supervisor 配置文件阐明
[unix_http_server]
file=/tmp/supervisor.sock ; socket 文件的门路,supervisorctl 用 XML_RPC 和 supervisord 通信就是通过它进行
的。如果不设置的话,supervisorctl 也就不能用了
不设置的话,默认为 none。非必须设置
;chmod=0700 ; 这个简略,就是批改下面的那个 socket 文件的权限为 0700
不设置的话,默认为 0700。非必须设置
;chown=nobody:nogroup ; 这个一样,批改下面的那个 socket 文件的属组为 user.group
不设置的话,默认为启动 supervisord 过程的用户及属组。非必须设置
;username=user ; 应用 supervisorctl 连贯的时候,认证的用户
不设置的话,默认为不须要用户。非必须设置
;password=123 ; 和下面的用户名对应的明码,能够间接应用明码,也能够应用 SHA 加密
如:{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d
默认不设置。。。非必须设置
;[inet_http_server] ; 侦听在 TCP 上的 socket,Web Server 和近程的 supervisorctl 都要用到他
不设置的话,默认为不开启。非必须设置
;port=127.0.0.1:9001 ; 这个是侦听的 IP 和端口,侦听所有 IP 用 :9001 或 *:9001。这个必须设置,只有下面的 [inet_http_server] 开启了,就必须设置它
;username=user ; 这个和下面的 uinx_http_server 一个样。非必须设置
;password=123 ; 这个也一个样。非必须设置
[supervisord] ; 这个次要是定义 supervisord 这个服务端过程的一些参数的
这个必须设置,不设置,supervisor 就不必干活了
logfile=/tmp/supervisord.log ; 这个是 supervisord 这个主过程的日志门路,留神和子过程的日志不搭嘎。默认门路 $CWD/supervisord.log,$CWD 是当前目录。。非必须设置
logfile_maxbytes=50MB ; 这个是下面那个日志文件的最大的大小,当超过 50M 的时候,会生成一个新的日
志文件。当设置为 0 时,示意不限度文件大小
默认值是 50M,非必须设置。logfile_backups=10 ; 日志文件放弃的数量,下面的日志文件大于 50M 时,就会生成一个新文件。文件
数量大于 10 时,最后的老文件被新文件笼罩,文件数量将放弃为 10
当设置为 0 时,示意不限度文件的数量。默认状况下为 10。。。非必须设置
loglevel=info ; 日志级别,有 critical, error, warn, info, debug, trace, or blather 等
默认为 info。。。非必须设置项
pidfile=/tmp/supervisord.pid ; supervisord 的 pid 文件门路。默认为 $CWD/supervisord.pid。。。非必须设置
nodaemon=false ; 如果是 true,supervisord 过程将在前台运行
默认为 false,也就是后盾以守护过程运行。。。非必须设置
minfds=1024 ; 这个是起码零碎闲暇的文件描述符,低于这个值 supervisor 将不会启动。零碎的文件描述符在这里设置 cat /proc/sys/fs/file-max
默认状况下为 1024。。。非必须设置
minprocs=200 ; 最小可用的过程描述符,低于这个值 supervisor 也将不会失常启动。ulimit - u 这个命令,能够查看 linux 上面用户的最大过程数
默认为 200。。。非必须设置
;umask=022 ; 过程创立文件的掩码
默认为 022。。非必须设置项
;user=chrism ; 这个参数能够设置一个非 root 用户,当咱们以 root 用户启动 supervisord 之后。我这外面设置的这个用户,也能够对 supervisord 进行治理
默认状况是不设置。。。非必须设置项
;identifier=supervisor ; 这个参数是 supervisord 的标识符,次要是给 XML_RPC 用的。当你有多个
supervisor 的时候,而且想调用 XML_RPC 对立治理,就须要为每个
supervisor 设置不同的标识符了
默认是 supervisord。。。非必须设置
;directory=/tmp ; 这个参数是当 supervisord 作为守护过程运行的时候,设置这个参数的话,启动
supervisord 过程之前,会先切换到这个目录
默认不设置。。。非必须设置
;nocleanup=true ; 这个参数当为 false 的时候,会在 supervisord 过程启动的时候,把以前子过程
产生的日志文件 (门路为 AUTO 的状况下) 革除掉。有时候咱们想要看历史日志,当
然不想日志被革除了。所以能够设置为 true
默认是 false,有调试需要的同学能够设置为 true。。。非必须设置
;childlogdir=/tmp ; 当子过程日志门路为 AUTO 的时候,子过程日志文件的寄存门路。默认门路是这个货色,执行上面的这个命令看看就 OK 了,解决的货色就默认门路
python -c "import tempfile;print tempfile.gettempdir()"
非必须设置
;environment=KEY="value" ; 这个是用来设置环境变量的,supervisord 在 linux 中启动默认继承了 linux 的
环境变量,在这里能够设置 supervisord 过程特有的其余环境变量。supervisord 启动子过程时,子过程会拷贝父过程的内存空间内容。所以设置的
这些环境变量也会被子过程继承。小例子:environment=name="haha",age="hehe"
默认为不设置。。。非必须设置
;strip_ansi=false ; 这个选项如果设置为 true,会革除子过程日志中的所有 ANSI 序列。什么是 ANSI
序列呢?就是咱们的 \n,\t 这些货色。默认为 false。。。非必须设置
; 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] ; 这个选项是给 XML_RPC 用的,当然你如果想应用 supervisord 或者 web server 这
个选项必须要开启的
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl] ; 这个次要是针对 supervisorctl 的一些配置
serverurl=unix:///tmp/supervisor.sock ; 这个是 supervisorctl 本地连接 supervisord 的时候,本地 UNIX socket
门路,留神这个是和后面的 [unix_http_server] 对应的
默认值就是 unix:///tmp/supervisor.sock。。非必须设置
;serverurl=http://127.0.0.1:9001 ; 这个是 supervisorctl 近程连贯 supervisord 的时候,用到的 TCP socket 门路
留神这个和后面的 [inet_http_server] 对应
默认就是 http://127.0.0.1:9001。。。非必须项
;username=chris ; 用户名
默认空。。非必须设置
;password=123 ; 明码
默认空。。非必须设置
;prompt=mysupervisor ; 输出用户名明码时候的提示符
默认 supervisor。。非必须设置
;history_file=~/.sc_history ; 这个参数和 shell 中的 history 相似,咱们能够用高低键来查找后面执行过的命令
默认是 no file 的。。所以咱们想要有这种性能,必须指定一个文件。。。非
必须设置
; The below sample program section shows all possible program subsection values,
; create one or more 'real' program: sections to be able to control them under
; supervisor.
;[program:theprogramname] ; 这个就是咱们要治理的子过程了,":" 前面的是名字,最好别乱写和理论过程
有点关联最好。这样的 program 咱们能够设置一个或多个,一个 program 就是
要被治理的一个过程
;command=/bin/cat ; 这个就是咱们的要启动过程的命令门路了,能够带参数
例子:/home/test.py -a 'hehe'
有一点须要留神的是,咱们的 command 只能是那种在终端运行的过程,不能是
守护过程。这个想想也晓得了,比如说 command=service httpd start。httpd 这个过程被 linux 的 service 治理了,咱们的 supervisor 再去启动这个命令
这曾经不是严格意义的子过程了。这个是个必须设置的项
;process_name=%(program_name)s ; 这个是过程名,如果咱们上面的 numprocs 参数为 1 的话,就不必管这个参数
了,它默认值 %(program_name)s 也就是下面的那个 program 冒号前面的名字,然而如果 numprocs 为多个的话,那就不能这么干了。想想也晓得,不可能每个
过程都用同一个过程名吧。;numprocs=1 ; 启动过程的数目。当不为 1 时,就是过程池的概念,留神 process_name 的设置
默认为 1。。非必须设置
;directory=/tmp ; 过程运行前,会前切换到这个目录
默认不设置。。。非必须设置
;umask=022 ; 过程掩码,默认 none,非必须
;priority=999 ; 子过程启动敞开优先级,优先级低的,最先启动,敞开的时候最初敞开
默认值为 999。。非必须设置
;autostart=true ; 如果是 true 的话,子过程将在 supervisord 启动后被主动启动
默认就是 true。。非必须设置
;autorestart=unexpected ; 这个是设置子过程挂掉后主动重启的状况,有三个选项,false,unexpected
和 true。如果为 false 的时候,无论什么状况下,都不会被重新启动,如果为 unexpected,只有当过程的退出码不在上面的 exitcodes 外面定义的退
出码的时候,才会被主动重启。当为 true 的时候,只有子过程挂掉,将会被无
条件的重启
;startsecs=1 ; 这个选项是子过程启动多少秒之后,此时状态如果是 running,则咱们认为启
动胜利了
默认值为 1。。非必须设置
;startretries=3 ; 当过程启动失败后,最大尝试启动的次数。。当超过 3 次后,supervisor 将把
此过程的状态置为 FAIL
默认值为 3。。非必须设置
;exitcodes=0,2 ; 留神和下面的的 autorestart=unexpected 对应。。exitcodes 外面的定义的
退出码是 expected 的。;stopsignal=QUIT ; 过程进行信号,能够为 TERM, HUP, INT, QUIT, KILL, USR1, or USR2 等信号
默认为 TERM。。当用设定的信号去干掉过程,退出码会被认为是 expected
非必须设置
;stopwaitsecs=10 ; 这个是当咱们向子过程发送 stopsignal 信号后,到零碎返回信息
给 supervisord,所期待的最大工夫。超过这个工夫,supervisord 会向该
子过程发送一个强制 kill 的信号。默认为 10 秒。。非必须设置
;stopasgroup=false ; 这个货色次要用于,supervisord 治理的子过程,这个子过程自身还有
子过程。那么咱们如果仅仅干掉 supervisord 的子过程的话,子过程的子过程
有可能会变成孤儿过程。所以咱们能够设置可个选项,把整个该子过程的
整个过程组都干掉。设置为 true 的话,个别 killasgroup 也会被设置为 true。须要留神的是,该选项发送的是 stop 信号
默认为 false。。非必须设置。。;killasgroup=false ; 这个和下面的 stopasgroup 相似,不过发送的是 kill 信号
;user=chrism ; 如果 supervisord 是 root 启动,咱们在这里设置这个非 root 用户,能够用来
治理该 program
默认不设置。。。非必须设置项
;redirect_stderr=true ; 如果为 true,则 stderr 的日志会被写入 stdout 日志文件中
默认为 false,非必须设置
;stdout_logfile=/a/path ; 子过程的 stdout 的日志门路,能够指定门路,AUTO,none 等三个选项。设置为 none 的话,将没有日志产生。设置为 AUTO 的话,将随机找一个中央
生成日志文件,而且当 supervisord 重新启动的时候,以前的日志文件会被
清空。当 redirect_stderr=true 的时候,sterr 也会写进这个日志文件
;stdout_logfile_maxbytes=1MB ; 日志文件最大大小,和 [supervisord] 中定义的一样。默认为 50
;stdout_logfile_backups=10 ; 和 [supervisord] 定义的一样。默认 10
;stdout_capture_maxbytes=1MB ; 这个货色是设定 capture 管道的大小,当值不为 0 的时候,子过程能够从 stdout
发送信息,而 supervisor 能够依据信息,发送相应的 event。默认为 0,为 0 的时候表白敞开管道。。。非必须项
;stdout_events_enabled=false ; 当设置为 ture 的时候,当子过程由 stdout 向文件描述符中写日志的时候,将
触发 supervisord 发送 PROCESS_LOG_STDOUT 类型的 event
默认为 false。。。非必须设置
;stderr_logfile=/a/path ; 这个货色是设置 stderr 写的日志门路,当 redirect_stderr=true。这个就不必
设置了,设置了也是白搭。因为它会被写入 stdout_logfile 的同一个文件中
默认为 AUTO,也就是轻易找个地存,supervisord 重启被清空。。非必须设置
;stderr_logfile_maxbytes=1MB ; 这个呈现好几次了,就不反复了
;stderr_logfile_backups=10 ; 这个也是
;stderr_capture_maxbytes=1MB ; 这个一样,和 stdout_capture 一样。默认为 0,敞开状态
;stderr_events_enabled=false ; 这个也是一样,默认为 false
;environment=A="1",B="2" ; 这个是该子过程的环境变量,和别的子过程是不共享的
;serverurl=AUTO ;
; The below sample eventlistener section shows all possible
; eventlistener subsection values, create one or more 'real'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.
;[eventlistener:theeventlistenername] ; 这个货色其实和 program 的位置是一样的,也是 suopervisor 启动的子进
程,不过它干的活是订阅 supervisord 发送的 event。他的名字就叫
listener 了。咱们能够在 listener 外面做一系列解决,比方报警等等
楼主这两天干的活,就是弄的这玩意
;command=/bin/eventlistener ; 这个和下面的 program 一样,示意 listener 的可执行文件的门路
;process_name=%(program_name)s ; 这个也一样,过程名,当上面的 numprocs 为多个的时候,才须要。否则默认就
OK 了
;numprocs=1 ; 雷同的 listener 启动的个数
;events=EVENT ; event 事件的类型,也就是说,只有写在这个中央的事件类型。才会被发送
;buffer_size=10 ; 这个是 event 队列缓存大小,单位不太分明,楼主猜想应该是个吧。当 buffer
超过 10 的时候,最旧的 event 将会被革除,并把新的 event 放进去。默认值为 10。。非必须选项
;directory=/tmp ; 过程执行前,会切换到这个目录下执行
默认为不切换。。。非必须
;umask=022 ; 吞没,默认为 none,不说了
;priority=-1 ; 启动优先级,默认 -1,也不扯了
;autostart=true ; 是否随 supervisord 启动一起启动,默认 true
;autorestart=unexpected ; 是否主动重启,和 program 一个样,分 true,false,unexpected 等,留神
unexpected 和 exitcodes 的关系
;startsecs=1 ; 也是一样,过程启动后跑了几秒钟,才被认定为胜利启动,默认 1
;startretries=3 ; 失败最大尝试次数,默认 3
;exitcodes=0,2 ; 冀望或者说预料中的过程退出码,;stopsignal=QUIT ; 干掉过程的信号,默认为 TERM,比方设置为 QUIT,那么如果 QUIT 来干这个过程
那么会被认为是失常保护,退出码也被认为是 expected 中的
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; send stop signal to the UNIX process group (default false)
;killasgroup=false ; SIGKILL the UNIX process group (def false)
;user=chrism ; 设置普通用户,能够用来治理该 listener 过程。默认为空。。非必须设置
;redirect_stderr=true ; 为 true 的话,stderr 的 log 会并入 stdout 的 log 外面
默认为 false。。。非必须设置
;stdout_logfile=/a/path ; 这个不说了,好几遍了
;stdout_logfile_maxbytes=1MB ; 这个也是
;stdout_logfile_backups=10 ; 这个也是
;stdout_events_enabled=false ; 这个其实是错的,listener 是不能发送 event
;stderr_logfile=/a/path ; 这个也是
;stderr_logfile_maxbytes=1MB ; 这个也是
;stderr_logfile_backups ; 这个不说了
;stderr_events_enabled=false ; 这个也是错的,listener 不能发送 event
;environment=A="1",B="2" ; 这个是该子过程的环境变量
默认为空。。。非必须设置
;serverurl=AUTO ; override serverurl computation (childutils)
; The below sample group section shows all possible group values,
; create one or more 'real' group: sections to create "heterogeneous"
; process groups.
;[group:thegroupname] ; 这个货色就是给 programs 分组,划分到组外面的 program。咱们就不必一个一个去操作了
咱们能够对组名进行对立的操作。留神:program 被划分到组外面之后,就相当于原来
的配置从 supervisor 的配置文件里隐没了。。。supervisor 只会对组进行治理,而不再
会对组外面的单个 program 进行治理了
;programs=progname1,progname2 ; 组成员,用逗号离开
这个是个必须的设置项
;priority=999 ; 优先级,绝对于组和组之间说的
默认 999。。非必须选项
; The [include] section can just contain the "files" setting. This
; setting can list multiple files (separated by whitespace or
; newlines). It can also contain wildcards. The filenames are
; interpreted as relative to this file. Included files *cannot*
; include files themselves.
;[include] ; 这个货色挺有用的,当咱们要治理的过程很多的时候,写在一个文件外面
就有点大了。咱们能够把配置信息写到多个文件中,而后 include 过去
;files = relative/directory/*.ini
supervisor 示例
示例:基于 supervisor 治理 elasticsearch
# cat /etc/supervisord.d/service.ini
[program:elasticsearch]
command=/application/elasticsearch/bin/elasticsearch
; 程序启动命令
user=elastic
; 用哪个用户启动过程,默认是 root
loglevel=info
; 日志的级别
redirect_stderr=true
; 把 stderr 重定向到 stdout,默认 false
stdout_logfile_maxbytes=50MB
; stdout 日志文件大小,默认 50MB
stdout_logfile_backups = 10
; stdout 日志文件备份数,默认是 10
;stdout 日志文件,须要留神当指定目录不存在时无奈失常启动,所以须要手动创立目录(supervisord 会主动创立日志文件)stdout_logfile=/var/log/supervisord/service.log
stderr_logfile=/var/log/supervisord/service.log
startsecs=10
; 启动 10 秒后没有异样退出,就示意过程失常启动了,默认为 1 秒
startretries=60
; 启动失败主动重试次数,默认是 3
redirect_stderr=true
stopasgroup=false
; 默认为 false, 过程被杀死时,是否向这个过程组发送 stop 信号,包含子过程
killasgroup=false
; 默认为 false,向过程组发送 kill 信号,包含子过程
# 加载配置
$ supervisorctl reread
$ supervisorctl update
# 启动 elasticsearch
$ supervisorctl start elasticsearch
# 查看启动状态
$ supervisorctl status elasticsearch
常见的命令如下:
- supervisord 初始启动 Supervisord,启动、治理配置中设置的过程
- supervisorctl stop programxxx 进行某一个过程(programxxx),programxxx 为
- [program:chatdemon]里配置的值,这个示例就是 chatdemon
- supervisorctl start programxxx 启动某个过程
- supervisorctl restart programxxx 重启某个过程
- supervisorctl stop groupworker 重启所有属于名为 groupworker 这个分组的过程(start,restart 同理)
- supervisorctl stop all 进行全副过程,注:start、restart、stop 都不会载入最新的配置文件
- supervisorctl reload 载入最新的配置文件,进行原有过程并按新的配置启动、治理所有过程
- supervisorctl update 依据最新的配置文件,启动新配置或有改变的过程,配置没有改变的过程不会受影响而重启。留神:显示用 stop 进行掉的过程,用 reload 或者 update 都不会主动重启 supervisorctl tail
- programname // 查看 programname 的日志
- supervisorctl tail redis // 查看日志
supervisor 监控治理
为了更不便的远程管理 Supervisor,能够开启其自带的 web 控制台。
# 批改配置文件去掉正文启用
$ vim at /etc/supervisord.conf
[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=123 ; (default is no password (open server))
# 重启 supervisord 服务
$ systemctl restart supervisord
通过浏览器间接拜访即可
点击 “ 浏览原文 ” 获取更好的浏览体验!