如何通过supervisor高效实现后台管理进程的自动化管理？

本文共计2861个文字，预计阅读时间需要12分钟。

伪原创可以改写为：- 虚拟原创- 模拟创新- 假原创- 仿原创- 非原创

##介绍

supervisor一款使用python开发，基于linux系统的进程管理工具，可以监控进程的状态，并且管理进程，比如启动，关闭，重载，后台启动等；同时支持自动重试。

##角色：

服务端：supervisord

客户端：supervisorctl

supervisor可配置项看着挺多，但是实际使用的不多

##服务端配置文件：

##默认配置supervisord.conf

[unix_/var/run/supervisor.sock

[include]
files = /etc/supervisor/conf.d/*.conf

##配置参数详解

[unix_/tmp/supervisor.sock ; 这个是supervisorctl本地连接supervisord的时候，本地UNIX socket
路径，注意这个是和前面的[unix_/tmp/supervisor.sock。。非必须设置
;serverurl=127.0.0.1:9001 ; 这个是supervisorctl远程连接supervisord的时候，用到的TCP socket路径
注意这个和前面的[inet_127.0.0.1:9001。。。非必须项

;username=chris ; 用户名
默认空。。非必须设置
;password=123 ; 密码
默认空。。非必须设置
;prompt=mysupervisor ; 输入用户名密码时候的提示符
默认supervisor。。非必须设置
;history_file=~/.sc_history ; 这个参数和shell中的history类似，我们可以用上下键来查找前面执行过的命令
默认是no file的。。所以我们想要有这种功能，必须指定一个文件。。。非
必须设置

;[include] ;当我们要管理的进程很多的时候，写在一个文件里面
就有点大了,可以把配置信息写到多个文件中，然后include过来
;files = relative/directory/*.ini

##创建子进程的配置参数

##示例

##cat /etc/supervisor/conf.d/celery_worker.conf

[program:celery_worker]
command=/usr/local/bin/celery -A common.celery_task worker --pidfile=/var/run/celery/celery.pid --logfile=/var/log/celery/celery.log --loglevel=INFO --time-limit=300 --concurrency=1
numprocs=1
directory=/data/blog
autostart=true
autorestart=true
startsecs=30
startretries=3
exitcodes=0,1
stopsignal=QUIT
stopwaitsecs=10
user=root
redirect_stderr=true
stdout_logfile=/var/log/celery/supervisor_celery_worker.log
stdout_logfile_maxbytes=64MB
stdout_logfile_backups=4
stdout_capture_maxbytes=1MB
stdout_events_enabled=false
# 子进程无法读取系统环境变量，子进程中需要使用环境变量，可在此配置
environment=CELERY_REDIS_PASSWORD='xxxxx',EMAIL_SECRET_KEY='xxxxx',……

##program

;[program:theprogramname] ;这个就是咱们要管理的子进程了，":"后面的名字是进程名

;command=/bin/cat ; 这个就是我们的要启动进程的命令路径了，可以带参数
例子：/home/test.py -a 'hehe'
有一点需要注意的是，我们的command只能是那种在终端运行的进程，不能是
守护进程。
必须设置的项

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

##listener

;[eventlistener:theeventlistenername] ;这个东西其实和program的地位是一样的，也是suopervisor启动的子进
程，不过它干的活是订阅supervisord发送的event。他的名字就叫
listener了。我们可以在listener里面做一系列处理，比如报警等等

;command=/bin/eventlistener ; 这个和上面的program一样，表示listener的可执行文件的路径
;process_name=%(program_name)s ; 这个也一样，进程名，当下面的numprocs为多个的时候，才需要。否则默认
;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)

##group

;[group:thegroupname] ;这个东西就是给programs分组，划分到组里面的program。我们就不用一个一个去操作了
我们可以对组名进行统一的操作。 注意：program被划分到组里面之后，就相当于原来
的配置从supervisor的配置文件里消失了。。。supervisor只会对组进行管理，而不再
会对组里面的单个program进行管理了

;programs=progname1,progname2 ; 组成员，用逗号分开
这个是个必须的设置项
;priority=999 ; 优先级，相对于组和组之间说的
默认999。。非必须选项

##supervisord服务启动

supervisord -c /etc/supervisor/supervisor.conf

linux上也可以使用service或者systemctl来启动supervisor服务端

##supervisorctl客户端管理命令

supervisorctl update: 配置文件更改，或者增加删除配置文件后，不重启更新在线配置，读取硬盘上的配置，并重启变更配置的进程
supervisorctl reread: 只更新配置，不会重启进程，所以实际并未使用新配置 (start只重启进程，不更新配置，实际并未使用新配置)
supervisorctl reload: 重载，注意该命令会是supervisord服务端进程也进行重启；即重新启动配置中的所有程序，并且会重启spervisord服务，尽量不使用
supervisorctl stop/start/restart "子进程名" 停止/启动/重启
supervisorctl stop/start/restart all 停止/启动/重启 所有子进程，不带all，并且不指定子进程名，也是操作所有子进程
supervisorctl status 查看子进程运行状态
uptime：表示正常运行，并且运行了xxx时间
fail：启动失败
starting：正在启动中

##子进程的环境变量配置问题

supervisord在linux中启动默认继承了linux的环境变量，supervisord启动子进程时，子进程会拷贝父进程的内存空间内容。
但是子进程在实际使用的过程中，时常读取不到系统的环境变量，因此需要在子进程配置文件中配置environment环境变量