hedii/laravel-gelf-logger

A package to send logs to a gelf compatible backend like graylog

1.0.5 2017-07-11 07:28 UTC

README

Build Status

Laravel Gelf Logger

A package to send gelf logs to a gelf compatible backend like graylog. It is a laravel wrapper for bzikarsky/gelf-php package.

Table of contents

Installation

Install via composer

composer require hedii/laravel-gelf-logger

Add it to your providers array in config/app.php:

Hedii\LaravelGelfLogger\LaravelGelfLoggerServiceProvider::class

If you want to use the facade, add it to your aliases array in config/app.php:

'GelfLogger' => \Hedii\LaravelGelfLogger\Facades\GelfLogger::class

Publish the configuration file:

php artisan vendor:publish --provider="Hedii\LaravelGelfLogger\LaravelGelfLoggerServiceProvider"

See the content of the published configuration file in config/gelf-logger.php if you want to change the defaults.

/**
 * The ip address of the log server. If the value below is null,
 * the default value '127.0.0.1' will be used.
 */
'host' => null,

/**
 * The udp port of the log server. If the value below is null,
 * the default value 12201 will be used.
 */
'port' => null

Usage

See the bzikarsky/gelf-php examples in his repo to find the available methods for the gelf() function.

Example

gelf()->alert('There was a foo in bar', ['foo' => 'bar']);
try {
    throw new \Exception('test exception');
} catch (\Exception $e) {
    gelf()->emergency('Exception example', [
        'exception' => $e
    ]);
}

Testing

composer test

License

laravel-gelf-logger is released under the MIT Licence. See the bundled LICENSE file for details.