Package Data | |
---|---|
Maintainer Username: | FoxxMD |
Maintainer Contact: | matt.duncan13@gmail.com (FoxxMD) |
Package Create Date: | 2016-03-11 |
Package Last Update: | 2021-03-18 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-09-01 03:13:01 |
Package Statistics | |
---|---|
Total Downloads: | 16,626 |
Monthly Downloads: | 4 |
Daily Downloads: | 0 |
Total Stars: | 5 |
Total Watchers: | 4 |
Total Forks: | 1 |
Total Open Issues: | 0 |
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:
sync
driver so that a job/command can be processed synchronously and therefore avoid data loss.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 config/app.php
Fulfillment\TriagedQueues\TriagedQueueServiceProvider::class,
and remove Laravel's QueueServiceProvider
if present in config/app.php
'Illuminate\Queue\QueueSeverProvider'
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.
EX:
'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.
EX:
'host' => 'server.domain.com',
'host1' => 'server-fallback1.domain.com',
'host2' => 'server-fallback2.domain.com',
'fallbackToSync' => true
...
Adding an attempts
entry will make TriagedQueues try to establish a connection X number of tries before moving to the next host.
'attempts' => 2
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.
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 fsockopen
.
Contributing additional drivers is welcomed! The steps for creating a new driver are simple:
Fulfillment\TriagedQueues\Queue\Connectors
that implements Illuminate\Queue\Connectors\ConnectorInterface
ConnectorInterface
(the connect()
function), make sure your method attempts all listed hosts in the $config
parameter.NoHostException
Then make a PR and I will happily accept it :)
This package is licensed under the MIT license.