nwidart/laravel-actuator

Actuator endpoints let you monitor and interact with your application.

dev-master / 1.0.x-dev 2019-11-15 19:54 UTC

This package is auto-updated.

Last update: 2024-10-16 06:19:51 UTC


README

Latest Version on Packagist Software License Build Status Scrutinizer Coverage Quality Score Total Downloads

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 n.widart@gmail.com instead of using the issue tracker.

Credits

License

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