MENU

配置Supervisor管理Laravel队列

April 16, 2019 • Read: 222 • 技术笔记

安装

可以用Python的pip工具进行安装

sudo pip install supervisor

也可以使用Linux的包管理命令安装

sudo apt-get install supervisor

配置

运行如下命令可以查看默认的配置

echo_supervisord_conf

如果需要修改默认的配置,可以运行下面命令生成一个默认的配置文件

echo_supervisord_conf > /etc/supervisord.conf

修改默认配置

默认配置文件中的supervisord.socksupervisord.log以及supervisord.pid是放在/tmp目录下,这个目录存放的是Linux中的临时文件,一旦被系统删除,就会提示unix:///tmp/supervisor.sock no such file,所以我们要把这三个文件放到其他目录中保存。

此处注意中文注释的几个需要修改的地方

[unix_http_server]
;此处修改为/var/run目录,避免被系统删除
file=/var/run/supervisor.sock   ; the path to the socket file
;chmod=0700                 ; socket 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]
;此处修改为/var/log/supervisor目录
logfile=/var/log/supervisor/supervisord.log
logfile_maxbytes=50MB        ; max main logfile bytes b4 rotation; default 50MB
logfile_backups=10           ; # of main logfile backups; 0 means none, default 10
loglevel=info                ; log level; default info; others: debug,warn,trace
;此处修改为/var/run目录
pidfile=/var/run/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              ; don't 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 rpcinterface:supervisor 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:x] sections.

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

; The supervisorctl section configures how supervisorctl will connect to
; supervisord.  configure it match the settings in either the unix_http_server
; or inet_http_server section.

[supervisorctl]
;此处是关键,否则执行supervisorctl status会爆出unix:// not found错误
serverurl=unix:///var/run/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 in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

; 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]
;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)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; when to restart if exited after running (def: unexpected)
;exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;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                   ; 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 (0 means none, 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 (0 means none, 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 sample eventlistener section below shows all possible eventlistener
; subsection values.  Create one or more 'real' eventlistener: sections to be
; able to handle event notifications sent by supervisord.

;[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)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; autorestart if exited after running (def: unexpected)
;exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;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                   ; setuid to this UNIX account to run the program
;redirect_stderr=false         ; redirect_stderr=true is not allowed for eventlisteners
;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 (0 means none, 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=10     ; # of stderr logfile backups (0 means none, 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 sample group section below 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,新增的配置将在/etc/supervisord.d/conf.d目录下并以.conf结尾
[include]
files = /etc/supervisord.d/conf.d/*.conf

上面的一些目录如果做了修改首先要创建这些目录,并且赋予相应的权限

sudo chmod 777 /var/run
sudo chmod 777 /var/log/supervisor

现在我们启动服务

supervisord -c /etc/supervisord.conf

此处最好别用root权限启动,否则可能导致后面php artisan命令出错

现在我们查看进程

pgrep supervisord | xargs ps -u --pid
USER       PID %CPU %MEM    VSZ   RSS TTY      STAT START   TIME COMMAND
root     13744  0.0  1.7 226320 17460 ?        Ss   1月12   0:08 /bin/python /usr/bin/supervisord -c /etc/supervisord.conf

具体项目配置

Supervisorctl 是 Supervisord 的一个命令行客户端工具,启动时需要指定与 Supervisord 使用同一份配置文件

我们在上面默认配置文件中加入了[include],所以我们在/etc/supervisord.d/conf.d下新建一个配置文件larashop-worker.conf

[program:larashop-worker]  ;项目名称
process_name=%(program_name)s_%(process_num)02d
command=php (填入你的artisan路径)/artisan queue:work redis --sleep=3 --tries=3  ;需要启动的命令
autostart=true
autorestart=true
user=root ;此处填入你运行WEB应用的用户
numprocs=8  ;进程数
redirect_stderr=true  ;把 stderr 重定向到 stdout,默认 false
stdout_logfile=/var/log/supervisor/larashop-queue.log  ;注意分配好日志文件夹权限

配置完成后我们执行

supervisorctl reread  # 读取有更新(增加)的配置文件,不会启动新添加的程序

supervisorctl update # 重启配置文件修改过的程序

supervisorctl start larashop-worker:* # 启动 larashop-worker 程序

运行

supervisorctl status # 查看状态

看到

larashop-worker:larashop-worker_00   RUNNING   pid 13769, uptime 14:03:33
larashop-worker:larashop-worker_01   RUNNING   pid 13770, uptime 14:03:33
larashop-worker:larashop-worker_02   RUNNING   pid 13767, uptime 14:03:33
larashop-worker:larashop-worker_03   RUNNING   pid 13768, uptime 14:03:33
larashop-worker:larashop-worker_04   RUNNING   pid 13765, uptime 14:03:33
larashop-worker:larashop-worker_05   RUNNING   pid 13766, uptime 14:03:33
larashop-worker:larashop-worker_06   RUNNING   pid 13763, uptime 14:03:33
larashop-worker:larashop-worker_07   RUNNING   pid 13764, uptime 14:03:33

说明Laravel队列已经开始正常运行了

如果在Laravel中修改了队列代码,需要重启Supervisor才能生效

可能出现的问题

1. ERROR (spawn error)

此时如果提示

larashop-worker:larashop-worker_00: ERROR (spawn error)
...

先检查上述的日志目录有没有权限,如果权限正常,则进入上面设置的日志目录查看日志文件

我这里进入var/log/supervisor查看日志文件larashop-queue.conf

可以看到错误均为

PHP Parse error:  syntax error, unexpected 'class' (T_CLASS), expecting identifier (T_STRING) or variable (T_VARIABLE) or '{' or '$' in xxx/artisan on line 33

然后我进入Laravel目录,使用

sudo php artisan 你的命令

执行artisan命令,同样爆出这个错误。所以原因在于启动supervisord和服务端的时候使用了root权限导致

先将原来的进程kill掉,使用非root权限重新执行服务端和客户端即可成功运行

2. unix:///tmp/supervisor.sock no such file

在服务端配置文件中将/tmp/supervisor.sock修改为var/run/supervisor.sock

3. supervisorctl start错误

执行supervisorctl start 你的项目名称,迟迟不出结果,按ctrl+c后爆出错误

Traceback (most recent call last):
  File "/bin/supervisorctl", line 11, in <module>
  ...

建议kill掉supervisord的进程,然后重新用pip安装一次,并重新配置一遍默认配置文件

链接

Last Modified: June 16, 2019
Archives QR Code
QR Code for this page
Tipping QR Code