This is a package to monitor background jobs for FilamentPHP. It is inspired by Laravel Horizon and is compatible with all drivers.
Check your filamentPHP version before installing:
| Version | FilamentPHP | PHP |
|---|---|---|
| 1.* | 2.* | 8.1.* |
| 2.* | 3.* | 8.1.* | 8.2.* |
Install the package via composer:
composer require croustibat/filament-jobs-monitorPublish and run the migrations using:
php artisan vendor:publish --tag="filament-jobs-monitor-migrations"
php artisan migrateThe global plugin config can be published using the command below:
php artisan vendor:publish --tag="filament-jobs-monitor-config"This is the content of the published config file:
return [
'resources' => [
'enabled' => true,
'label' => 'Job',
'plural_label' => 'Jobs',
'navigation_group' => 'Settings',
'navigation_icon' => 'heroicon-o-cpu-chip',
'navigation_sort' => null,
'navigation_count_badge' => false,
'resource' => Croustibat\FilamentJobsMonitor\Resources\QueueMonitorResource::class,
],
'pruning' => [
'enabled' => true,
'retention_days' => 7,
],
];If you are using Filament Panels, you can register the Plugin to your Panel configuration. This will register the plugin's resources as well as allow you to set configuration using optional chainable methods.
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
\Croustibat\FilamentJobsMonitor\FilamentJobsMonitorPlugin::make()
->label('Job')
->pluralLabel('Jobs')
->enableNavigation(true)
->navigationIcon('heroicon-o-cpu-chip')
->navigationGroup('Settings')
->navigationSort(5)
->navigationCountBadge(true)
->enablePruning(true)
->pruningRetention(7)
->resource(\App\Filament\Resources\CustomJobMonitorResource::class)
]);
}Just run a Background Job and go to the route /admin/queue-monitors to see the jobs.
Go to example folder to see a Job example file.
Then you can call your Job with the following code:
public static function table(Table $table): Table
{
return $table
// rest of your code
...
->bulkActions([
BulkAction::make('export-jobs')
->label('Background Export')
->icon('heroicon-o-cog')
->action(function (Collection $records) {
UsersCsvExportJob::dispatch($records, 'users.csv');
Notification::make()
->title('Export is ready')
->body('Your export is ready. You can download it from the exports page.')
->success()
->seconds(5)
->icon('heroicon-o-inbox-in')
->send();
})
])
}Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.