README

A Filament plugin to read and display Laravel log files in a clean, searchable table with stack traces and filtering.

Refer to version compatibility table below to ensure you are using the correct version of this package with your Filament installation.

Installation

composer require achyutn/filament-log-viewer

use AchyutN\FilamentLogViewer\FilamentLogViewer;

return $panel
    ->plugins([
        FilamentLogViewer::make(),
    ]);

Usage

After installation, visit /logs in your Filament panel. You will see a table of log entries.

Configuration

You can configure the maximum file size limit for log files to be loaded and displayed. This helps prevent performance issues with very large log files.

The default file size limit is set to 2 MB. To override these settings, you can set environment variables in your .env file:

LOG_MAX_SIZE_KB=20480
LOG_ENABLE_DELETE=false

Set LOG_ENABLE_DELETE=false in production to disable the Clear Logs button and protect log files from accidental deletion.

Or, you can publish the configuration file and update the max_log_file_size value as needed:

php artisan vendor:publish --tag=filament-log-viewer-config

Then, in your published config/filament-log-viewer.php file:

return [
    // Set max file size to 20 MB
    'max_log_file_size' => env('LOG_MAX_SIZE_KB', 20480),

    // Disable deleting logs from the UI
    'enable_delete' => env('LOG_ENABLE_DELETE', false),
];

Table Columns

Log Level – Badge with color mapped from log level
Environment (Toggleable) – Application environment (local, production, etc.)
File (Toggleable) – Log file name (e.g., laravel.log)
Message – Short summary of the log
Occurred – Human-readable date/time

Click the view action to inspect stack traces.

Mail Preview

If your logs contain mail messages, you can preview them directly from the table. You can click on Mail tab which is visible only if mail are present.

Filters

Log Levels

You can filter the logs according to log level. The filters are available as tabs above the table:

Date

You can filter logs by date using the date picker in the top right corner of the table. This allows you to select a specific date range to view logs.

Toggle Columns

You can toggle the visibility of the Environment and File columns by clicking the eye icon in the top right corner of the table.

Authorization

You can make a boolean check to authorize the log viewer. It will be helpful if you want to show/hide the log viewer for certain cases.

Example

You simply return a boolean or Closure which evaluates to a boolean.

FilamentLogViewer::make()
    ->authorize(true);

// or

FilamentLogViewer::make()
    ->authorize(fn (): bool => auth()->user()->is_admin);

If you are using filament-sheild or any other external services for authorization, you can use a Closure with permission check:

FilamentLogViewer::make()
    ->authorize(fn (): bool => auth()->check() && auth()->user()->can('View:LogTable'));

Extending

You can customize navigation label, icon, sort, etc. using:

use AchyutN\FilamentLogViewer\FilamentLogViewer;

FilamentLogViewer::make()
    ->authorize(fn () => auth()->check())
    ->registerNavigation(true)
    ->navigationGroup('System')
    ->navigationIcon('heroicon-o-document-text')
    ->navigationLabel('Log Viewer')
    ->navigationSort(10)
    ->navigationUrl('/logs')
    ->pollingTime(null); // Set to null to disable polling

Set ->registerNavigation(false) if you want to hide Log Viewer from the sidebar while still linking to it directly (for example, from a custom dashboard action).

Localization

Filament Log Viewer includes built-in translations for:

Translations are applied automatically based on your application's current locale.

Missing your language? Feel free to submit a PR to add it!

Filament Compatibility

Version	Filament Version
`^2.x`	Filament v5
`^1.x`	Filament v4
`^0.x`	Filament v3

Make sure you're using the appropriate version of this package for your Filament installation.

License

This package is open-sourced software licensed under the MIT license.

Changelog

See the CHANGELOG for details on changes made in each version.

Contributing

Contributions are welcome! Please create a pull request or open an issue if you find any bugs or have feature requests.

Support

If you find this package useful, please consider starring the repository on GitHub to show your support.

achyutn / filament-log-viewer

Maintainers

Package info

Fund package maintenance!

Statistics

Security