Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svilborg/laravel-health
Laravel Health (MicroProfile Health Protocol)
https://github.com/svilborg/laravel-health
api health health-check healthcheck-endpoint healthcheck-protocol json laravel microprofile-health php
Last synced: about 2 months ago
JSON representation
Laravel Health (MicroProfile Health Protocol)
- Host: GitHub
- URL: https://github.com/svilborg/laravel-health
- Owner: svilborg
- License: mit
- Created: 2019-07-12T12:40:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T03:17:10.000Z (over 3 years ago)
- Last Synced: 2024-04-14T20:11:40.424Z (9 months ago)
- Topics: api, health, health-check, healthcheck-endpoint, healthcheck-protocol, json, laravel, microprofile-health, php
- Language: PHP
- Homepage:
- Size: 521 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Health Check
[](https://travis-ci.org/svilborg/laravel-health)
[](https://codecov.io/gh/svilborg/laravel-health)
[](https://scrutinizer-ci.com/g/svilborg/laravel-health)
[](https://packagist.org/packages/svilborg/laravel-health)
[](https://github.com/svilborg/laravel-health/blob/master/LICENSE)
Implementation of MicroProfile Health for Laravel
[MicroProfile Health Protocol](https://github.com/eclipse/microprofile-health/blob/master/spec/src/main/asciidoc/protocol-wireformat.adoc "Protocol")
### Configuration
Register the health check classes in config/health.php
```php
return [
/*
* |--------------------------------------------------------------------------
* | Health Checks
* |--------------------------------------------------------------------------
* |
*/
'checks' => [
[
'class' => \Health\Checks\NullCheck::class,
'params' => []
],
[
'class' => \Health\Checks\Servers\Database::class,
'params' => []
],
[
'class' => \Health\Checks\Filesystem\DiskSpace::class,
'params' => [
'path' => '/'
]
],
[
'class' => \Health\Checks\Env\Environment::class,
'params' => [
'APP_ENV' => 'testing'
]
]
]
];
```
Add the api route
```php
Route::get('/health', 'Health\Controllers\HealthController@check');
```
### Example Response Payload
```json
{
"status": "UP",
"checks": [
{
"name": "health-checks-null-check",
"status": "UP",
"data": []
},
{
"name": "health-checks-filesystem-disk-space",
"status": "UP",
"data": {
"free_bytes": 119100669952,
"free_human": "110.92 GB",
"path": "/",
"threshold": 100000000
}
},
{
"name": "health-checks-env-environment",
"status": "UP",
"data": {
"variable": "APP_ENV",
"value": "testing",
"value_expected": "testing"
}
},
{
"name": "health-checks-filesystem-directory-is-readable",
"status": "UP",
"data": {
"paths": [
"../tests"
]
}
},
{
"name": "health-checks-filesystem-file-is-readable",
"status": "UP",
"data": {
"files": [
"TestCase.php"
]
}
}
]
}
```
### Custom Health Check
```php
use Health\Checks\BaseCheck;
use Health\Checks\HealthCheckInterface;
class ServiceACheck extends BaseCheck implements HealthCheckInterface
{
/**
*
* {@inheritdoc}
* @see \Health\Checks\HealthCheckInterface::call()
*/
public function call()
{
$health = $this->getBuilder('Service A');
if(!$this->serviceA->connect()) {
$health->withData('error', 'Service A Failed')
->down();
}
else {
$health->up();
}
return $health->build();
}
}
```
### Health Check Cli Command
$ php artisan health
✔ UP Health State
==============================
✔ UP health-checks-null-check
✔ UP health-checks-filesystem-disk-space {"free_bytes":119302803456,"free_human":"111.11 TB","path":"\/tmp","threshold":100000000}
✔ UP health-checks-env-environment {"variable":"APP_ENV","value":"testing","value_expected":"testing"}
✔ UP health-checks-filesystem-directory-is-readable {"paths":[".\/tests"]}
✔ UP health-checks-filesystem-file-is-readable {"files":[".\/tests\/TestCase.php"]}