python之supervisor进程管理工具

supervisor是python写的一个管理进程运行的工具，可以很方便的监听、启动、停止、重启一个或多个进程；有了supervisor后，就不用字节写启动和监听的shell脚本了，非常方便。

supervisor只支持linux系统，并基于python2环境运行，目前python3还没有官方的版本，但没有关系，如果项目是python3环境的，可以同时安装py2和py3两个版本。

安装环境

• 一般linux自带的python2环境是纯洁的，没有setuptools和pip等工具，先安装。

• python安装setuptools

wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py
python2 ez_setup.py --insecure

• python安装pip

wget https://bootstrap.pypa.io/get-pip.py --no-check-certificate
python2 get-pip.py

#更新pip版本
pip2 install --upgrade pip

安装supervisor

pip2 install supervisor

• 源码安装

# 使用root权限
wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz --no-check-certificat

tar -zxvf supervisor-3.1.3.tar.gz
cd supervisor-3.1.3
python setup.py install

# 可以在https://pypi.org/project/supervisor/3.1.3/#history网址选择合适的版本；

• supervisor安装会在linux环境变量中生成三个执行程序：

supervisortd:守护进程服务，用于接收进程管理命令，执行相关的进程操作；重启闪退或异常退出的子进程，把子进程的stderr或stdout记录到日志文件中，但是其不会把print语句输出的值记录到日志中，需要配合logging模块使用。

echo_supervisord_conf: 生成初始配置文件程序,可以指定其路径。

supervisorctl:客户端，和守护进程通信，supervisorctl不仅可以连接到本机上的supervisord，还可以连接到远程的supervisord，在本机上面是通过UNIX socket连接的，远程是通过TCP socket连接的；这样supervisorctl可以同时管理本地和远程的进程。

设置supervisor的配置文件

• 一般将配置文件放置在/etc/supervisor/目录下；

mkdir /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf

• 配置文件的解析

[unix_http_server]
file=/tmp/supervisor.sock   ; socket文件的路径，supervisorctl用XML_RPC和supervisord通信就是通过它进行
                              的。如果不设置的话，supervisorctl也就不能用了
;chmod=0700                 ; 修改上面的那个socket文件的权限为0700
                              默认为0700。 非必须设置
;chown=nobody:nogroup       ; 修改上面socket文件的属组为user.group
                              不设置的话，默认为启动supervisord进程的用户及属组。非必须设置
;username=user              ; 使用supervisorctl连接supervisord的时候，认证的用户
                               不设置的话，默认为不需要用户。 非必须设置
