saade / filament-laravel-log

Read Laravel logs from the Filament admin panel

Filament Laravel Log

Features

• Syntax highlighting
• Light/ Dark mode
• Quickly jump between start and end of the file
• Refresh log contents
• Clear log contents
• Search multiple files in multiple directories
• Ignored file patterns

Installation

You can install the package via composer:

composer require saade/filament-laravel-log:^3.0

Usage

Add the Saade\FilamentLaravelLog\FilamentLaravelLogPlugin to your panel config.

use Saade\FilamentLaravelLog\FilamentLaravelLogPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentLaravelLogPlugin::make()
            );
    }
}

Configuration

Customizing the navigation item

FilamentLaravelLogPlugin::make()
    ->navigationGroup('System Tools')
    ->navigationLabel('Logs')
    ->navigationIcon('heroicon-o-bug-ant')
    ->navigationSort(1)
    ->slug('logs')

Customizing the log search

FilamentLaravelLogPlugin::make()
  ->logDirs([
      storage_path('logs'),     // The default value
  ])
  ->excludedFilesPatterns([
      '*2023*'
  ])

Authorization

If you would like to prevent certain users from accessing the logs page, you should add a authorize callback in the FilamentLaravelLogPlugin chain.

FilamentLaravelLogPlugin::make()
  ->authorize(
      fn () => auth()->user()->isAdmin()
  )

Customizing the log page

To customize the log page, you can extend the Saade\FilamentLaravelLog\Pages\ViewLog page and override its methods.

use Saade\FilamentLaravelLog\Pages\ViewLog as BaseViewLog;

class ViewLog extends BaseViewLog
{
    // Your implementation
}

use App\Filament\Pages\ViewLog;

FilamentLaravelLogPlugin::make()
  ->viewLog(ViewLog::class)

Customizing the editor appearance

Publish the config file:

php artisan vendor:publish --tag="log-config"

This is the contents of the published config file:

<?php

return [
    /**
     * Maximum amount of lines that editor will render.
     */
    'maxLines' => 50,

    /**
     * Minimum amount of lines that editor will render.
     */
    'minLines' => 10,

    /**
     * Editor font size.
     */
    'fontSize' => 12
];

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Saade
• All Contributors

License

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

filament-laravel-log's Issues

Exception: Target class [hash] does not exist

Hi,

Thanks for creating this plugin, I believe it's very useful!

One thing I discovered is when I add this callback for the authorize() method an Exception is thrown:

        ->authorize(
            fn () => auth()->user()->hasRole('super_admin')
        ),

This is the Exception:

Any clues on why this is happening?

Facade is triggering errors when updating IDE Helper files

I believe the Facade \Saade\FilamentLaravelLog\Facades\FilamentLaravelLog isn't set up correctly because composer complains about it every time when it updates files for my IDE Helper:

> @php artisan ide-helper:generate
Exception: Target class [filament-laravel-log] does not exist.
Skipping \Saade\FilamentLaravelLog\Facades\FilamentLaravelLog.
Exception: Target class [filament-laravel-log] does not exist.
Skipping \Saade\FilamentLaravelLog\Facades\FilamentLaravelLog.

Is the Facade actually needed or useful?

Plugin [filament-laravel-log] is not registered for panel [admin]. Can not add this to custom admin panel

I want this plugin only on developer admin panel. But I am getting this exception on adding it to developer admin panel.

Plugin [filament-laravel-log] is not registered for panel [admin].

To fix this I need to also add this with default admin panel, then I can use it to other admin panel, like in my case developer admin panel.

Kindly fix this, so that we can use this separately to custom admin panel page.

Default admin panel

return $panel
            ->default()
            ->id('admin')
            ->path('admin')
.....
->plugins([
                FilamentLaravelLogPlugin::make()
                    ->navigationGroup('System Tools')
                    ->navigationLabel('Logs')
                    ->navigationIcon('heroicon-o-bug-ant')
                    ->navigationSort(1)
                    ->slug('logs')
            ]);

Custom admin panel

 return $panel
            ->id('developer')
            ->path('developer')
.....
->plugins([
                FilamentLaravelLogPlugin::make()
                    ->navigationGroup('System Tools')
                    ->navigationLabel('Logs')
                    ->navigationIcon('heroicon-o-bug-ant')
                    ->navigationSort(1)
                    ->slug('logs')
            ]);

Publish config file command doesn't work

Hello,

Thanks for your package, it's really neat!

There is an error in the readme regarding the publish file command though:

php artisan vendor:publish --tag="filament-laravel-log-config"

This returned the following error message:
No publishable resources for tag [filament-laravel-log-config].

The command to publish assets for me were the following:

• php artisan vendor:publish --tag="log-config"
• php artisan vendor:publish --tag="log-translations"
• php artisan vendor:publish --tag="log-views"

I had to look for the proper one by using the generic 'vendor:publish' command, as you can see below:

logDirs([]) not working.

Hello, this is a very nice package.

However, I am unable to set custom log directories using the given method. It just falls back to the default "logs".

Has anyone else faced the same issue before?

Basically, this is how I have implemented it. Each of the two directories has one log file. Neither is seen.

In authorization auth()->user() returns null

Maybe I'm missing something, but here goes.

According to the documentation, I could do something like this:

FilamentLaravelLogPlugin::make()
  ->authorize(
      fn () => auth()->user()->isAdmin()
  )

However, the return from auth()->user() is always null. Apparently, in the life cycle, the providers are analyzed before the laravel framework retrieves the authenticated user's data.

Therefore, there is no way to do any checking there, since the user is not yet available.

Am I forgetting something or is there a bug here?