|
| 1 | +# Filament laravel pulse |
| 2 | + |
| 3 | +[![Latest Version on Packagist][ico-version]][link-packagist] |
| 4 | +[![Total Downloads][ico-downloads]][link-downloads] |
| 5 | +[![Software License][ico-license]][link-license] |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +## Introduction |
| 10 | + |
| 11 | +Filament Laravel Pulse is a package designed to enhance your Filament dashboard with comprehensive monitoring widgets. It provides insights into various aspects of your Laravel application's performance, including cache usage, exceptions, queues, servers, and more. By integrating these widgets into your Filament dashboard, you gain visibility into critical metrics and streamline your monitoring process. |
| 12 | + |
| 13 | + |
| 14 | +## Features |
| 15 | + |
| 16 | +Filament Laravel Pulse offers the following features: |
| 17 | + |
| 18 | +- Server Monitoring: Track server performance metrics. |
| 19 | +- Cache Usage: Monitor cache utilization and performance. |
| 20 | +- Exception Tracking: View and manage exceptions thrown by your application. |
| 21 | +- Queue Management: Monitor job queues and processing times. |
| 22 | +- Performance Analytics: Insights into slow outgoing requests, queries, and application usage patterns. |
| 23 | + |
| 24 | +## Installation |
| 25 | + |
| 26 | +To integrate the Filament Laravel Pulse package into your project, use Composer: |
| 27 | + |
| 28 | +```bash |
| 29 | +composer require dotswan/filament-laravel-pulse |
| 30 | +``` |
| 31 | + |
| 32 | +Filament Laravel Pulse can be configured to suit your application's specific needs. |
| 33 | +After installing the package, publish the configuration file using Artisan: |
| 34 | + |
| 35 | +```bash |
| 36 | +php artisan vendor:publish --provider="Dotswan\FilamentLaravelPulse\FilamentLaravelPulseServiceProvider" |
| 37 | +``` |
| 38 | + |
| 39 | +## Basic Usage |
| 40 | + |
| 41 | +To start using Filament Laravel Pulse, follow these steps: |
| 42 | + |
| 43 | +1. **Create a Custom Filament Page:** Extend the default Filament dashboard by creating a custom page. You can define your custom dashboard class and extend `app/Filament\Pages\Dashboard`. |
| 44 | + |
| 45 | +2. **Define Widgets:** Inside your custom dashboard class, define which widgets to include. Use the provided Pulse widgets (PulseCache, PulseExceptions, etc.) to display relevant metrics. |
| 46 | + |
| 47 | +```php |
| 48 | + |
| 49 | +<?php |
| 50 | + |
| 51 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseCache; |
| 52 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseExceptions; |
| 53 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseQueues; |
| 54 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseServers; |
| 55 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseSlowOutGoingRequests; |
| 56 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseSlowQueries; |
| 57 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseSlowRequests; |
| 58 | +use Dotswan\FilamentLaravelPulse\Widgets\PulseUsage; |
| 59 | +use Filament\Actions\Action; |
| 60 | +use Filament\Actions\ActionGroup; |
| 61 | +use Filament\Pages\Dashboard\Concerns\HasFiltersAction; |
| 62 | +use Filament\Support\Enums\ActionSize; |
| 63 | + |
| 64 | +class Dashboard extends \Filament\Pages\Dashboard |
| 65 | +{ |
| 66 | + use HasFiltersAction; |
| 67 | + |
| 68 | + public function getColumns(): int|string|array |
| 69 | + { |
| 70 | + return 12; |
| 71 | + } |
| 72 | + |
| 73 | + protected function getHeaderActions(): array |
| 74 | + { |
| 75 | + return [ |
| 76 | + ActionGroup::make([ |
| 77 | + Action::make('1h') |
| 78 | + ->action(fn() => $this->redirect(route('filament.manager.pages.dashboard'))), |
| 79 | + Action::make('24h') |
| 80 | + ->action(fn() => $this->redirect(route('filament.manager.pages.dashboard', ['period' => '24_hours']))), |
| 81 | + Action::make('7d') |
| 82 | + ->action(fn() => $this->redirect(route('filament.manager.pages.dashboard', ['period' => '7_days']))), |
| 83 | + ]) |
| 84 | + ->label(__('Filter')) |
| 85 | + ->icon('heroicon-m-funnel') |
| 86 | + ->size(ActionSize::Small) |
| 87 | + ->color('gray') |
| 88 | + ->button() |
| 89 | + ]; |
| 90 | + } |
| 91 | + |
| 92 | + public function getWidgets(): array |
| 93 | + { |
| 94 | + return [ |
| 95 | + PulseServers::class, |
| 96 | + PulseCache::class, |
| 97 | + PulseExceptions::class, |
| 98 | + PulseUsage::class, |
| 99 | + PulseQueues::class, |
| 100 | + PulseSlowQueries::class, |
| 101 | + PulseSlowRequests::class, |
| 102 | + PulseSlowOutGoingRequests::class |
| 103 | + ]; |
| 104 | + } |
| 105 | +} |
| 106 | +``` |
| 107 | + |
| 108 | +Example Configuration |
| 109 | + |
| 110 | +Here's an example of what you might find in the published filament-laravel-pulse.php configuration file: |
| 111 | + |
| 112 | +```php |
| 113 | +<?php |
| 114 | + |
| 115 | +return [ |
| 116 | + 'components' => [ |
| 117 | + // Customize and configure your monitoring widgets here |
| 118 | + 'cache' => [ |
| 119 | + 'columnSpan' => [ |
| 120 | + 'md' => 5, |
| 121 | + 'xl' => 5, |
| 122 | + ], |
| 123 | + 'cols' => 'full', |
| 124 | + 'ignoreAfter' => '1 hour', |
| 125 | + 'isDiscovered' => true, |
| 126 | + 'isLazy' => true, |
| 127 | + 'sort' => null, |
| 128 | + 'canView' => true, |
| 129 | + 'columnStart' => [], |
| 130 | + ], |
| 131 | + // Define more components as needed |
| 132 | + ], |
| 133 | +]; |
| 134 | + |
| 135 | +``` |
| 136 | +Modify the array under 'components' to adjust settings for each monitoring widget provided by Filament Laravel Pulse. |
| 137 | + |
| 138 | +## License |
| 139 | + |
| 140 | +This package is distributed under the [MIT License](link-to-your-license). |
| 141 | + |
| 142 | +## Security |
| 143 | + |
| 144 | +Security is a priority for us. If you encounter any security-related issues or vulnerabilities, please report them via our [GitHub issue tracker ][link-github-issue]. For direct communication, reach out to [[email protected]](mailto:[email protected]). |
| 145 | + |
| 146 | +## Contribution |
| 147 | + |
| 148 | +Contributions are welcome and valued. Enhancements, suggestions, and bug reports help improve this package for everyone. Here's how you can contribute: |
| 149 | + |
| 150 | +1. Fork the Project |
| 151 | +2. Create a Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 152 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 153 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 154 | +5. Open a Pull Request |
| 155 | + |
| 156 | +Thank you for considering contributing to the Filament Laravel Pulse! |
| 157 | + |
| 158 | +[ico-version]: https://img.shields.io/packagist/v/dotswan/filament-laravel-pulse.svg?style=flat-square |
| 159 | +[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square |
| 160 | +[ico-downloads]: https://img.shields.io/packagist/dt/dotswan/filament-laravel-pulse.svg?style=flat-square |
| 161 | + |
| 162 | +[link-packagist]: https://packagist.org/packages/dotswan/filament-laravel-pulse |
| 163 | +[link-license]: https://github.com/dotswan/filament-laravel-pulse/blob/master/LICENSE.md |
| 164 | +[link-downloads]: https://packagist.org/packages/dotswan/filament-laravel-pulse |
| 165 | +[link-github-issue]: https://github.com/dotswan/filament-laravel-pulse/issues |
0 commit comments