;password=123               ; 和上面的用户名对应的密码，可以直接使用明码，也可以使用SHA加密
                              如：{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d
                              默认不设置,非必须设置

;[inet_http_server]         ; 侦听在TCP上的socket，supervisor的server管理服务和远程的supervisorctl都要用到，
                              不设置的话，默认为不开启网页管理和远程管理，非必须设置
;port=127.0.0.1:9001        ; 这个是侦听的IP和端口，侦听所有IP用 :9001或*:9001。
                              这个必须设置，只要上面的[inet_http_server]开启了，就必须设置它
;username=user              ; 认证的用户
;password=123               ; 密码

[supervisord]                ;这个主要是定义supervisord这个服务端进程的一些参数的，必须设置

logfile=/tmp/supervisord.log ; 这个是supervisord这个主进程的日志路径，注意和子进程的日志无关。
                               默认路径$CWD/supervisord.log，$CWD是当前目录，非必须设置
logfile_maxbytes=50MB        ; 这个是上面那个日志文件的最大的大小，当超过50M的时候，会生成一个新的日
                               志文件。当设置为0时，表示不限制文件大小
                               默认值是50M，非必须设置。
logfile_backups=10           ; 日志文件保持的数量，上面的日志文件大于50M时，就会生成一个新文件。文件
                               数量大于10时，最初的老文件被新文件覆盖，文件数量将保持为10
                               当设置为0时，表示不限制文件的数量。

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，其默认路径就是/var/tmp/supervisor.sock
;serverurl=http://127.0.0.1:9001 ; 这个是supervisorctl远程连接supervisord的时候，用到的TCP socket路径
                                   注意这个和前面的[inet_http_server]对应
                                   默认就是http://127.0.0.1:9001,如果开启这个功能，必须远程的supervisord服务的[inet_http_server]是开启的，否则连接失败；
                                   非必须项

;username=chris              ; 使用supervisorctl时需要认证的用户名
                               默认空。。非必须设置
;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为多个的话，那就不能这么干了；可以使用%(program_num)2d进程名字将其区别开；

;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的时候，只要子进程挂掉，将会被无
                                 条件的重启，也就是说即使使用stop命令停止后也会自动重启进程；默认unexpected
;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   ;
;stderr_events_enabled=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   ;
;stderr_logfile=/a/path        ;
;stderr_logfile_maxbytes=1MB   ;
;stderr_logfile_backups        ;
;stderr_events_enabled=false   ;
;environment=A="1",B="2"       ; 

;serverurl=AUTO                ; 

; 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

• 如果想快速上手使用的话，上述的所有配置全部了解是让人头晕的，下面说说当只有一两个进程需要管理的时候的配置。

快速修改配置

# 修改[unix_http_server]
[unix_http_server]
file=/var/run/supervisor.sock   # /tmp中的文件会被系统删除，所以为了安全，修改该路径。

# 修改[inet_http_server]
[inet_http_server]       # 启动远程管理和界面管理
port=:9001              # 监听端口，绑定ip和端口
username=user           # 远程管理需要的用户
password=123            # 密码

# 修改[supervisord]
[supervisord]
logfile=/var/log/supervisord.log  # 日志路径改为标准的日志路径
pidfile=/var/run/supervisord.pid  # 进程文件路径

# 修改[supervisorctl]
[supervisorctl]
serverurl=unix:///run/supervisor.sock  # 根据[unix_http_server]修改路径

# 修改[program:theprogramname]
[program:test]   # 将注释去掉,为进程命名
command=python  test.py    # 进程的启动命令，可以带参数
process_name=%(program_name)s_%(program_num)2d  # 如果要开多个进程才用到这个参数
numprocs=2                 # 设置进程的个数，1个就不用设置了
directory=/usr/bin         # 执行启动命令前切换到这个目录，如果命令是使用全路径启动的话就不要设置了
stdout_logfile=/var/log/%(program_name)s_out.log  # 设置输出日志
stderr_logfile=/var/log/%(program_name)s_err.log  # 设置错误日志

启动supercisord服务端

• 启动 supervisord 进程，同时我们在配置文件中设置的进程也会相应启动。

# 使用默认的配置文件/etc/supervisord.conf
supervisord
# 明确指定配置文件
supervisord -c /etc/supervisor/supervisord.conf
# 使用 user 用户启动 supervisord
supervisord -u user

supervisorctl相关的管理命令

# 显示当前管理的所有进程
supervisorctl status
# 停止某一个进程，program_name 为 [program:x] 里的 x
supervisorctl stop program_name
# 启动某个进程
supervisorctl start program_name
# 重启某个进程
supervisorctl restart program_name
# 结束所有属于名为 groupworker 这个分组的进程 (start，restart 同理)
supervisorctl stop groupworker:
# 结束 groupworker:name1 这个进程 (start，restart 同理)
supervisorctl stop groupworker:name1
# 停止全部进程，注：start、restart、stop 都不会载入最新的配置文件
supervisorctl stop all
# 载入最新的配置文件，停止原有进程并按新的配置启动、管理所有进程
supervisorctl reload
# 根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启
supervisorctl update

# 显示用 stop 停止掉的进程，用 reload 或者 update 都不会自动重启。

错误提醒

如果按以上命令行操作出现以下error:

Error: .ini file does not include supervisorctl section
For help, use /usr/local/bin/supervisorctl -h 

或者

error: <class 'socket.error'>, [Errno 101] Network is unreachable: file: /usr/lib/python2.7/socket.py line: 571

• 切换到/etc/supervisor目录执行命令行操作，至于原因，楼主暂时不清楚。

浏览器管理进程

• 上述的配置已经开启了浏览器管理功能；

# 在浏览器输入
http://服务器ip:9001

# 输入用户名密码

设置supervisord开机自启动

# 在/etc/init.d/目录建立一个文件
touch Ssupervisord.service

vi Ssupervisord.service

#!/bin/sh
# chkconfig 2345 20 80

supervisord -c /etc/supervisor/supervisord.conf

# 添加到chkconfig管理
chkconfig --add Ssupervisord.service

设置管理多个进程

1. 多个同一类进程

# 比如多个消费者，需要启动多个相同的文件
# 修改[program:theprogramname]
process_name=%(program_name)s_%(program_num)2d  # 如果要开多个进程才用到这个参数
numprocs=2  # 设置进程数

1. 多个不同进程使用组管理

# 先配置多个[program:theprogramname]
[program:programname1]
xxxx
[program:programname2]
xxxx

[group:thegroupname]
programs=programname1,programname2
priority=999

可以通过管理thegroupnam来同时管理programname1,programname2

设置多个配置文件

• 如果需要管理的进程文件非常多，一个配置文件就会显得非常的凌乱，可以使用多个配置文件。

[include]
files = /etc/supervisor/supervisord.d/*.ini  # 创建一个新的文件夹，将每个进程单独写成一个配置文件，如果要包含多个不同路径的文件，用空格隔开

# 每个配置文件的内容
[program:programname1]
xxxx

• 例如配置一个redis的进程文件

[program:redis_6390]
command=/usr/local/bin/redis-server /etc/redis/6390.conf
stdout_logfile=/var/log/redis_6390_out.log
stderr_logfile=/var/log/redis-6390_err.log
priority=300

• 参考：

• https://www.cnblogs.com/zhaoding/p/6257363.html

• http://python.jobbole.com/86423/

• http://blog.csdn.net/hujunqi/article/details/53670364