https://github.com/oved-php/health-checks
Laravel health checker
https://github.com/oved-php/health-checks
Last synced: about 1 year ago
JSON representation
Laravel health checker
- Host: GitHub
- URL: https://github.com/oved-php/health-checks
- Owner: OveD-php
- License: mit
- Created: 2017-02-12T19:43:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T00:46:44.000Z (about 4 years ago)
- Last Synced: 2025-04-25T05:38:51.858Z (about 1 year ago)
- Language: PHP
- Size: 574 KB
- Stars: 37
- Watchers: 1
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Health Checks
[](https://travis-ci.org/phpsafari/health-checks)
Add health checks to your Laravel applications with this package.
## Examples
## Install
First, use Composer to install this package.
```bash
$ composer require phpsafari/health-checks
```
After the package has been installed, go ahead and add ``PhpSafari\ServiceProvider\HealthCheckServiceProvider::class` to your `config/app.php` file.
After doing this, you can publish the `health.php` configuration file into your `config` folder by running:
```bash
$ php artisan vendor:publish --tag=health
```
## Usage
Inside the `config/health.php` file is where you configure all your available health checks. By default, this package comes packed with a few checks already:
* `CorrectEnvironment` will check if your application's environment is set to `production`
* `DatabaseOnline` will check your database connection
* `DatabaseUpToDate` will check if your application has any migrations that hasn't been migrated yet
* `DebugModeOff` will check if debug mode is off
* `QueueProcessing` will check if the queue is running and jobs are getting processed
* `PathIsWritable` will check if a provided path is writable
* `LogLevel` will check if log level is set to the given value
* `MaxRatioOf500Responses` will check if the ratio of 500 response are above a given threshold (The last 60 min)
* `MaxResponseTimeAvg` will check if average response time for all request are above a given threshold (The last 60 min)
To run a health check of your application, run:
```bash
$ php artisan health:check
```
You can also use Laravel's scheduler to schedule your health checks:
```php
$schedule->command('health:check')->hourly();
```
### Url based health checks
You can also run a health check by hitting the `https:///_health` url in a browser or with a tool like Pingdom.
**Note:** _This feature can be disabled in the `config/health.php` file, by setting `route.enabled` to `false`.
You can navigate to `https:///_health/stats` and get all stats, including avg response time,
### Creating your own health checks
In order to create your own health checks, you just need to extend the `PhpSafari\Checks\HealthCheck` class and implement the `run()` method.
**Example:**
```php
class IsFriday extends PhpSafari\Checks\HealthCheck
{
public function run(): bool
{
return Carbon::now()->isFriday();
}
}
```
Then add `new IsFriday()` to the list of checks in `config/health.php`.
## Testing
``` bash
$ phpunit tests/
```
## Security
If you discover any security related issues, please email :author_email instead of using the issue tracker.
## Credits
- [Visti Kløft](https://github.com/vistik)
- [Peter Suhm](https://github.com/petersuhm)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.