README

Log viewer for Symfony

Log Viewer: a bundle for your Symfony app. It provides a user-friendly UI to read, filter and search log files.

Out of the box it will read your Monolog logs in the var/log directory, but can be configured to read logs from any directory.

Features

• 📂 View all the Monolog logs in the %kernel.logs_dir% directory,
• 📂 View other types of logs - Apache, Nginx, or custom logs,
• 📂 Read compressed log files - only .gz files supported,
• 🔍 Search the logs,
• 🔍 Filter by log level (error, info, debug, etc.), by channel, date range or log content inclusion or exclusion,
• 🔍 Show context lines before and/or after the log entry matches,
• 🔍 Search multiple log files at once,
• 🌑 Dark mode,
• 🕑 Present log entries in your local timezone,
• 🖥️ Multiple host support,
• 💾 Download or delete log files from the UI,
• ☎️ API access for folders, files & log entries,

Getting started

Requirements

• PHP 8.1+
• Symfony 6.0+, 7.0+ or 8.0+
• ext-zlib (optional, required to read .gz compressed log files)

Installation

Use composer.

composer require fdekker/log-viewer-bundle

If you don't use Symfony Flex, you'll need to manually enable the bundle:

# /config/bundles.php
return [
    // ...
    FD\LogViewer\FDLogViewerBundle::class => ['all' => true],
];

And add the route by creating file /config/routes/fd_log_viewer.php:

<?php
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return static function (RoutingConfigurator $routingConfigurator): void {
    $routingConfigurator->import('.', 'fd_symfony_log_viewer')->prefix('/log-viewer');
};

⚠ Ensure access to your logs are secure by adding the line below to /config/packages/security.php:

return static function (SecurityConfig $security): void {
    ...
    $security->accessControl()->path('^/log-viewer')->roles(['ROLE_ADMIN']);
};

After installing the package, publish the front-end assets by running:

php bin/console assets:install

Usage

Once the installation is complete, you will be able to access Log Viewer directly in your browser.

By default, it is available at: /log-viewer on your domain.

Configuration

Default configuration: (Configuration reference)

fd_log_viewer:
    home_route: null
    show_performance_details: true

    log_files:
        monolog:
            type: monolog
            name: Monolog
            finder:
                in: "%kernel.logs_dir%"
                name: "*.log"
                depth: '== 0'
                ignoreUnreadableDirs: true
                followLinks: false
            open:
            downloadable: false
            deletable: false
            start_of_line_pattern: '/^\[\d{4}-\d{2}-\d{2}[^]]*]\s+\S+\.\S+:/'
            log_message_pattern: '/^\[(?P<date>[^\]]+)\]\s+(?P<channel>[^\.]+)\.(?P<severity>[^:]+):\s+(?P<message>.*)\s+(?P<context>(?:{.*?}|\[.*?]))\s+(?P<extra>(?:{.*?}|\[.*?]))\s+$/s'
            date_format: null

    hosts:
        localhost:
            name: Local
            host: null

Read more:

• Adding more monolog directories
• Modifying monolog configuration
• Disabling the default monolog configuration
• Adding additional log files
• Adding apache logs
• Adding nginx logs
• Adding php error_log
• Reading compressed log files
• Adding remote hosts
• Configuring the back home url
• Advanced search queries