- PHP 99.7%
- JavaScript 0.3%
| .github/workflows | ||
| config | ||
| src | ||
| tests | ||
| workbench | ||
| .editorconfig | ||
| .gitignore | ||
| .php-cs-fixer.php | ||
| commitlint.config.js | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| herd.yml | ||
| lefthook.yml | ||
| LICENSE | ||
| mise.toml | ||
| package.json | ||
| phpstan.neon | ||
| phpunit.xml | ||
| pnpm-lock.yaml | ||
| README.md | ||
| rector.php | ||
| testbench.yaml | ||
| UPGRADING.md | ||
Laravel Metronome
A drop-in replacement for Laravel's built-in scheduler using an event loop instead of Cron.
Requirements
- PHP 8.2+
- Laravel 12+
ext-pcntl
Installation
composer require rvxlab/laravel-metronome
Usage
Replace your schedule:work invocation with:
php artisan metronome:start
Configuration
Metronome can be configured with the following environment variables:
| Environment Variable | Default Value | Description |
|---|---|---|
METRONOME_TICK_RATE |
1.0 |
The time between each scheduler call in seconds. Must be greater than 0. Lower values may increase CPU usage and values above 1 are not recommended due to dropped tasks. |
If you need more control over the config, you can publish it using php artisan vendor:publish --tag laravel-metronome:config.
Overlap Protection
Metronome makes use of Laravel's overlap protection, exactly how the built-in scheduler works.
Calls to ->withoutOverlapping() will continue to work as expected.
Long-running tasks
As with Laravel's built-in scheduler, synchronous tasks that run long will delay later ticks. For tasks
expected to take more than a second or two, use ->runInBackground() to shell out a child process instead.
$schedule->command('orders:process')->everyMinute()->runInBackground();
Running with Supervisor
Add the following to your Supervisor configuration, adjusting command, user, and stdout_logfile to match your
setup.
[program:laravel-metronome]
process_name = %(program_name)s_%(process_num)02d
command = php /var/www/html/artisan metronome:start
autostart = true
autorestart = true
stopasgroup = true
killasgroup = true
user = www-data
numprocs = 1
redirect_stderr = true
stdout_logfile = /var/www/html/storage/logs/metronome.log
stopwaitsecs = 60
numprocs must be 1. Running multiple instances will cause tasks to fire multiple times. stopwaitsecs should be
set
high enough to allow any currently running tasks to finish before Supervisor force-kills the process.
Running with Docker
Because Metronome doesn't rely on Cron, it's really easy to have it run in a Docker container, either directly or through Supervisor.
Without Supervisor, you can run the scheduler directly as the container's entrypoint:
FROM php:8.2-cli
RUN docker-php-ext-install pcntl
WORKDIR /var/www/html
COPY . .
CMD ["php", "artisan", "metronome:start"]
Or with Supervisor, if you need it running alongside other processes:
FROM php:8.2-cli
RUN apt-get update && apt-get install -y \
supervisor \
&& rm -rf /var/lib/apt/lists/* \
&& docker-php-ext-install pcntl
WORKDIR /var/www/html
COPY . .
COPY supervisord.conf /etc/supervisor/conf.d/laravel-metronome.conf
CMD ["/usr/bin/supervisord", "-n", "-c", "/etc/supervisor/supervisord.conf"]
Stopping the Scheduler
Send SIGINT (Ctrl+C) or SIGTERM to stop the process cleanly. Laravel's shutdown logic runs before the process
exits, so process managers like Supervisor and systemd work out of the box.
Known limitations
- Last-run state is held in memory and not persisted across process restarts. A task that ran shortly before a crash may re-run immediately on startup.
License
This package is licensed under MIT.