enklare-development / laravel-gelf-logger
Fork of the hedii/laravel-gelf-logger project with extended support for HttpTransport
Requires
- php: ^7.2
- graylog2/gelf-php: ^1.6
- illuminate/log: >=6
Requires (Dev)
- orchestra/testbench: ^5.0
README
Fork of the hedii/laravel-gelf-logger project with support for HttpTransport.
Links to original project:
- Github: https://github.com/hedii/laravel-gelf-logger
- Packagist: https://packagist.org/packages/hedii/laravel-gelf-logger
This projects packagist page
https://packagist.org/packages/enklare-development/laravel-gelf-logger
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.
It uses the new Laravel custom log channel introduced in Laravel 5.6.
A gelf receiver like graylog2 must be configured to receive messages with a GELF UDP or TCP Input.
Table of contents
Installation
Install via composer
composer require enklare-development/laravel-gelf-logger
Edit config/logging.php
to add the new gelf
log channel.
return [ 'default' => env('LOG_CHANNEL', 'stack'), 'channels' => [ // You can use the gelf log channel with the stack log channel 'stack' => [ 'driver' => 'stack', 'channels' => ['daily', 'gelf'], ], // other log channels... 'gelf' => [ 'driver' => 'custom', 'via' => \Hedii\LaravelGelfLogger\GelfLoggerFactory::class, // This optional option determines the processors that should be // pushed to the handler. This option is useful to modify a field // in the log context (see NullStringProcessor), or to add extra // data. Each processor must be a callable or an object with an // __invoke method: see monolog documentation about processors. // Default is an empty array. 'processors' => [ \Hedii\LaravelGelfLogger\Processors\NullStringProcessor::class, \Foo\Bar\AnotherProcessor::class, ], // This optional option determines the minimum "level" a message // must be in order to be logged by the channel. Default is 'debug' 'level' => 'debug', // This optional option lets you control if you wish to send "level" and higher // to gelf, or only filter out "level" messages (ex: WARNING, ERROR, CRITICAL or only WARNING and not any other levels) 'filtered_handler' => false, // This optional option determines the channel name sent with the // message in the 'facility' field. Default is equal to app.env // configuration value 'name' => 'my-custom-name', // This optional option determines the system name sent with the // message in the 'source' field. When forgotten or set to null, // the current hostname is used. 'system_name' => null, // This optional option determines if you want the TCP or HTTP transport // for the gelf log messages. Default is UDP 'transport' => 'udp', // This optional option determines the host that will receive the // gelf log messages. Default is 127.0.0.1 'host' => '127.0.0.1', // This optional option determines the api endpoint path that receives // gelf log messages. Default is '/' 'path' => '/', // This optional option determines the port on which the gelf // receiver host is listening. Default is 12201 'port' => 12201, // This optional option determines the maximum length per message // field. When forgotten or set to null, the default value of // \Monolog\Formatter\GelfMessageFormatter::DEFAULT_MAX_LENGTH is // used (currently this value is 32766) 'max_length' => null, // This optional option determines the prefix for 'context' fields // from the Monolog record. Default is null (no context prefix) 'context_prefix' => null, // This optional option determines the prefix for 'extra' fields // from the Monolog record. Default is null (no extra prefix) 'extra_prefix' => null, ], ], ];
Usage
Once you have modified the Laravel logging configuration, you can use the gelf log channel as any Laravel log channel.
Examples
// Explicitly use the gelf channel Log::channel('gelf')->debug($message, ['foo' => 'bar']); Log::channel('gelf')->emergency($message, ['foo' => 'bar']); // In case of a stack log channel containing the gelf log channel and stack // configured as the default log channel Log::notice($message, ['foo' => 'bar']); // Using the logger helper logger($message, $context);
Testing
composer test
License
laravel-gelf-logger is released under the MIT Licence. See the bundled LICENSE file for details.