https://github.com/shuvroroy/filament-spatie-laravel-health
Monitor the health of a Laravel application
https://github.com/shuvroroy/filament-spatie-laravel-health
Last synced: 16 days ago
JSON representation
Monitor the health of a Laravel application
- Host: GitHub
- URL: https://github.com/shuvroroy/filament-spatie-laravel-health
- Owner: shuvroroy
- License: mit
- Created: 2021-12-29T18:59:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T14:24:00.000Z (2 months ago)
- Last Synced: 2025-04-07T04:05:20.626Z (24 days ago)
- Language: PHP
- Homepage:
- Size: 253 KB
- Stars: 167
- Watchers: 2
- Forks: 32
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-filament - shuvroroy/filament-spatie-laravel-health - Monitor the health of a Laravel application using [`spatie/laravel-health`](https://github.com/spatie/laravel-health). (Integrations)
README
# Filament Spatie Laravel Health
[](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)
[](https://github.com/shuvroroy/filament-spatie-laravel-health/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)
[](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)
[](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)
This package provides a Filament page that you can monitor the health of your application by registering checks using the [spatie/laravel-health](https://spatie.be/docs/laravel-health/v1/introduction) package.
## Installation
You can install the package via composer:
```bash
composer require shuvroroy/filament-spatie-laravel-health
```
This package can store health check results [in various ways](https://spatie.be/docs/laravel-health/v1/storing-results/general). When using the EloquentHealthResultStore the check results will be stored in the database. To create the health_check_result_history_items table, you must create and run the migration.
```bash
php artisan vendor:publish --tag="health-migrations"
php artisan migrate
```
Publish the package's assets:
```bash
php artisan filament:assets
```
## Usage
You first need to register the plugin with Filament. This can be done inside of your `PanelProvider`, e.g. `AdminPanelProvider`.
```php
plugin(FilamentSpatieLaravelHealthPlugin::make());
}
}
```
Then register Health::checks on app/Providers/AppServiceProvider.php -> `boot` method
```php
plugin(
FilamentSpatieLaravelHealthPlugin::make()
->usingPage(HealthCheckResults::class)
);
}
}
```
## Customising who can access the page
You can customise who can access the `Hleath` page by adding an `authorize` method to the plugin.
The method should return a boolean indicating whether the user is authorised to access the page.
```php
plugin(
FilamentSpatieLaravelHealthPlugin::make()
->authorize(fn (): bool => auth()->user()->email === '[email protected]'),
);
}
}
```
## Upgrading
Please see [UPGRADE](UPGRADE.md) for details on how to upgrade 1.X to 2.0.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Shuvro Roy](https://github.com/shuvroroy)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.