Previous upgrade guides

• Upgrading to 4.0 from 3.0
• Upgrading to 3.0 from 2.0
• Upgrading to 2.0 from 1.0

Version 4.0 added the ability to retry jobs. For this two new columns job_uuid and retried are introduced.

Upgrading to 5.0 from 4.0

Changes

• Add monitoring queued jobs #131 by @AsemAlalami
• Add SQLite support
• Add PostgreSQL support

Database

Version 5.0 adds the ability to also monitor queued jobs which requires a new column queued_at

php artisan vendor:publish --provider="romanzipp\QueueMonitor\Providers\QueueMonitorProvider" --tag=migrations
php artisan migrate

Config

A new config option monitor_queued_jobs is introduced. Dispatched jobs will be automatically monitored. If you wish to disable this feature, make sure to change this config value.

Previous upgrade guides

• Upgrading to 4.0 from 3.0
• Upgrading to 3.0 from 2.0
• Upgrading to 2.0 from 1.0

Version 4.0 added the ability to retry jobs. For this two new columns job_uuid and retried are introduced.

Upgrading to 5.0 from 4.0

Changes

• Add monitoring queued jobs #131 by @AsemAlalami
• Add SQLite support
• Add PostgreSQL support

Database

Version 5.0 adds the ability to also monitor queued jobs which requires a new column queued_at

php artisan vendor:publish --provider="romanzipp\QueueMonitor\Providers\QueueMonitorProvider" --tag=migrations
php artisan migrate

Config

A new config option monitor_queued_jobs is introduced. Dispatched jobs will be automatically monitored. If you wish to disable this feature, make sure to change this config value.

Previous upgrade guides

Version 3.0 introduced many database related changes. Make sure to follow this upgrade guide before if you come from version 2.

• Upgrading to 3.0 from 2.0
• Upgrading to 2.0 from 1.0

Upgrading to 4.0 from 3.0

Changes

• Add retry UI actions #123 by @Michel-Verhoeven
• Add UI middleware

Database

Version 4.0 adds the ability to retry jobs. For this two new columns job_uuid and retried are introduced.

php artisan vendor:publish --provider="romanzipp\QueueMonitor\Providers\QueueMonitorProvider" --tag=migrations
php artisan migrate

Changes

• Add status column
• Add queue-monitor:stale command to mark jobs as stale
• Add queue-monitor:purge command to delete old monitor entires
• Update route registration
• Add stale job detection
• Rework UI (+ darkmode)

Upgrading to 3.0 from 2.0

Minimum version

The minimum PHP version is 8.0.

Database

Version 3.0 adds a new status column to the queue monitor table which replaces the previous failed column.
The migration also keeps the failed state before removing the old column.

Publish & execute upgrade migration:

php artisan vendor:publish --provider="romanzipp\QueueMonitor\Providers\QueueMonitorProvider" --tag=migrations
php artisan migrate

Routes

The routes are not registered by a mixin anymore. There is a new ui.route configuration entry which sets the prefix and middlewares for your new routes.

- Route::queueMonitor();

UI

Version 3.0 now contains a compiled CSS asset for the UI. Publish the frontend assets with the following command:

php artisan vendor:publish --provider="romanzipp\QueueMonitor\Providers\QueueMonitorProvider" --tag=assets

Update references

failed column removed

- $monitor->failed
+ $monitor->status === \romanzipp\QueueMonitor\Enums\MonitorStatus::FAILED

time_elapsed column removed

- $monitor->time_elapsed
+ $monitor->getElapsedSeconds()  // returns floats
+ $monitor->getElapsedInterval() // returns \Carbon\CarbonInterval

Upgrading to 2.0 from 1.0

Database

Add the following fields to your queue monitor table:

• exception_message (string, nullable)
• exception_class (long text, nullable)

The Job Trait

The job trait has been renamed to a more intuitive name.

- use romanzipp\QueueMonitor\Traits\QueueMonitor;
+ use romanzipp\QueueMonitor\Traits\IsMonitored; 

The Monitor Model

Changed Methods

- $monitor->basename()
- $monitor->basename
+ $monitor->getBasename()

- $monitor->parsed_data
+ $monitor->getData()

- $monitor->remaing_seconds
+ $monitor->getRemainingSeconds()

- $monitor->startedAtExact()
+ $monitor->getStartedAtExact()

- $monitor->finishedAtExact()
+ $monitor->getFinishedAtExact()

- $monitor->isSucceeded()
+ $monitor->hasSucceeded()

The getRemainingSeconds() method now always returns a float instead of float|null,

- public function getRemainingSeconds(): ?float
+ public function getRemainingSeconds(): float

New Methods

+ $monitor->hasFailed()

Laravel 7 support

• Last hour comparison fixed by @eboye

• Add remaining seconds calculation

Enhance monitor ordered scope

• Add queue monitor deletion method

• Fix null job instance on trait

• Remove DontMonitor Trait
• Add QueueMonitor Trait as requirement for monitoring
• General refactoring
• Fix millisecond calc bug by @darron1217

• Fix elapsed time calc bug by @darron1217
• Saving attempt count on job start by @darron1217

• Fix monitor trait job id generation

• Fix exception if job executed via "dispatch_now"

• Change custom monitor data to json instead of serialization

Add support for job Progress & Custom job data.