eXolnet / laravel-graylog

This package extends Laravel’s log package to add a graylog channel.
MIT License
7 stars 2 forks source link
hacktoberfest laravel laravel-package php

laravel-graylog

Latest Stable Version Software License Build Status Total Downloads

This package extends Laravel’s log package to add a graylog driver.

Installation

  1. Require this package with composer:

    composer require exolnet/laravel-graylog
  2. If you don't use package auto-discovery, add the service provider to the providers array in config/app.php:

    Exolnet\Graylog\GraylogServiceProvider::class
  3. Add a graylog channel in your logging.php configuration file:

    'graylog' => [
        'driver' => 'graylog',
        'level' => 'notice',
        'handler_with' => [
            'transport' => env('LOG_GRAYLOG_TRANSPORT', 'udp'),
            'host' => env('LOG_GRAYLOG_HOST', 'localhost'),
            'port' => env('LOG_GRAYLOG_PORT', 12201),
            'path' => env('LOG_GRAYLOG_PATH', '/gelf'),
            'extra' => [
                //
            ]
        ],
    ],
  4. Change your LOG_CHANNEL for graylog or add it to your stack in the logging.php configuration file

Usage

Supported Transports

The following transports are supported: udp, tcp, ssl, http and https. Select the transport accordingly to your Graylog set up using the GRAYLOG_TRANSPORT configuration. By default, the udp transport is used.

The default path for http and https transports is /gelf. This value can be configured using the GRAYLOG_PATH configuration.

GRAYLOG_PATH=/gelf

Testing

To run the phpUnit tests, please use:

composer test

Contributing

Please see CONTRIBUTING and CODE OF CONDUCT for details.

Security

If you discover any security related issues, please email security@exolnet.com instead of using the issue tracker.

Credits

License

This code is licensed under the MIT license. Please see the license file for more information.