首页 > 数据库 > 数据库开发技术 > 超好用的进程管理工具Supervisord
介绍
Supervisor是Python开发的通用进程管理工具,可以将一个普通的命令行进程变为后台进程,并监控进程状态,在进程异常退出时能自动进行重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,也就是说父进程只有supervisor本身启动的一个进程,其他配置在supervisor内的都属于supervisor 的子服务。当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息,可以选择是否自己启动和报警。只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可实现
supervisor还提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的用户,这个用户就可以管理它对应的进程。

supervisord
它负责启动所管理的进程,并将所管理的进程作为自己的子进程来启动,而且可以在所管理的进程出现崩溃时自动重启。

supervisorctl
是命令行管理工具,可以用来执行 stop、start、restart 等命令,来对这些子进程进行管理。susupervisor以子进程的PID来管理子进程,当子进程异常退出时supervisor收到相应的信号量。

/etc/supervisor/supervisord.conf
[unix_http_server]
file=/tmp/supervisor.sock # socket文件的路径。如果不设置的话,supervisorctl也就不能用,默认为none。
;chmod=0700 # 定义socket文件的权限为0700不设置的话,默认为0700。
;chown=nobody:nogroup # 定义socket文件的属组为user.group,默认为启动supervisord进程的用户及属组。
;username=user # 使用supervisorctl连接的时候,认证的用户默认为用户。
;password=abc # 对应的密码,可以直接使用明码,也可以使用SHA加密如:{SHA}82ab876d1387bfa1dc1c8a2ef074e50c4fd默认不设置
;[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=abc # 同uinx_http_server

[supervisord] # 这个主要是定义supervisord这个服务端进程的一些参数的这个必须设置
logfile=/tmp/supervisord.log # 这个是supervisord这个主进程的日志路径,注意非子进程的日志。默认路径$CWD/supervisord.log,$CWD是当前目录。
logfile_maxbytes=50MB # 上面那个日志文件的最大的大小,当超过50M的时候,会生成一个新的日志文件。当设置为0时,表示不限制文件大小默认值是50M,
logfile_backups=10 #日志文件保持的数量,supervisor在启动程序时,会自动创建10个buckup文件,用于log rotate 当设置为0时,表示不限制文件的数量。默认为10。
loglevel=info # 日志级别,有critical, error, warn, info, debug, trace, or blather等默认为info
pidfile=/tmp/supervisord.pid # pid文件路径。默认为$CWD/supervisord.pid
nodaemon=false # 如果是true,supervisord进程将在前台运行 默认为false,也就是后台运行
minfds=1024 #最少系统空闲的文件描述符,低于这个值supervisor将不会启动。
设置cat/proc/sys/fs/file-max默认情况下为1024。
minprocs=200 # 最小可用的进程描述符,低于这个值supervisor也将不会正常启动。
;umask=022 #进程创建文件的掩码 默认为022
;user=test ; 设置一个非root用户,当我们以root用户启动supervisord之后。我这里面设置的这个用户,也可以对supervisord进行管理默认不设置
;identifier=supervisor #这个参数是supervisord的标识符,主要是给XML_RPC用的。当有多个
supervisor的时候,而且想调用XML_RPC统一管理,就需要为每个supervisor设置不同的标识符了
;directory=/tmp # 当supervisord作为守护进程运行的时候,设置这个参数的话,启动supervisord进程之前,会先切换到这个目录
;nocleanup=true #为false的时候,会在supervisord进程启动的时候,把以前子进程产生的日志文件(路径为AUTO的情况下)清除掉
;environment=KEY="value" #设置环境变量supervisord在linux中启动默认继承了linux的环境变量,在这里可以设置supervisord进程特有的其他环境变量。supervisord启动子进程时,子进程会拷贝父进程的内存空间内容。所以设置的这些环境变量也会被子进程继承。
小例子:environment=name="xx",age="aa"
;childlogdir=/tmp #当子进程日志路径为AUTO的时候,子进程日志文件的存放路径
;strip_ansi=false #这个选项如果设置为true,会清除子进程日志中的所有ANSI 序列。什么是ANSI序列呢?就是我们的 n, t这些东西。默认为false
[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=test #用户名 默认空
;password=123 #密码 默认空
;prompt=mysupervisor #输入用户名密码时候的提示符 默认supervisor
;history_file=~/.sc_history # 这个参数和shell中的history类似,我们可以用上下键来查找前面执行过的命令默认是no file的。。所以我们想要有这种功能,必须指定一个文件
;[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:只有当进程的退出码不在下面的exitcodes里面定义的退出码的时候,才会被自动重启
true:只要子进程挂掉,将会被无条件的重启
;startsecs=1 # 这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启
动成功了
;stopsignal=QUIT # 进程停止信号,可以为TERM, HUP, INT, QUIT, KILL, USR1, or USR2等信号默认为TERM 。。当用设定的信号去干掉进程,退出码会被认为是expected
;startretries=3 #当进程启动失败后,最大尝试启动的次数。。当超过3次后,supervisor将把此进程的状态置为FAIL
;stopwaitsecs=10 # 当我们向子进程发送stopsignal信号后,到系统返回信息 给supervisord,所等待的最大时间。超过这个时间,supervisord会向该子进程发送一个强制kill的信号。
;stopasgroup=false #supervisord管理的子进程,这个子进程本身还有
子进程。那么我们如果仅仅干掉supervisord的子进程的话,子进程的子进程 有可能会变成孤儿进程。所以咱们可以设置此选项,把整个该子进程的
整个进程组都干掉。设置为true的话,一般killasgroup也会被设置为true。
需要注意的是,该选项发送的是stop信号默认为false
;exitcodes=0,2 #注意和上面的的autorestart=unexpected对应。。exitcodes里面的定义的退出码是expected的。
;redirect_stderr=true # 为true的话,stderr的log会并入stdout的log里面默认为false
;environment=A="1",B="2" # 这个是该子进程的环境变量默认为空
;[group:thegroupname] # 给programs分组,划分到组里面的program。我们就不用一个一个去操作了我们可以对组名进行统一的操作。注意:program被划分到组里面之后,就相当于原来的配置从supervisor的配置文件里消失,supervisor只会对组进行管理,而不再会对组里面的单个program进行管理了
;programs=progname1,progname2 # 组成员,用逗号分开这个是个必须的设置项
;priority=999 # 优先级配置,相对于组和组之间;默认999。
;[include] # 把配置信息写到多个文件中,然后include过来;格式为files = relative/directory/*.ini
;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_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。
;stderr_logfile_maxbytes=1MB
;stderr_logfile_backups=10
;stderr_capture_maxbytes=1MB
;stderr_events_enabled=false
;environment=A="1",B="2" #子进程的环境变量
;[eventlistener:theeventlistenername] #suopervisor启动的子进 程,订阅supervisord发送的event。他的名字就叫 listener了。我们可以在listener里面做一系列处理,比如报警等
;command=/bin/eventlistener # 这个和上面的program一样,表示listener的可执行文件的路径
;process_name=%(program_name)s #这个也一样,进程名,当下面的numprocs为多个的时候,才需要。否则默认就 OK了
;startretries=3 #失败最大尝试次数,默认3
;exitcodes=0,2 #期望或者说预料中的进程退出码
;stopsignal=QUIT # 干掉进程的信号,默认为TERM,比如设置为QUIT,那么如果QUIT来干这个进程那么会被认为是正常维护,退出码也被认为是expected中的
;user=test #设置普通用户,可以用来管理该listener进程。默认为空
;numprocs=1 # 相同的listener启动的个数
;events=EVENT # event事件的类型,也就是说,只有写在这个地方的事件类型。才会被发送
;buffer_size=10 #这个是event队列缓存大小,单位不太清楚,楼主猜测应该是个吧。当buffer超过10的时候,最旧的event将会被清除,并把新的event放进去
;priority=-1 # 启动优先级,默认-1
;autorestart=unexpected #是否自动重启,和program一个样,分true,false,unexpected等,注意unexpected和exitcodes的关系
;startsecs=1 # 进程启动后跑了几秒钟,才被认定为成功启动,默认1
测试
[program:test_one]
command=bash /test.sh ; 被监控的进程路径
priority=1 ; 数字越高,优先级越高
numprocs=1 ; 启动几个进程
autostart=true ; 随着supervisord的启动而启动
autorestart=true ; 自动重启
startretries=10 ; 启动失败时的最多重试次数
exitcodes=0 ; 正常退出代码
stopsignal=KILL ; 用来杀死进程的信号
stopwaitsecs=10 ; 发送SIGKILL前的等待时间
redirect_stderr=true ; 重定向stderr到stdout
[program:test_two]
command= bash /test.sh ;被监控的进程路径
priority=1 ; 数字越高,优先级越高
numprocs=1 ; 启动几个进程
autostart=true ; 随着supervisord的启动而启动
autorestart=true ; 自动重启
startretries=10 ; 启动失败时的最多重试次数
exitcodes=0 ; 正常退出代码
stopsignal=KILL ; 用来杀死进程的信号
stopwaitsecs=10 ; 发送SIGKILL前的等待时间
redirect_stderr=true ; 重定向stderr到stdout
配置说明
command:启动程序使用的命令,可以是绝对路径或者相对路径
process_name:一个python字符串表达式,用来表示supervisor进程启动的这个的名称,默认值是%(program_name)s
numprocs:Supervisor启动这个程序的多个实例,如果numprocs>1,则process_name的表达式必须包含%(process_num)s,默认是1
numprocs_start:一个int偏移值,当启动实例的时候用来计算numprocs的值
priority:权重,可以控制程序启动和关闭时的顺序,权重越低:越早启动,越晚关闭。默认值是999
autostart:如果设置为true,当supervisord启动的时候,进程会自动重启。
autorestart:值可以是false、true、unexpected。false:进程不会自动重启,unexpected:当程序退出时的退出码不是exitcodes中定义的时,进程会重启,true:进程会无条件重启当退出的时候。
startsecs:程序启动后等待多长时间后才认为程序启动成功
startretries:supervisord尝试启动一个程序时尝试的次数。默认是3
exitcodes:一个预期的退出返回码,默认是0,2。
stopsignal:当收到stop请求的时候,发送信号给程序,默认是TERM信号,也可以是 HUP, INT, QUIT, KILL, USR1, or USR2。
stopwaitsecs:在操作系统给supervisord发送SIGCHILD信号时等待的时间
stopasgroup:如果设置为true,则会使supervisor发送停止信号到整个进程组
killasgroup:如果设置为true,则在给程序发送SIGKILL信号的时候,会发送到整个进程组,它的子进程也会受到影响。
user:如果supervisord以root运行,则会使用这个设置用户启动子程序
redirect_stderr:如果设置为true,进程则会把标准错误输出到supervisord后台的标准输出文件描述符。
stdout_logfile:把进程的标准输出写入文件中,如果stdout_logfile没有设置或者设置为AUTO,则supervisor会自动选择一个文件位置。
stdout_logfile_maxbytes:标准输出log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
stdout_logfile_backups:标准输出日志轮转备份的数量,默认是10,如果设置为0,则不备份
stdout_capture_maxbytes:当进程处于stderr capture mode模式的时候,写入FIFO队列的最大bytes值,单位可以是KB、MB、GB
stdout_events_enabled:如果设置为true,当进程在写它的stderr到文件描述符的时候,PROCESS_LOG_STDERR事件会被触发
stderr_logfile:把进程的错误日志输出一个文件中,除非redirect_stderr参数被设置为true
stderr_logfile_maxbytes:错误log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
stderr_logfile_backups:错误日志轮转备份的数量,默认是10,如果设置为0,则不备份
stderr_capture_maxbytes:当进程处于stderr capture mode模式的时候,写入FIFO队列的最大bytes值,单位可以是KB、MB、GB
stderr_events_enabled:如果设置为true,当进程在写它的stderr到文件描述符的时候,PROCESS_LOG_STDERR事件会被触发
environment:一个k/v对的list列表
directory:supervisord在生成子进程的时候会切换到该目录
umask:设置进程的umask
serverurl:是否允许子进程和内部的HTTP服务通讯,如果设置为AUTO,supervisor会自动的构造一个url
示例
[program:demotest]
command=python demotest.py 10000 ; 被监控的进程启动命令
directory=/root/ ; 执行前要不要先cd到目录去,一般不用
priority=1 ;数字越高,优先级越高
numprocs=1 ; 启动几个进程
autostart=true ; 随着supervisord的启动而启动
autorestart=true ; 自动重启。。当然要选上了
startretries=10 ; 启动失败时的最多重试次数
exitcodes=0 ; 正常退出代码(是说退出代码是这个时就不再重启了吗?待确定)
stopsignal=KILL ; 用来杀死进程的信号
stopwaitsecs=10 ; 发送SIGKILL前的等待时间
redirect_stderr=true ; 重定向stderr到stdout
常用命令
- 查看supervisorctl支持的命令 supervisorctl help
- 查看当前运行的进程列表 supervisorctl status
- update 更新新的配置到supervisord(不会重启原来已运行的程序)- - reload,载入所有配置文件,并按新的配置启动、管理所有进程(会重启原来已运行的程序)
- start xxx: 启动某个进程restart xxx: 重启某个进程
- stop xxx: 停止某一个进程(xxx),xxx为[program:theprogramname]里配置的值
- stop groupworker: 重启所有属于名为groupworker这个分组的进程(start,restart同理)
- stop all,停止全部进程,注:start、restart、stop都不会载入最新的配置文
- reread,当一个服务由自动启动修改为手动启动时执行一下就ok
有些版本并不支持supervisorctl ,可以通过supervisorctl -c /usr/supervisor/supervisord.conf唤起命令如果supervisorCPU和内存占用率特别高,导致机器卡死。https://github.com/Supervisor/supervisor/issues/581 Unlinking stale socket /tmp/supervisor.sock
解决方案,执行unlink /tmp/supervisor.sock

添加博主
微信号|yfq940-
期待你的
分享
点赞
在看
原文作者:步步运维步步坑;如有侵权,请联系管理员删除。