[FEATURE] Log filter

[aivis]

Log filter

The Understand service provider utilises the event dispatcher (MessageLogged event) to capture and deliver logs. This makes it impossible to filter specific log types at the application level even if a custom Laravel log driver is created (the event dispatcher still fires the event).

A good use case example for this is to filter out PHP8 deprecation warnings.

Example filter class

<?php
// config (understand-laravel.php)
'log_filter' => \App\Logging\UnderstandLogFilter::class,

// a hypothetical filter class
<?php

declare(strict_types=1);

namespace App\Logging;

use Illuminate\Support\Str;

class UnderstandLogFilter
{
    public function __invoke($level, $message, $context): bool
    {
        if ($level === 'warning' && Str::contains(strtolower($message), 'deprecated')) {
            return true;
        }

        return false;
    }
}

Configuration details

The configuration value (filter) must be a callable type:

• https://www.php.net/manual/en/function.is-callable.php
  or a callable dependency from the service container:
• https://laravel.com/docs/9.x/container#the-make-method

The suggested way would be to create an invokable class since it's hard to serialise anonymous functions (Laravel config cache):

• https://www.php.net/manual/en/language.oop5.magic.php#object.invoke

The log (callable) filter interface is as follows: $callable($level, $message, $context).

The result of the filter must be a boolean value:

• TRUE, the log should be ignored and NOT delivered to Understand.io
• FALSE, the log should be delivered to Understand.io

The ignored_logs config value has higher precedence than log_filter.