io-digital/health-check

A Laravel package that performs health checks on your application

HealthCheck

![Software License][ico-license] , _(*1)

HealthCheck provides your Laravel application with a /healthcheck endpoint to make it easier nice and easy to view the status of your application., _(*2)

Install

supports package auto discovery for Laravel, _(*3)

Via Composer, _(*4)

``` bash $ composer require io-digital/health-check, <sub>(*5)</sub>

Add the ServiceProvider to your config/app.php providers array:

``` php
IoDigital\HealthCheck\HealthCheckServiceProvider::class,

Then run the following command artisan command:, <sub>(*6)</sub>

$ php artisan vendor:publish --provider="IoDigital\HealthCheck\HealthCheckServiceProvider" 

This will publish the package config file to config/healthcheck.php., <sub>(*7)</sub>

You currently have the options to select which tests to perform:, <sub>(*8)</sub>

'ssl' => true,
'database' => true,
'application' => true,

//System information
'memory' => false,
'cpu_usage' => false,

Usage

The package automatically adds the /healthcheck endpoint to your application. All you need to do is hit that route., <sub>(*9)</sub>

For now the endpoint returns the following:, <sub>(*10)</sub>

• 200 reponse
• JSON object with the following layout:

{
    "application": {
        "message": "Application is running",
        "success": true
    },
    "database": {
        "message": "There was an error connecting to the database. Error has been logged.",
        "success": false
    },
    "ssl": {
        "message": "SSL is working.",
        "success": true 
    }
}

Future releases will hope to expand on what is tested., <sub>(*11)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*12)</sub>

Testing

bash $ composer test, <sub>(*13)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*14)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*15)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*16)</sub>