cxj/laravel-looking-glass-client

Easy to use Laravel client for the Looking Glass monitoring application.

0.3.0 2023-03-06 23:56 UTC

README

Latest Version on Packagist GitHub Tests Action Status StyleCI Total Downloads

This is an easy to use Laravel client for the Looking Glass application status and health monitoring web application. This package makes it easy for any Laravel application to report any status or health data to Looking Glass.

Installation

You can install the package via composer:

composer require cxj/laravel-looking-glass-client

You can publish the config file with:

php artisan vendor:publish --tag="laravel-looking-glass-client-config"

This is the contents of the published config file:

return [
    'url'    => env('LOOKING_GLASS_URL', 'localhost:8000/api/webhook'),
    'secret' => env('LOOKING_GLASS_SECRET', 'shared-secret'),
];

Usage

$result = Cxj\Result::make('Test message from your application');

$glass = new Cxj\LookingGlass();
$glass->transmit('Name of Test or Status', $result);

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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