04月18, 2018

进程管理器Supervisor的配置使用(CentOS7)

Supervisor(官网:http://supervisord.org)是一个Python语言写的一个允许用户监控和控制类UNIX系统中的进程并且提供WEB接口给用户查询和控制的C/S架构的进程管理系统, Supervisor的功能与launchd, daemontools和runit相同, 但与它们不一样的是, Supervisor不是作为init(进程号pid是1)运行,它可以用来管理和控制(非daemon)进程,并且它在启动的时候和一般程序并无差别,本文主要记录Supervisor的配置和使用。

1、安装PIP

本教程使用PIP安装Supervisor,所以先安装PIP:

cd ~ && wget https://bootstrap.pypa.io/get-pip.py -O - | python

2、安装Supervisor

安装详情,可参考官方介绍:Supervisor Installing ,使用PIP安装:

pip install supervisor

Supervisor组件介绍:

- 1、Supervisord
介绍:Supervisord是Supervisor的服务端程序。
功能:启动Supervisor程序自身,启动Supervisor管理的子进程,响应来自clients的请求,重启闪退或异常退出的子进程,把子进程的stderr或stdout记录到日志文件中,生成和处理Event。

- 2、Supervisorctl
介绍:Supervisorctl是Supervisor的客户端程序。
功能:Supervisorctl有一个类型shell的命令行界面,我们可以利用它来查看子进程状态,启动/停止/重启子进程,获取running子进程的列表等操作,Supervisorctl不仅可以连接到本机上的Supervisord,还可以通过TCP socket连接到远程的Supervisord,Supervisorctl和Supervisord之间的通信,是通过XML-RPC完成的。

3、生成配置文件

echo_supervisord_conf > /etc/supervisord.conf

配置文件详解:

; ;是用来注释的

[unix_http_server]
file=/tmp/supervisor.sock   ; UNIX socket文件,Supervisorctl用XML_RPC和Supervisord通信时会用到【非必须】
;chmod=0700                 ; socket文件的mode,默认是0700【非必须】
;chown=nobody:nogroup       ; socket文件的owner,格式:uid:gid【非必须】
;username=user              ; 使用Supervisorctl管理时认证所需的用户名【非必须】
;password=123               ; 使用Supervisorctl管理时认证所需的密码【非必须】

;[inet_http_server]         ; HTTP服务器,提供Web管理界面【非必须】,若想要使用Web管理,【必须】
;port=127.0.0.1:9001        ; Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性,【非必须】,若想要使用Web管理,【必须】
;username=user              ; 登录Web管理后台的用户名【非必须】,若想要使用Web管理,为提高安全性,【必须】
;password=123               ; 登录Web管理后台的密码【非必须】,若想要使用Web管理,为提高安全性,【必须】

[supervisord]                ; 定义Supervisord服务端参数【必须】
logfile=/tmp/supervisord.log ; 日志文件,默认是 $CWD/supervisord.log【非必须】
logfile_maxbytes=50MB        ; 日志文件大小,超出会生成新的,默认 50MB,如果设成0,表示不限制大小【非必须】
logfile_backups=10           ; 日志文件保留备份数量默认10,设为0表示不限制数量【非必须】
loglevel=info                ; 日志级别,默认info,其它: critical, error, warn, info, debug, trace, or blather【非必须】
pidfile=/tmp/supervisord.pid ; pid 文件路径,默认supervisord.pid【非必须】
nodaemon=false               ; 如果是true,Supervisord进程将在前台运行,默认是false,即后台启动【非必须】
minfds=1024                  ; 可以打开的文件描述符的最小值,默认 1024【非必须】
minprocs=200                 ; 可以打开的进程数的最小值,默认 200【非必须】
;umask=022                   ; 进程创建文件的掩码【非必须】
;user=chrism                 ; 设置一个非root用户,以root用户启动Supervisord之后,可以对Supervisord进行管理【非必须】
;identifier=supervisor       ; Supervisord的标识符,给XML_RPC用的,可以用来标识多个不同的Supervisord服务【非必须】
;directory=/tmp              ; 当Supervisord作为守护进程运行的时候,如果启用该参数,Supervisord会在该目录下执行【非必须】
;nocleanup=true              ; 为false的时候,会在Supervisord启动的时候清除掉之前子进程产生的日志,可以设置为true【非必须】
;childlogdir=/tmp            ; 子进程日志路径为AUTO的时候,子进程日志文件的存放路径,可以通过 python -c "import tempfile;print tempfile.gettempdir()" 查看默认路径【非必须】
;environment=KEY="value"     ; 设置Supervisord进程专属环境变量,可以被子进程继承【非必须】
;strip_ansi=false            ; 是否自动清除子进程日志中的ANSI字符(\n,\t等),默认为false【非必须】

[rpcinterface:supervisor]    ; 开放XML_RPC【必须】
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=chris              ; 参考[unix_http_server]设置,如果[unix_http_server]设置了,需保持一致【非必须】
;password=123                ; 参考[unix_http_server]设置,如果[unix_http_server]设置了,需保持一致【非必须】
;prompt=mysupervisor         ; 输入用户名密码时候的提示符默认supervisor【非必须】
;history_file=~/.sc_history  ; 类似shell中的history,可以用上下键来查找前面执行过的命令,默认是no file,如果想要有这种功能,必须指定一个文件【非必须】

; The sample program section below shows all possible program subsection values.
; Create one or more 'real' program: sections to be able to control them under
; supervisor.

;[program:theprogramname]      ; 子进程管理设置,":"后面的是名字,可以设置多个,一个program就是一个要被管理的进程,开启子进程管理时【必须】
;command=/bin/cat              ; 子进程命令路径,可以带参数,例子:/home/test.py -a 'hello',开启子进程管理时【必须】
;process_name=%(program_name)s ; 进程名,numprocs参数为1时该参数没有实际意义,默认值%(program_name)s即为[program:theprogramname]中的theprogramname【非必须】
;numprocs=1                    ; 启动进程的数目。不为1时,就是进程池的概念,注意process_name的设置,默认为1【非必须】
;directory=/tmp                ; 进程运行前,先切换到这个目录【非必须】
;umask=022                     ; 进程掩码,默认none【非必须】
;priority=999                  ; 子进程启动关闭优先级,优先级低的,最先启动,关闭的时候最后关闭,默认值为999【非必须】
;autostart=true                ; 为true时子进程将在supervisord启动后被自动启动,默认是true【非必须】
;startsecs=1                   ; 子进程启动多少秒后如果状态是running,则我们认为进程启动成功,默认为1【非必须】
;startretries=3                ; 进程启动失败后,最大尝试启动的次数,默认为3,超过3次后,Supervisor将把此进程的状态置为FAIL【非必须】
;autorestart=unexpected        ; 子进程挂掉后自动重启的设置,有三个选项,false,unexpected和true,为false时无论什么情况都不会被自动重启,为unexpected时只有当进程的退出码不在exitcodes范围里才会被自动重启,为true时只要子进程挂掉就会被无条件的重启【非必须】
;exitcodes=0,2                 ; 与上面的autorestart=unexpected设置对应【非必须】
;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【非必须】
;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                ; 参考以上解释【非必须】


;[eventlistener:theeventlistenername]    ; 与program同样都是Suopervisor启动的子进程,负责订阅Supervisord发送的event,称之为listener了【非必须】
;command=/bin/eventlistener    ; 同program设置相同【非必须】
;process_name=%(program_name)s ; 同program设置相同【非必须】
;numprocs=1                    ; 同program设置相同【非必须】
;events=EVENT                  ; event事件的类型,只有写在这个地方的事件类型,才会被发送【非必须】
;buffer_size=10                ; event队列缓存大小,默认值为10【非必须】
;directory=/tmp                ; 同program设置相同【非必须】
;umask=022                     ; 同program设置相同【非必须】
;priority=-1                   ; 同program设置相同【非必须】
;autostart=true                ; 同program设置相同【非必须】
;startsecs=1                   ; 同program设置相同【非必须】
;startretries=3                ; 同program设置相同【非必须】
;autorestart=unexpected        ; 同program设置相同【非必须】
;exitcodes=0,2                 ; 同program设置相同【非必须】
;stopsignal=QUIT               ; 同program设置相同【非必须】
;stopwaitsecs=10               ; 同program设置相同【非必须】
;stopasgroup=false             ; 同program设置相同【非必须】
;killasgroup=false             ; 同program设置相同【非必须】
;user=chrism                   ; 同program设置相同【非必须】
;redirect_stderr=false         ; 同program设置相同【非必须】
;stdout_logfile=/a/path        ; 同program设置相同【非必须】
;stdout_logfile_maxbytes=1MB   ; 同program设置相同【非必须】
;stdout_logfile_backups=10     ; 同program设置相同【非必须】
;stdout_events_enabled=false   ; 同program设置相同【非必须】
;stderr_logfile=/a/path        ; 同program设置相同【非必须】
;stderr_logfile_maxbytes=1MB   ; 同program设置相同【非必须】
;stderr_logfile_backups=10     ; 同program设置相同【非必须】
;stderr_events_enabled=false   ; 同program设置相同【非必须】
;environment=A="1",B="2"       ; 同program设置相同【非必须】
;serverurl=AUTO                ; 同program设置相同【非必须】


;[group:thegroupname]          ; 为programs分组,在组里面的program就不用一个一个去操作,可以对组名进行统一的操作。 注意:program被划分到组里面之后,Supervisor只会对组进行管理,而不再对组里面的单个program进行管理,使用组操作时【必须】
;programs=progname1,progname2  ; 组成员,用逗号分开,使用组操作时【必须】
;priority=999                  ; 优先级,相对于组和组之间,默认999【非必须】

;[include]
;files = relative/directory/*.ini    ; 需要管理的进程很多的时候,可以把配置信息写到多个文件中,然后include引入,引入多个配置文件时可以使用 空格 分割不同的配置文件

PS.即使是使用默认生成的配置文件也可以直接启动Supervisor,这里提供一份我设置的配置文件(仅供参考):

[unix_http_server]
file=/var/run/supervisor.sock

[inet_http_server]
port=*:9001
username=user
password=password

[supervisord]
logfile=/var/log/supervisord.log
logfile_maxbytes=50MB
logfile_backups=10
loglevel=info
pidfile=/var/run/supervisord.pid
nodaemon=false
minfds=1024
minprocs=200

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[supervisorctl]
serverurl=unix:///var/run/supervisor.sock

[include]
files = supervisord.d/*

PS.这里使用/etc/supervisord.d文件夹作为Supervisor项目配置目录,在使用时需要创建该目录:

mkdir -p /etc/supervisord.d

4、服务管理

  • 启动Supervisord:
supervisord -c /etc/supervisord.conf
  • 关闭Supervisord:
supervisorctl shutdown
  • 重载:
supervisorctl reload
  • 开机启动:

    • /etc/rc.local中添加命令:
      supervisord -c /etc/supervisord.conf
    
    • 修改/etc/rc.local执行权限:
      chmod +x  /etc/rc.local
    

5、使用Nginx进行Web管理

Nginx配置文件如下:

server {
    listen 80;
    server_name xx.com;
    location / {
        proxy_http_version 1.1;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_pass http://127.0.0.1:9001$request_uri;
        proxy_redirect off;
  }
}

这样就可以用Web控制Supervisor了

6、项目配置文件

以下是简单的项目配置文件内容(仅供参考):

[program:test]
command=command
user=root
autorstart=true
autorestart=true
startsecs=10
startretries=3
redirect_stderr=true
stdout_logfile=logfile
stderr_logfile=errfile
environment=env

将配置文件放在目录/etc/supervisord.d中,然后重启Supervisord即可

7、使用Supervisorctl管理项目

Supervisorctl启动时需要指定与Supervisord使用同一份配置文件,否则与Supervisord一样按照顺序查找配置文件,常用命令如下:

  • 启动Supervisorctl:
    supervisorctl -c /etc/supervisord.conf
    
    使用上面的命令会进入Supervisorctl的shell界面
  • 查看项目状态:
    supervisorctl status
    
    在shell中直接输入后面的命令即可
  • 启动项目test:
    supervisorctl start test
    
  • 关闭项目test:
    supervisorctl stop test
    
  • 重启项目test:
    supervisorctl restart test
    

其它命令及用法可参考官方介绍Running Supervisorctl

以上就是Supervisor的使用方法,欢迎在文章下方留言。

本文链接:https://www.shaobin.wang/post/27.html

Comments