Laravel 5.1 Triaged Queues
Extend Laravel 5.1 Queues to fallback to an arbitrary number of hosts in the event one is unreachable.
This package extends Laravel 5.1 Queues by adding these features:
- Enable connection attempts to multiple hosts, sequentially, in the event the primary host is unreachable.
- If all hosts for a connection fail, enable falling back to the
syncdriver so that a job/command can be processed synchronously and therefore avoid data loss.
- (Beanstalkd Only) An extra
touch()pheanstalk command is available on jobs and socket timeout can be specified via queue config.
Require this package
composer require "fulfillment/laravel-triaged-queues:0.1.*"
After adding the package, add the ServiceProvider to the providers array in
and remove Laravel's
QueueServiceProvider if present in
Currently only the
beanstalkd driver is supported. PRs for additional drivers are welcome.
A normal Queue Connection from
config/queue.php looks like this:
'beanstalkd' => [ 'driver' => 'beanstalkd', 'host' => env('BEANSTALK_HOST', 'localhost'), 'queue' => 'default', 'ttr' => 60, 'socketTimeout' => null ],
TriagedQueues offers three entries:
Simply add an arbitrary number of host entries to the connection with this syntax
'host[N]' => '[host value]'
where [N] is the order you want that host to be attempted in. The primary host does not need a number.
'host' => 'server.domain.com', 'host1' => 'server-fallback1.domain.com', 'host2' => 'server-fallback2.domain.com', ...
If the entry
fallbackToSync is set and
true then TriagedQueues will use the
sync driver in the event all hosts are unreachable.
'host' => 'server.domain.com', 'host1' => 'server-fallback1.domain.com', 'host2' => 'server-fallback2.domain.com', 'fallbackToSync' => true ...
attempts entry will make TriagedQueues try to establish a connection X number of tries before moving to the next host.
'attempts' => 2
touch() (Beanstalkd Only)
A modified version of the
BeanstalkdJob includes a
touch() method which will send a
touch command for the job to the beanstalkd queue. This resets the time-left (TTR minus running time) on the job so it isn't kicked back to the ready queue.
socketTimeout (Beanstalkd Only)
If a job is long-running one must either increase TTR (time-to-run) for the job or
touch it periodically to keep it reserved. However there is another factor that determines job behavior: if the client disconnects while a job is reserved the job will be kicked back to the ready queue regardless of TTR.
So for jobs that run longer than the default socket timeout (60 seconds, in ini settings) one must
touch the job periodically, change this ini setting, or use the
socketTimeout key-value in the configuration to specify timeout manually for
Contributing additional drivers is welcomed! The steps for creating a new driver are simple:
- Create a new class in
connect()function), make sure your method attempts all listed hosts in the
- If no host attempt works, throw
Then make a PR and I will happily accept it :)
This package is licensed under the MIT license.