美文网首页PHP经验分享
Supervisor的配置步骤

Supervisor的配置步骤

作者: wxy1 | 来源:发表于2019-05-10 10:11 被阅读1次

    最近的PHP项目中,需要用到常驻后台的脚本,使用Supervisor管理进程,可以实现对异常中断的子进程的自动重启,省去自己写守护进程,非常的方便,在此与大家分享。

    1安装supervisor

    yum install -y supervisor
    

    2配置文件

    vim /etc/supervisord.conf
    

    配置文件如下:

    ; Sample supervisor config file.
    
    [unix_http_server]
    file=/var/run/supervisor/supervisor.sock   ; (the path to the socket file)
    ;chmod=0700                 ; sockef file mode (default 0700)
    ;chown=nobody:nogroup       ; socket file uid:gid owner
    ;username=user              ; (default is no username (open server))
    ;password=123               ; (default is no password (open server))
    
    ;[inet_http_server]         ; inet (TCP) server disabled by default
    ;port=127.0.0.1:9001        ; (ip_address:port specifier, *:port for all iface)
    ;username=user              ; (default is no username (open server))
    ;password=123               ; (default is no password (open server))
    
    [supervisord]
    logfile=/var/log/supervisor/supervisord.log  ; (main log file;default $CWD/supervisord.log)
    logfile_maxbytes=50MB       ; (max main logfile bytes b4 rotation;default 50MB)
    logfile_backups=10          ; (num of main logfile rotation backups;default 10)
    loglevel=info               ; (log level;default info; others: debug,warn,trace)
    pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
    nodaemon=false              ; (start in foreground if true;default false)
    minfds=1024                 ; (min. avail startup file descriptors;default 1024)
    minprocs=200                ; (min. avail process descriptors;default 200)
    ;umask=022                  ; (process file creation umask;default 022)
    ;user=chrism                 ; (default is current user, required if root)
    ;identifier=supervisor       ; (supervisord identifier, default is 'supervisor')
    ;directory=/tmp              ; (default is not to cd during start)
    ;nocleanup=true              ; (do not clean up tempfiles at start;default false)
    ;childlogdir=/tmp            ; ('AUTO' child log dir, default $TEMP)
    ;environment=KEY=value       ; (key value pairs to add to environment)
    ;strip_ansi=false            ; (strip ansi escape codes in logs; def. 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]
    supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
    
    [supervisorctl]
    serverurl=unix:///var/run/supervisor/supervisor.sock ; use a unix:// URL  for a unix socket
    ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
    ;username=chris              ; should be same as http_username if set
    ;password=123                ; should be same as http_password if set
    ;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
    ;history_file=~/.sc_history  ; use readline history if available
    
    ; 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]
    ;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)
    ;autorestart=true              ; retstart at unexpected quit (default: true)
    ;startsecs=10                  ; number of secs prog must stay running (def. 1)
    ;startretries=3                ; max # of serial start failures (default 3)
    ;exitcodes=0,2                 ; 'expected' exit codes for process (default 0,2)
    ;stopsignal=QUIT               ; signal used to kill process (default TERM)
    ;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
    ;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)
    
    ; 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]
    ;command=/bin/eventlistener    ; 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)
    ;events=EVENT                  ; event notif. types to subscribe to (req`d)
    ;buffer_size=10                ; event buffer queue size (default 10)
    ;directory=/tmp                ; directory to cwd to before exec (def no cwd)
    ;umask=022                     ; umask for process (default None)
    ;priority=-1                   ; the relative start priority (default -1)
    ;autostart=true                ; start at supervisord start (default: true)
    ;autorestart=unexpected        ; restart at unexpected quit (default: unexpected)
    ;startsecs=10                  ; number of secs prog must stay running (def. 1)
    ;startretries=3                ; max # of serial start failures (default 3)
    ;exitcodes=0,2                 ; 'expected' exit codes for process (default 0,2)
    ;stopsignal=QUIT               ; signal used to kill process (default TERM)
    ;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
    ;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_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        ; # of stderr logfile backups (default 10)
    ;stderr_events_enabled=false   ; emit events on stderr writes (default false)
    ;environment=A=1,B=2           ; process environment additions
    ;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=progname1,progname2  ; each refers to 'x' in [program:x] definitions
    ;priority=999                  ; the relative start priority (default 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]
    files = supervisord.d/*.ini   //在supervisord.d 文件夹下 建立xxx.ini文件 对应一个program
    
    

    以上配置文件用到几个部分:

    • [unix_http_server]:这部分设置HTTP服务器监听的UNIX domain socket

      file: 指向UNIX domain socket,即file=/var/run/supervisor.sock
      chmod:启动时改变supervisor.sock的权限

    • [supervisord]:与supervisord有关的全局配置需要在这部分设置

      logfile: 指向记录supervisord进程的log文件
      pidfile:pidfile保存子进程的路径
      childlogdir:子进程log目录设为AUTO的log目录

    • [supervisorctl]:

      serverurl:进入supervisord的URL, 对于UNIX domain sockets, 应设为 unix:///absolute/path/to/file.sock

    • [include]:如果配置文件包含该部分,则该部分必须包含一个files键:

      files:包含一个或多个文件,这里包含了/etc/supervisor/conf.d/目录下所有的.conf文件,可以在该目录下增加我们自己的配置文件,在该配置文件中增加[program:x]部分,用来运行我们自己的程序,如下:

    • [program:x]:配置文件必须包括至少一个program,x是program名称,必须写上,不能为空

      command:包含一个命令,当这个program启动时执行
      directory:执行子进程时supervisord暂时切换到该目录
      user:账户名
      startsecs:进程从STARING状态转换到RUNNING状态program所需要保持运行的时间(单位:秒)
      redirect_stderr:如果是true,则进程的stderr输出被发送回其stdout文件描述符上的supervisord
      stdout_logfile:将进程stdout输出到指定文件
      stdout_logfile_maxbytes:stdout_logfile指定日志文件最大字节数,默认为50MB,可以加KB、MB或GB等单位
      stdout_logfile_backups:要保存的stdout_logfile备份的数量

    3示例及详细步骤

    首先启动supervisord

    supervisord -c /etc/supervisord.conf         通过配置文件启动supervisor
    

    可能遇到的问题
    Unlinking stale socket /var/run/supervisor/supervisor.sock
    解决方法

    unlink /var/run/supervisor/supervisor.sock
    

    再次启动成功
    准备一个脚本来模拟实际场景

    [root@izwz9hdz8b83dgcyit9wclz test]# pwd
    /data/test
    [root@izwz9hdz8b83dgcyit9wclz test]# ls
    demo1.sh  output.txt
    [root@izwz9hdz8b83dgcyit9wclz test]# 
    

    demo1.sh一直向output.txt写入内容
    demo1.sh具体代码

    #!/bin/bash
     set j=2
     while true
     do
            let "j=j+1"
            echo "---j is $j---\n" >> output.txt
    
            sleep 20
     done
    

    测试文件准备完毕
    接下来需要配置program
    通过查看/etc/supervisord.conf 的配置文件可知

    [include]
    files = supervisord.d/*.ini   //在supervisord.d 文件夹下 建立xxx.ini文件 对应一个program
    
    

    需要在supervisord.d/文件夹下 创建.ini为后缀的配置文件对应一个program

    [root@izwz9hdz8b83dgcyit9wclz supervisord.d]# pwd
    /etc/supervisord.d
    [root@izwz9hdz8b83dgcyit9wclz supervisord.d]# ll
    total 4
    -rw-r--r-- 1 root root 427 Apr  1 16:44 demo1.sh.ini
    
    

    具体配置

    [program:demo1]
    
    command          = /bin/bash demo1.sh
    directory        = /data/test
    user             = www-data
    startsecs        = 2
    
    autostart=true                ; start at supervisord start (default: true)
    autorestart=true       ; restart at unexpected quit (default: unexpected)
    
    
    redirect_stderr         = true
    stdout_logfile_maxbytes = 50MB
    stdout_logfile_backups  = 10
    stdout_logfile          = /data/log/app.log
    
    

    所有文件准备完毕
    此时output.txt应该是空的
    由于supervisord还没有启动直接使用配置文件(由于配置文件已经引入了刚刚配置好的program program 对应的项目会自动启动)启动supervisord
    如果supervisord已经启动,应该使用supervisorctl启动指定的服务
    此处先演示supervisord启动

    supervisord -c /etc/supervisord.conf 
    

    启动完毕后查看一下项目的状态

    [root@izwz9hdz8b83dgcyit9wclz test]# supervisorctl status
    demo1                            RUNNING   pid 13613, uptime 0:01:12
    [root@izwz9hdz8b83dgcyit9wclz test]# 
    
    

    可以看到demo1已经启动
    查看output.txt文件

    [root@izwz9hdz8b83dgcyit9wclz test]# cat output.txt 
    
    ---j is 1---\n
    ---j is 2---\n
    ---j is 3---\n
    ---j is 4---\n
    ---j is 5---\n
    ---j is 6---\n
    ---j is 7---\n
    ---j is 8---\n
    ---j is 9---\n
    
    

    然后我们kill掉进程模拟 脚本崩溃

    [root@izwz9hdz8b83dgcyit9wclz test]# ps -aux | grep demo1
    www-data 13613  0.0  0.0 113120  1432 ?        S    09:58   0:00 /bin/bash demo1.sh
    root     13675  0.0  0.0 112648   964 pts/1    S+   10:02   0:00 grep --color=auto demo1
    [root@izwz9hdz8b83dgcyit9wclz test]# kill -9 13613
    
    

    此时立刻查看脚本状态

    [root@izwz9hdz8b83dgcyit9wclz ~]# supervisorctl status
    demo1                            STARTING  
    [root@izwz9hdz8b83dgcyit9wclz ~]# supervisorctl status
    demo1                            RUNNING   pid 13690, uptime 0:00:06
    [root@izwz9hdz8b83dgcyit9wclz ~]# 
    
    
    

    可以看到脚本已经再次启动中STARTING ,然后变成RUNNING
    说明supervisor 可以实现对异常中断的子进程的自动重启
    其他:
    手动来停止一下这个服务

    supervisorctl stop demo1
    
    [root@izwz9hdz8b83dgcyit9wclz ~]# supervisorctl stop demo1
    demo1: stopped
    [root@izwz9hdz8b83dgcyit9wclz ~]# supervisorctl status
    demo1                            STOPPED   May 10 10:08 AM
    [root@izwz9hdz8b83dgcyit9wclz ~]# 
    

    再次启动这个服务(此处同上面提到的 如果supervisord已经启动 此时只需使用supervisorctl 启动指定的服务)

    supervisorctl start demo1
    
    

    相关文章

      网友评论

        本文标题:Supervisor的配置步骤

        本文链接:https://www.haomeiwen.com/subject/lxtciqtx.html