Unable to extend to Default Log Type laravel.

[DrianeDiojanPerez]

I'm trying to extend the Laravel type to include method, route, user id, and email but it returns them as empty.

App/Provider/AppServiceProvider

<?php

namespace App\Providers;

use App\Helpers\CustomizeFormatterLog;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\ServiceProvider;
use Opcodes\LogViewer\Facades\LogViewer;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        //
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        LogViewer::extend('laravel', CustomizeFormatterLog::class);
        JsonResource::withoutWrapping();

        //
    }
}

My Custom Log Class:

<?php
namespace App\Helpers;

use Opcodes\LogViewer\Logs\LaravelLog;

class CustomizeFormatterLog extends LaravelLog
{
    public static string $regex = '/\[(?P<datetime>[^\]]+)\] \[(?P<method>\w+)\] \[(?P<route>\S+)\] \[(?P<user_id>\d+)\] \[(?P<email>\S+)\] (?P<environment>\S+)\.(?P<level>\S+): (?P<message>.+)/';
    public static array $columns = [
        ['label' => 'Security', 'data_path' => 'level'],
        ['label' => 'Datetime', 'data_path' => 'datetime'],
        ['label' => 'Env', 'data_path' => 'extra.environment'],
        ['label' => 'Method', 'data_path' => 'context.method'],
        ['label' => 'Route', 'data_path' => 'context.route'],
        ['label' => 'Id', 'data_path' => 'context.user_id'],
        ['label' => 'Email', 'data_path' => 'context.email'],
        ['label' => 'Message', 'data_path' => 'message'],
    ];
    protected function fillMatches(array $matches = []): void
    {
        // The parent class already handles the "datetime", "level" and "message" matches. But you're free to assign them yourself.
        // If you added custom regex named groups, you'll have to assign them to the `$this->context` array below.

        parent::fillMatches($matches);

        $this->context = [
            'method' => $matches['method'] ?? '',
            'route' => $matches['route'] ?? '',
            'user_id' => $matches['user_id'] ?? '',
            'email' => $matches['email'] ?? '',
        ];

    }

}

LogView

the $match return

["[2023-12-26T17:34:23.379135+00:00] [GET] [menu\/section\/4\/create]  [[email protected]] local.INFO: In Function App\\Http\\Controllers\\MenuSectionController::create [Line:32]",
"2023-12-26T17:34:23.379135+00:00",
"379135+00:00",
"+00:00",
" [GET] [menu\/section\/4\/create]  [[email protected]] local.",
"local",
"INFO",
"In Function App\\Http\\Controllers\\MenuSectionController::create [Line:32]"]

My regex:
https://regexr.com/7pnmb

and My logs:

[2023-12-26T17:34:23.379135+00:00] [GET] [menu/section/4/create] [102] [[email protected]] local.INFO: In Function App\Http\Controllers\MenuSectionController::create [Line:32]
[2023-12-26T17:34:23.394217+00:00] [GET] [menu/section/4/create] [102] [[email protected]] local.INFO: Collecting aLL GET Routes without sanctum and api in URL
[2023-12-26T17:34:23.394528+00:00] [GET] [menu/section/4/create] [102] [[email protected]] local.INFO: Collection of all GET Routes completed.

[arukompas]

@DrianeDiojanPerez hey!

Extending Laravel logs is a bit tricky at the moment, I just realised I didn't have extendability in mind when first creating Laravel log parser.

If you look at the original Laravel parser here, and the Regex it actually ends up using, it's quite different from the rest of the log parsers (which are usually simpler and single-line).

My suggestion - extend the Opcodes\LogViewer\Logs\Log class instead of the LaravelLog. This way your custom regex will work as expected. It might not work well with all of the Laravel logs, though, such as logged mails or exceptions. You should test it with your set up, I don't have your specific log configuration.

Otherwise, if you're feeling brave, then you should still extend the LaravelLog class and then look at overriding the regexPattern() and parseText() methods.

Let me know how it goes!

[darkvovich]

How to extend log files? Doc https://log-viewer.opcodes.io/docs/3.x/log-types/custom not helped.

1. I'm create app/Helpers/WordpressLog.php file

namespace App\Helpers;

use Opcodes\LogViewer\Logs\Log;

class WordpressLog extends Log
{
    public static string $name = 'WordPress';
    public static string $regex = '/\[(?<datetime>.*?)\] (?<type>.*?) (?<level>.*?): (?<message>.*)/';
    public function fillMatches(array $matches = []): void
    {
        // The parent class already handles the "datetime", "level" and "message" matches. But you're free to assign them yourself.
        // If you added custom regex named groups, you'll have to assign them to the `$this->context` array below.
        parent::fillMatches($matches);
        $this->context = [
            'type' => $matches['type']
        ];
    }
}

2. I'm create app/Providers/WordpressLogServiceProvider.php file

namespace App\Helpers;

use Opcodes\LogViewer\Logs\Log;

class WordpressLog extends Log
{
    public static string $name = 'WordPress';
    public static string $regex = '/\[(?<datetime>.*?)\] (?<type>.*?) (?<level>.*?):\s+(?<message>.*)/';
    public function fillMatches(array $matches = []): void
    {
        // The parent class already handles the "datetime", "level" and "message" matches. But you're free to assign them yourself.
        // If you added custom regex named groups, you'll have to assign them to the `$this->context` array below.
        parent::fillMatches($matches);
        $this->context = [
            'type' => $matches['type']
        ];
    }
}

3. Add service provider to config/app.php

My custom log shown in Select but NOT load file!

Regexp tested with string:
[12-Sep-2024 13:02:17 UTC] PHP Warning: Undefined array key 0 in /wp-includes/class-wp-query.php on line 3766