2019-01-05supervisor实现守护进程

今天在学习的时候,涉及到了队列监听的问题,然后老师介绍了一个工具。以为是什么常见的东西,百度了下发现真是个好东西。


 项目中遇到有些脚本需要通过后台进程运行,保证不被异常中断,之前都是通过nohup、&、screen来实现,带着能否做一个start/stop/restart/reload的服务启动的想法找到里Supervisor。关于supervisor的介绍在网上大致搜索总结如下:

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

1:easy_install 安装:

easy_install supervisor2:pip 安装:

pip install supervisor3:Debian / Ubuntu可以直接通过apt安装:

apt-get install supervisor

2,配置文件

1)通过apt-get install安装后,supervisor的配置文件在:

/etc/supervisor/supervisord.conf 

supervisor的配置文件默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足。而其管理的子进程配置文件在:

/etc/supervisor/conf.d/*.conf

然后,开始给自己需要的脚本程序编写一个子进程配置文件,让supervisor来管理它,放在/etc/supervisor/conf.d/目录下,以.conf作为扩展名(每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起)。如任意定义一个和脚本相关的项目名称的选项组(/etc/supervisor/conf.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

#日志输出

stderr_logfile=/tmp/blog_stderr.log

stdout_logfile=/tmp/blog_stdout.log

#脚本运行的用户身份

user = zhoujy

#把 stderr 重定向到 stdout,默认 false

redirect_stderr = true

#stdout 日志文件大小,默认 50MB

stdout_logfile_maxbytes = 20M

#stdout 日志文件备份数

stdout_logfile_backups = 20

[program:zhoujy] #说明同上

directory=/opt/bin

command=/usr/bin/python /opt/bin/zhoujy.py

autostart=true

autorestart=false

stderr_logfile=/tmp/zhoujy_stderr.log

stdout_logfile=/tmp/zhoujy_stdout.log

#user = zhoujy

通过easy_install安装后,配置文件不存在,需要自己导入。

①:运行echo_supervisord_conf打印出一个配置文件的样本,样本说明可以看supervisor(一)基础篇的详细说明,要是设置样本为一个配置文件则:

1:运行 echo_supervisord_conf,查看配置样本:

echo_supervisord_conf2:创建配置文件:

echo_supervisord_conf > /etc/supervisord.conf

②:配置子进程配置文件,可以直接在supervisor中的;[program:theprogramname]里设置。

详细的子进程配置文件:

样本:

;[program:theprogramname]

;command=/bin/cat              ; the program (relative uses PATH, can take args)

;process_name=%(program_name)s ; process_name expr (default %(program_name)s)

;numprocs=1                    ; number of processes copies to start (def 1)

;directory=/tmp                ; directory to cwd to before exec (def no cwd)

;umask=022                    ; umask for process (default None)

;priority=999                  ; the relative start priority (default 999)

;autostart=true                ; start at supervisord start (default: true)

;startsecs=1                  ; # of secs prog must stay up to be running (def. 1)

;startretries=3                ; max # of serial start failures when starting (default 3)

;autorestart=unexpected        ; when to restart if exited after running (def: unexpected)

;exitcodes=0,2                ; 'expected' exit codes used with autorestart (default 0,2)

;stopsignal=QUIT              ; signal used to kill process (default TERM)

;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                  ; setuid to this UNIX account to run the program

;redirect_stderr=true          ; redirect proc stderr to stdout (default false)

;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO

;stdout_logfile_maxbytes=1MB  ; max # logfile bytes b4 rotation (default 50MB)

;stdout_logfile_backups=10    ; # of stdout logfile backups (default 10)

;stdout_capture_maxbytes=1MB  ; number of bytes in 'capturemode' (default 0)

;stdout_events_enabled=false  ; emit events on stdout writes (default false)

;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO

;stderr_logfile_maxbytes=1MB  ; max # logfile bytes b4 rotation (default 50MB)

;stderr_logfile_backups=10    ; # of stderr logfile backups (default 10)

;stderr_capture_maxbytes=1MB  ; number of bytes in 'capturemode' (default 0)

;stderr_events_enabled=false  ; emit events on stderr writes (default false)

;environment=A="1",B="2"      ; process environment additions (def no adds)

;serverurl=AUTO                ; override serverurl computation (childutils)

说明:

;[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             

改成自己实际的配置文件:和①上面一样。

3:运行

1)apt-get install 安装的supervisor直接可以通过/etc/init.d/supervisor 运行:

/etc/init.d/supervisor start

2)通过easy_install 安装的supervisor运行supervisord 运行:

supervisord

4:web界面操作

需要在supervisor的配置文件里添加[inet_http_server]选项组:之后可以通过http://10.211.55.11:9001来访问控制子线程的管理。

[inet_http_server]

port=10.211.55.11:9001username=user

password=123

效果:

5:子进程管理(supervisorctl)

1) 查看所有子进程的状态:

#supervisorctlstatusblog                            RUNNING    pid2395,uptime0:08:41zhoujy                          RUNNING    pid 2396,uptime0:08:41

2)关闭、开启指定的子进程:

#supervisorctlstopzhoujyzhoujy: stopped#supervisorctlstartzhoujyzhoujy: started

3)关闭、开启所有的子进程:

#supervisorctlstop allblog: stoppedzhoujy: stopped#supervisorctlstart allblog: startedzhoujy: started

4):其他参数:supervisor开启后子进程自动开启(autostart=true)和子进程退出后自动启动(autorestart=ture

更多的参数可以看官方文档supervisor(一)基础篇的说明。

总结:

 我们需要的功能在上面介绍的supervisor的基本功能中已经实现,supervisor还有其他的一些功能:如进程组、web页面管理子进程、监控子线程情况等等,更多的信息可以去官网上查看。

参考文档:

Supervisor官方文档

Supervisor(一)基础篇

Supervisor(二)event

Supervisor(三)xml_rpc

   ;这个东西不错,回头再用到的时候要好好再对照这个文章来练习一下。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342

推荐阅读更多精彩内容