README

Laravel Logstash Log Channel

Elastic Logstash log channel for Laravel apps. Every log record is formatted with Monolog's LogstashFormatter and posted as JSON to a Logstash HTTP input, through a queued job by default.

Compatibility

Installation

composer require tomatophp/laravel-logstash

The service provider is auto-discovered and registers a logstash log channel. Add the Logstash HTTP input URL (host with port) to your .env and use the channel:

LOGSTASH_HOST=https://logstash.example.com:8080
LOG_CHANNEL=logstash

To keep your local log file as well, add logstash to the stack channel instead:

LOG_CHANNEL=stack
LOG_STACK=single,logstash

When LOGSTASH_HOST is empty nothing is sent. A failing or unreachable Logstash never throws, so logging can not break your app.

Queue

Records are sent by the TomatoPHP\LaravelLogstash\Jobs\NotifyLogstash job, so run a queue worker (or use the sync queue). To send directly over HTTP during the request, set LOGSTASH_QUEUE=false.

Configuration

You can publish the config file with:

php artisan vendor:publish --tag="laravel-logstash-config"

To customise the channel, define it yourself in config/logging.php; the package will not overwrite it. Channel keys override the package config:

'logstash' => [
    'driver' => 'custom',
    'via' => \TomatoPHP\LaravelLogstash\Logs\LogStashLogger::class,
    'url' => env('LOGSTASH_HOST'),
    'level' => 'error',
    'queue' => true,
    'queue_connection' => 'redis',
    'queue_name' => 'logs',
],

Changelog

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

Security

Please see SECURITY for more information about security.

Credits

• Fady Mondy

License

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

Testing

if you like to run PEST testing just use this command

composer test

Code Style

if you like to fix the code style just use this command

composer format

PHPStan

if you like to check the code by PHPStan just use this command

composer analyse

Other Filament Packages

Checkout our Awesome TomatoPHP