Missing Columns on Custom Formatter

[jfvoliveira]

Hey there. I am trying to create a custom log formatter but I am hitting a wall that I cannot overcome and I need help.

Regex link: https://regexr.com/7omeu

This is my custom log:

class LogViewerCustom extends Log
{
    public static string $name = 'Custom';

    public static string $regex = '/^\[(?P<datetime>[\d\-+ :]+)\] \[(?P<env>\w+)\.(?P<level>\w+)\] \[(?P<code>.{5})\] (?P<message>.+)\s(?P<payload>\{.*\})?$/';

    /** @var array|string[][] */
    public static array $columns = [
        ['label' => 'Level', 'data_path' => 'level'],
        ['label' => 'Date/Time', 'data_path' => 'datetime'],
        ['label' => 'Env', 'data_path' => 'env'],
        ['label' => 'Code', 'data_path' => 'code'],
        ['label' => 'Message', 'data_path' => 'message'],
        ['label' => 'Payload', 'data_path' => 'payload'],
    ];
}

and this is the laravel.log:

[2023-12-07 04:24:02] [local.ERROR] [12345] error {"message":"oops"}
[2023-12-07 04:21:59] [local.INFO] [ABCDE] some info {"info":"some"}
[2023-12-07 04:24:02] [local.INFO] [ABCDE] here be dragons {"name":"Smaug"}
[2023-12-07 04:24:02] [local.DEBUG] [DBG01] no payload  
[2023-12-07 04:24:02] [local.DEBUG] [DBG01] payload {"foo":"bar"}

This is the result:

No data on Env nor Code. And the Payload column is missing. But the log row is read correctly:

But if I do a dd on the fillMatches method

protected function fillMatches(array $matches = []): void
{
    parent::fillMatches($matches);
    
    dd($matches);
}

I get (on the Dev Tools response):

array:11 [ // app\Logging\LogViewerCustom.php:27
  0 => "[2023-12-07 04:24:02] [local.DEBUG] [DBG02] payload {"foo":"bar"}"
  "datetime" => "2023-12-07 04:24:02"
  1 => "2023-12-07 04:24:02"
  "env" => "local"
  2 => "local"
  "level" => "DEBUG"
  3 => "DEBUG"
  "code" => "DBG02"
  4 => "DBG02"
  "message" => "payload {"foo":"bar"}"
  5 => "payload {"foo":"bar"}"
]

So shouldn't the data_path for env and code be there?

What am I missing?

Thanks!

[arukompas]

Hey @jfvoliveira , glad you're experimenting with custom logs!

So, I'm not sure if I missed it in the docs or not, but it's not enough to just provide extra regex named groups. You should also update the fillMatches() method that you mentioned above, to something like this:

protected function fillMatches(array $matches = []): void
{
    // the parent method only parses datetime, level, and message
    parent::fillMatches($matches);
    
    // for other properties, fill them in $this->context or $this->extra
    $this->context = [
        'env' => $matches['env'] ?? '',
        'code' => $matches['code'] ?? '',
        'payload' => json_decode($matches['payload'] ?? 'null'),
    ];
    
    // DO NOT assign properties outside of 'context' or 'extra' arrays, as it will not get returned to the frontend.
    $this->env = $matches['env'];  // Do not do this
}

If you have any other custom properties/matches to define on the log, do it on the $this->context or $this->extra array. The $this->extra is usually used by Log Viewer, but you're free to fill it as well.

So, now that you have the properties clearly defined inside the context or extra arrays, it's time to update the column definitions:

    /** @var array|string[][] */
    public static array $columns = [
        ['label' => 'Level', 'data_path' => 'level'],
        ['label' => 'Date/Time', 'data_path' => 'datetime'],
        ['label' => 'Env', 'data_path' => 'context.env'],
        ['label' => 'Code', 'data_path' => 'context.code'],
        ['label' => 'Message', 'data_path' => 'message'],
        ['label' => 'Payload', 'data_path' => 'context.payload'],
    ];

Let me know if this helps, or if you have any more questions :)

[jfvoliveira]

Hey @arukompas . Thank you for your response.
I read the docs but I thought that those context.<field> were only required if the <field> was not part of the named groups of the regex (in my case they were).
Already got this working. Many thanks!

[arukompas]

I'll update the docs to be more clear, thanks for letting me know! 🙌

[jfvoliveira]

No problem. I'm the one thanking you.

Btw, just two more things I saw:

The Payload column is pushed to the right, and the title is hidden behind the sort/per page options and the details row is 2 colspan short The image says 1 colspan but in this case the main row has 8 columns and the details row is colspan="6".

Thanks for your help and keep up the good work!

[arukompas]

hey @jfvoliveira , please try upgrading to v3.1.10 (latest), it should fix the layout issues mentioned above :)

[jfvoliveira]

Yeah, can confirm. It's fixed now. Many thanks! 👍🏻