shakvoort/lumen-health

A Lumen extension for providing API health endpoints

Maintainers

Details

bitbucket.org/svenhakvoort/lumen-health-api

Homepage

Source

Installs: 161

Dependents: 0

Suggesters: 0

Security: 0

v0.21.5 2019-04-08 13:01 UTC

MIT 14cdad4c2e82769262eae280c1e1476839c7b112

  • Sven Hakvoort <sven.hakvoort.woop@gmail.com>

apihealthlumenhealth-check

This package is auto-updated.

Last update: 2021-09-08 19:25:34 UTC

README

Lumen health API

A Lumen extension which adds health metrics on the /api/v1/health endpoint.

Currently the following metrics are available:

  • appKeyStatus: true if the app key is set and at least 32 characters long
  • storageWriteable: true if the storage folder and all its subfolders are writeable
  • debugMode: true if debug mode is on
  • databaseStatus: an object providing database metrics for each database defined in the connections config.
  • migrationsUpToDate: true if all migrations have been executed on the database
  • size: a string in the format x.xxMB specifying the used size of the database
  • online: true if a connection can be established to the database

Installation

Install the plugin using the following command

composer require shakvoort/lumen-health

After the installation make sure to uncomment the following line in your bootstrap/app.php: $app->withFacades();

Also make sure to register the service provider:

$app->register(\shakvoort\LumenHealth\LumenHealthServiceProvider::class);