supervisor 简单使用

1,什么是supervisor?

supervisor 是由python语言编写、基于linux操作系统的一款服务器管理工具，用以监控服务器的运行，发现问题能立即自动预警及自动重启等功能。

supervisor是一个c/s系统，被用来在类Unix系统中监控进程状态。supervisor使用python开发。 服务端进程为supervisord，主要负责启动自身及其监控的子进程，响应客户端命令，重启异常退出的子进程，记录子进程stdout和stderr输出，生成和处理子进程生命周期中的事件。其配置文件一般为/etc/supervisord.conf，可以在配置文件中配置相关参数，包括supervisord自身的状态，其管理的各个子进程的相关属性等。supervisor的客户端为supervisorctl，它提供了一个类shell的接口（即命令行）来操作supervisord服务端。通过supervisorctl，可以连接到supervisord服务进程，获得服务进程监控的子进程状态，启动和停止子进程，获得正在运行的进程列表。客户端通过Unix域套接字或者TCP套接字与服务进程进行通信，服务器端具有身份凭证认证机制，可以有效提升安全性。当客户端和服务端位于同一台机器上时，客户端与服务器共用同一个配置文件/etc/supervisord.conf，通过不同标签来区分两者的配置。supervisor也提供了一个web页面来查看和管理进程状态。

2. 安装supervisor

yum install supervisor 

其他系统可以自行百度

3.配置

1.生成配置文件

echo_supervisord_conf > /etc/supervisord.conf

2.启动

supervisord -c /etc/supervisord.conf

如果启动报错 —>Unlinking stale socket /usr/local/var/run/supervisor.sock
终端输入 unlink socket /usr/local/var/run/supervisor.sock 就可以了

3.配置

进入配置文件

vim /etc/supervisord.conf

在配置文件底部，配置include （将前面的；去掉）

[include]
files=/etc/supervisor.d/*.conf #若你本地无/etc/supervisor.d目录，请自建

编辑配置文件

cd /etc/supervisor.d
vim ossfs.conf # 这里的文件名称自定义

; 设置进程的名称，使用 supervisorctl 来管理进程时需要使用该进程名
[program:your_program_name] 
command=python server.py --port=9000
;numprocs=1                 ; 默认为1
;process_name=%(program_name)s   ; 默认为 %(program_name)s，即 [program:x] 中的 x
directory=/home/python/tornado_server ; 执行 command 之前，先切换到工作目录
user=oxygen                 ; 使用 oxygen 用户来启动该进程
; 程序崩溃时自动重启，重启次数是有限制的，默认为3次
autorestart=true            
redirect_stderr=true        ; 重定向输出的日志
stdout_logfile = /var/log/supervisord/tornado_server.log
loglevel=info

更改了supervisor配置文件，需要重启,运行以下指令

supervisorctl reload

4.supervisorctl的用法

supervisord : 启动supervisor
supervisorctl reload :修改完配置文件后重新启动supervisor
supervisorctl status :查看supervisor监管的进程状态
supervisorctl start 进程名 ：启动XXX进程
supervisorctl stop 进程名 ：停止XXX进程
supervisorctl stop all：停止全部进程，注：start、restart、stop都不会载入最新的配置文件。
supervisorctl update：根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启

5.supervisord.conf 里面的配置详解

;[inet_http_server] ;侦听在TCP上的socket，Web Server和远程的supervisorctl都要用到它，如果不设置，默认为不开启。非必须设置项

;port=127.0.0.1:9001 ;侦听的IP和端口，侦听9001端口的所有IP":9001或*:9001"

[inet_http_server]

port=*:9001

2.浏览器访问：http://localhost:9001

用户名：user

密码：123（配置文件里默认用户名和密码）




supervisor配置文件详解
[unix_http_server]

file=/tmp/supervisor.sock

; socket文件的路径，supervisorctl基于它通过XML_RPC和supervisord通信。如果不设置，

则supervisorctl不能用，默认为none。可修改该文件的路径，例如/var/run/supervisor.sock，非必须设置项

;chmod=0700

; 上述socket文件的权限值，如果不设置，默认为0700。非必须设置项

;chown=nobody:nogroup

; 上述socket文件所属的用户：组，如果不设置，默认为启动supervisord进程的用户及属组。非必须设置项

;username=user

; supervisorctl连接时，认证的用户名，如果不设置，默认不需要认证。非必须设置项

;password=123

; 上述认证用户名对应的密码，可以直接使用明码，也可以使用SHA加密，

如：{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d

默认不需要设置，与上述username成对出现。非必须设置项

;[inet_http_server]

; 侦听在TCP上的socket，Web Server和远程的supervisorctl都要用到它，如果不设置，默认为不开启。非必须设置项

;port=127.0.0.1:9001

; 侦听的IP和端口，侦听9001端口的所有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

; 日志文件保留备份的数量，supervisor在启动程序时，会自动创建10个buckup文件，用于log rotate，当设置为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将不会启动。系统的文件描述符在/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。当有多个supervisor的时候，而且想调用XML_RPC统一管理，就需要为每个

supervisor设置不同的标识符了，默认是supervisord。非必需设置项

;directory=/tmp

; 如果设置该参数，则当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="hello",age="18"，默认为不设置。非必须设置项

;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

; 该参数为本地UNIX socket路径，当supervisorctl本地连接supervisord时需用到，这个是和前面的[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类似，上下键查看执行过的历史命令，默认是没有指定文件存储的。如需该功能，须指定一个文件。非必须设置项

; 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/hello.py 8080

需要注意的是，command只能是那种在终端运行的进程，不能是守护进程。比如说command=service httpd start，httpd是守护进程，

它已经被linux的service(CentOS7是systemctl)管理了，如果再去用supervisor启动该进程，那么它已经不是严格意义上的子进程了。

必须设置项

;process_name=%(program_name)s

; 进程名，如果下面的numprocs参数为1，则不用管该参数，它默认值为%(program_name)s，即program冒号后的theprogramname，

但如果numprocs>1，就需要为每个进程取个名字了，否则每个进程都用同一个进程名。

;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。当用设定的信号去kill进程，退出码会被认为是expected。非必须设置项

;stopwaitsecs=10

; 当向子进程发送stopsignal信号后，到系统返回信息给supervisord所等待的最大时间。超过该时间，supervisord会向该

子进程发送一个强制kill的信号，默认为10秒。非必须设置项

;stopasgroup=false

; 用于supervisord管理的子进程，该子进程本身还有

子进程的情况。如果仅仅kill掉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文件最大大小

;stderr_logfile_backups=10

; 设置stderr文件的备份副本个数

;stderr_capture_maxbytes=1MB

; 与stdout_capture一样。默认为0，关闭状态。

;stderr_events_enabled=false

; 与stdout_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>1时，才需要设置。否则就用默认值

;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

; unexpected中的进程退出码

;stopsignal=QUIT

; kill进程的信号，默认为TERM，比如设置为QUIT，那么如果QUIT来kill该进程，那么会被认为是正常维护，退出码也被认为是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

; 可以指定一个或多个以.ini或.conf为后缀的配置文件

include示例：

[include]

files = /opt/absolute/filename.ini /opt/absolute/*.ini foo.conf config??.ini