Laravel Queue Monitor – Monitor job queues

Laravel Queue Monitor is a package designed to provide insights into your Laravel application’s job queues. It offers a user-friendly interface for monitoring queued jobs, making it easier to track their status, performance, and any potential issues. This is particularly useful for applications that rely heavily on queued jobs, such as sending emails, processing uploads, or handling any background tasks.

Key Features of Laravel Queue Monitor:

Job Status Tracking: Monitor the status of jobs, including pending, processing, and completed jobs.
Job Performance Metrics: View metrics such as execution time and failure rates for jobs.
Detailed Job Information: Get detailed information about each job, including payload, attempts, and error messages.
Real-Time Updates: Provides real-time updates on job processing status.
Custom Notifications: Set up notifications for job failures or other important events.
Integration with Laravel Horizon: Can be used alongside Laravel Horizon for enhanced queue monitoring.

Installation

To get started with Laravel Queue Monitor, follow these steps:

Require the Package: Install the package via Composer. Note that there might be different packages available; here we will use laravel-queue-monitor as an example.

composer require --dev vladimir-yuldashev/laravel-queue-monitor

1

composer require --dev vladimir-yuldashev/laravel-queue-monitor
Publish Configuration: Publish the configuration file using:

php artisan vendor:publish --provider="VladimirYuldashev\LaravelQueueMonitor\QueueMonitorServiceProvider"

1

php artisan vendor:publish --provider="VladimirYuldashev\LaravelQueueMonitor\QueueMonitorServiceProvider"
Run Migrations: Run the migrations to create the necessary database tables:

php artisan migrate

1

php artisan migrate

Setting Up the Monitor

Configuring the Package: After publishing the configuration file, you can customize settings in config/queue-monitor.php to fit your application’s needs. You can specify options like the connection to use, job timeouts, and the database tables used.

Middleware: If you want to add middleware to your jobs to automatically record their status, you can do so by updating the job class.

use VladimirYuldashev\LaravelQueueMonitor\Trackable;

class YourJob implements ShouldQueue
{
    use Trackable;

    public function handle()
    {
        // Your job logic here...
    }
}

use VladimirYuldashev\LaravelQueueMonitor\Trackable;

class YourJob implements ShouldQueue

{

use Trackable;

public function handle()

{

// Your job logic here...

}

Monitoring Jobs

Once you have set up Laravel Queue Monitor, you can access the monitoring interface, typically at a route defined in your application. By default, the route might be /queue-monitor. You can change this route in the configuration file.

Accessing Job Details

In the queue monitoring interface, you can see:

Job ID: Unique identifier for the job.
Status: Current status (pending, processing, failed, etc.).
Execution Time: How long the job took to execute.
Attempts: Number of times the job has been retried.
Error Messages: Any error messages associated with failed jobs.

Notifications for Failed Jobs

You can set up notifications for when jobs fail. This can be done using Laravel’s notification system. You can configure this in your job classes or globally in the config/queue-monitor.php file.

Conclusion

Laravel Queue Monitor is a valuable tool for managing and monitoring queued jobs in your Laravel applications. By providing insights into job performance and status, it helps developers maintain and troubleshoot background processing tasks effectively.

Additional Considerations

Documentation: For more detailed information, advanced features, and configuration options, refer to the official Laravel Queue Monitor documentation.
Performance Optimization: Monitor your job performance and make adjustments to optimize job processing times.