Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renoki-co/laravel-healthchecks
Laravel Healthchecks is a simple controller class that helps you build your own healthchecks endpoint without issues.
https://github.com/renoki-co/laravel-healthchecks
controller healthcheck healthchecks healthchecks-endpoint laravel laravel-healthchecks php routes server web
Last synced: about 11 hours ago
JSON representation
Laravel Healthchecks is a simple controller class that helps you build your own healthchecks endpoint without issues.
- Host: GitHub
- URL: https://github.com/renoki-co/laravel-healthchecks
- Owner: renoki-co
- License: apache-2.0
- Created: 2020-05-15T06:12:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T05:21:39.000Z (7 months ago)
- Last Synced: 2024-10-25T19:58:08.238Z (20 days ago)
- Topics: controller, healthcheck, healthchecks, healthchecks-endpoint, laravel, laravel-healthchecks, php, routes, server, web
- Language: PHP
- Homepage:
- Size: 99.6 KB
- Stars: 55
- Watchers: 4
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Laravel Healthchecks
====================
[](https://codecov.io/gh/renoki-co/laravel-healthchecks/branch/master)
[](https://github.styleci.io/repos/264111394)
[](https://packagist.org/packages/renoki-co/laravel-healthchecks)
[](https://packagist.org/packages/renoki-co/laravel-healthchecks)
[](https://packagist.org/packages/renoki-co/laravel-healthchecks)
[](https://packagist.org/packages/renoki-co/laravel-healthchecks)
Laravel Healthchecks is a simple controller class that helps you build your own healthchecks endpoint without issues.
## 🤝 Supporting
**If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with [Github Sponsors](https://github.com/sponsors/rennokki). 📦**
[
](https://github-content.renoki.org/github-repo/31)
## 🚀 Installation
You can install the package via composer:
```bash
composer require renoki-co/laravel-healthchecks
```
## 🙌 Usage
First of all, you should create your own Controller for healthchecks, that extends the `RenokiCo\LaravelHealthchecks\Http\Controllers\HealthcheckController`.
``` php
use Illuminate\Http\Request;
use RenokiCo\LaravelHealthchecks\Http\Controllers\HealthcheckController;
class MyHealthcheckController extends HealthcheckController
{
/**
* Register the healthchecks.
*
* @param \Illuminate\Http\Request $request
* @return void
*/
public function registerHealthchecks(Request $request)
{
$this->addHealthcheck('mysql', function (Request $request) {
// Try testing the MySQL connection here
// and return true/false for pass/fail.
return true;
});
}
}
```
```php
// In your routes
Route::get('/healthcheck', [MyHealthcheckController::class, 'handle']);
```
## Registering healthchecks
Within the controller, you should register the healthchecks closures in the `registerHealthchecks` method, like the example stated above.
You can add as many healthchecks as you want.
```php
public function registerHealthchecks(Request $request)
{
$this->addHealthcheck('mysql', function (Request $request) {
//
});
$this->addHealthcheck('redis', function (Request $request) {
//
});
$this->addHealthcheck('some_check', function (Request $request) {
//
});
$this->addHealthcheck('another_check_here', function (Request $request) {
//
});
}
```
## Status Codes
In case of failure, the response is `500`. For all successful responses, the status code is `200`.
To change the http codes being sent out, specify this in your `registerHealthchecks` method:
```php
public function registerHealthchecks(Request $request)
{
$this->setPassingHttpCode(203);
$this->setFailingHttpCode(403);
$this->addHealthcheck('mysql', function (Request $request) {
return true;
});
}
```
## Outputs
By default, the output will be `OK` or `FAIL` as string, but in case you want to debug the healthchecks, you can get a JSON with each registered healthchecks and their pass/fail closures.
You have just to call `withOutput()`:
```php
public function registerHealthchecks(Request $request)
{
$this->withOutput();
$this->addHealthcheck('mysql', function (Request $request) {
return true;
});
$this->addHealthcheck('redis', function (Request $request) {
return false;
});
}
```
The output in the browser would be like this:
```json
{
"mysql": true,
"redis": false
}
```
## 🐛 Testing
``` bash
vendor/bin/phpunit
```
## 🤝 Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## 🔒 Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## 🎉 Credits
- [Alex Renoki](https://github.com/rennokki)
- [All Contributors](../../contributors)