README

QBeacon is a real-time dashboard for monitoring Laravel queued jobs. It provides an easy-to-use interface for tracking the status of your jobs, retrying failed ones, and gaining insights into your job processing.

Features

Real-time monitoring of Laravel jobs.
Retry failed jobs directly from the dashboard.
View detailed job statuses (e.g., Pending, Processing, Failed, Completed).
Tracks job attempts and provides detailed logs.

Installation

Requirements

PHP: >=8.0
Laravel: >=9.x
Database: Ensure you have the failed_jobs table configured in your Laravel project.

Steps

Install the package via Composer:
```
composer require qbeacon/queue-monitor
```

Publish the package assets:

php artisan vendor:publish --tag=queue-monitor-assets --force

Run migrations to create the required tables:
```
php artisan migrate
```

Add the following route to your web.php file (optional if routes are not automatically loaded):

Route::get('/queue-monitor', function () {
    return view('queue-monitor::dashboard');
});

Start the Laravel queue worker:
```
php artisan queue:work
```

Usage

Monitoring Jobs

Navigate to /queue-monitor in your application to view the dashboard. The dashboard shows:

Job Name: The name of the job class.
Status: The current status of the job (e.g., Failed, Completed, Processing).
Attempts: The number of attempts made to process the job.
Created At: The timestamp when the job was created.

Retrying Failed Jobs

Identify the failed job in the list.
Click the red Retry button in the "Action" column.
The job will be re-queued, and the status will update accordingly.

Dashboard

Below is a snapshot of the QBeacon dashboard:

Contributing

Feel free to contribute to this project by submitting issues or pull requests. Contributions are welcome to improve features or fix bugs.

License

QBeacon is open-source software licensed under the MIT license.

Support

If you encounter any issues, feel free to open an issue on the GitHub repository.

qbeacon / queue-monitor

Maintainers

Details