nWidart / laravel-actuator

Add health endpoints to your applications

Laravel Actuator

Laravel-Actuator is a package that will provide endpoint to monitor the status of your application and its dependencies (database, cache, etc.). Custom contributors can be added and customised.

Example usage would be with Kubernetes readiness and liveliness probes.

This package has been heavily inspired by the Spring Boot Actuator project.

Installation

You can install the package via composer:

composer require nwidart/laravel-actuator

The package will automatically register a service provider and alias.

Optionally, publish the package's configuration file by running:

php artisan vendor:publish --provider="Nwidart\Actuator\LaravelActuatorServiceProvider"

Usage

New endpoints will be available:

/actuator/health

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Nicolas Widart
• All Contributors

License

The MIT License (MIT). Please see License File for more information.