sitenzo / filament-laravel-log Goto Github PK

View Code? Open in Web Editor NEW

Read Laravel logs from the Filament admin panel

License: MIT License

JavaScript 9.69% PHP 73.44% CSS 12.43% Blade 4.44%

filament-laravel-log's Introduction

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 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
];