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: 1 day 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 (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-06T09:32:27.000Z (16 days ago)
• Last Synced: 2024-12-13T20:07:38.812Z (8 days ago)
• Language: PHP
• Homepage:
• Size: 266 KB
• Stars: 161
• Watchers: 2
• Forks: 26
• 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

[![PHP Version Require](https://poser.pugx.org/shuvroroy/filament-spatie-laravel-health/require/php)](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/shuvroroy/filament-spatie-laravel-health/run-tests.yml?branch=main&label=tests)](https://github.com/shuvroroy/filament-spatie-laravel-health/actions?query=workflow%3Arun-tests+branch%3Amain)

[![Latest Stable Version](https://poser.pugx.org/shuvroroy/filament-spatie-laravel-health/v)](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)

[![Total Downloads](https://poser.pugx.org/shuvroroy/filament-spatie-laravel-health/downloads)](https://packagist.org/packages/shuvroroy/filament-spatie-laravel-health)

[![License](https://poser.pugx.org/shuvroroy/filament-spatie-laravel-health/license)](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)

            );

    }

}

```

## 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.