Skip to content

This Laravel package can be used to add an healthcheck route on your projects in order to be able to monitor the status of the application through automatic means

License

Notifications You must be signed in to change notification settings

ZanichelliEditore/health-check

Repository files navigation

Build Status codecov

Healthcheck Laravel

Introduction

This package has the purpose to add in laravel project an api route (/api/health).

There are various possible system checks:

  • Database status (db)
  • Availability local filesystem (filesystem.local)
  • Aws S3 filesystem connection (filesystem.s3)

Installation

First install laravel project if you don't have yet.

Then install healthcheck package using composer:

cd laravel-project
composer require zanichelli/healthcheck

Follow the template-file to include param about the package.

Note: Default config vaule is null

Customization

It is possible edit package configurations:

php artisan vendor:publish --tag=config #create package config file inside own config folder
php artisan vendor:publish --tag=resources #publish messages views inside resources folder

Add params in config file (healthcheck.php) to add more db connections or s3 bucket connections , e.g.:

    'db' => [
        [
            'connection' => env('DB_CONNECTION', null)
        ],
        [
            'connection' => env('ORACLE_CONNECTION', null)
        ],
        [
            'connection' => env('REDIS_CONNECTION', null)
        ]
    ],

About

This Laravel package can be used to add an healthcheck route on your projects in order to be able to monitor the status of the application through automatic means

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages