[8.x] Ability to slow the workers down

[themsaid]

php artisan queue:work --rest=0.5

Using the rest option, the worker will sleep after processing each job. This will slow down job processing.

This was requested by @fideloper a few months back and I kept getting similar requests regarding it for several people so I thought I'd propose it.

[GrahamCampbell]

Your example is float?

[themsaid]

similar to sleep. maybe in another commit we change both to float|int.

[paras-malhotra]

Is the main benefit here for the SQS driver to reduce API calls? Or perhaps even have jobs accumulate resources to process like laravel/ideas#2460?

[fideloper]

SQS api calls are one benefit (altho a similar PR could be made to use the SQS option that keeps a connection open to up to 30 seconds or so (IIRC) to wait further jobs - "long polling" of sorts.

My specific use case was wanting to throttle email sends through systems our customers use that throttle email sends over time.

[themsaid]

@paras-malhotra another benifit that was requested is to be able to control the rate of job processing in a limited-resources server where a burst of jops would cause the server to crash. Slowing down the processing allows the server to recover between jobs and do other things (like serve HTTP requests).

[dmyers]

This was a breaking change for my application which uses Laravel Horizon.

We started seeing these errors when running php artisan horizon:

  The "rest" option does not exist.
  The "rest" option does not exist.
  The "rest" option does not exist.
  The "rest" option does not exist.

Should this be a part of upgrade notes or the changeling in some way to inform people to upgrade Laravel Horizon which includes this change? https://github.com/laravel/horizon/pull/992/files

[driesvints]

@dmyers what's your use case for updating the framework and not horizon?

[denniseilander]

@driesvints I had the same issue. It was caused by our auto security checker which bumped Laravel from v8.24.0 to v8.43.0, so laravel/horizon kept its current version.

[driesvints]

@denniseilander please update horizon as well.

[denniseilander]

@driesvints yes, from now on I'll update horizon when laravel/framework is updated. Thanks!

[35grain]

Why isn't this useful feature included in the documentation?

[denniseilander]

@35grain Not everything is documented, as it is impossible to do IMO.
But feel free to open a PR to include it in the docs since it will be useful :)