Skip to content

The Magento Log Viewer extension for Visual Studio Code allows you to easily view and manage log files in your Magento project. This extension provides a tree view of log files, the ability to open and clear log files, and a status bar item showing the number of log files.

License

Notifications You must be signed in to change notification settings

OpenForgeProject/vscode-ext-magento-log-viewer

Repository files navigation

πŸš€ Magento Log Viewer for VS Code

Codacy Badge GitHub Actions Visual Studio Marketplace Installs

Professional Log Viewer for Magento & Adobe Commerce Developers

A powerful VS Code extension that enhances your Magento development workflow with intelligent log management, advanced search capabilities, and automated cleanup tools.

Magento Log Viewer Screenshot

✨ Key Features

πŸ“ Smart Log Management

  • Structured Tree View - All log files from var/log/ organized clearly
  • Color-coded Log Levels - ERROR (red), WARN (orange), DEBUG (yellow), INFO (blue), CRITICAL (pink)
  • Report File Integration - Automatic analysis and grouping of var/report/ files
  • Real-time Monitoring - Live updates when files change

πŸ” Advanced Search Capabilities

  • Real-time Search - Instant filtering as you type
  • Regex Support - Powerful pattern matching (e.g., error.*critical)
  • Case-sensitive Options - Precise search with case sensitivity control
  • Smart Grouping - Identical log entries are automatically grouped

⚑ Performance Optimization

  • Intelligent Caching - Up to 80% faster file access
  • Memory Management - Automatic cache memory optimization
  • Configurable Limits - Adjust cache size based on project needs
  • Performance Statistics - Detailed cache metrics for developers

πŸ› οΈ Automated Maintenance

  • Auto-Cleanup - Automatic deletion of old log files by configurable age
  • Periodic Cleanup - Cron-like scheduling (5min to 24h intervals)
  • One-Click Cleanup - Instant deletion with safety confirmation
  • Bulk Operations - Delete report files individually or all at once

πŸš€ Quick Start

Installation & Setup

  1. Install Extension - Direct from VS Code Marketplace
  2. Open Magento Project - Load workspace in VS Code
  3. Confirm Project - Automatic detection with confirmation dialog
  4. Select Magento Root - Integrated folder picker for easy configuration
  5. Done! - Log files are automatically loaded

πŸ’‘ Tip: The extension saves all settings workspace-specific, allowing different configurations for different Magento projects.

Getting Started

  • Open Log Viewer - Click the Magento logo (M) in the sidebar
  • Search Logs - Search icon in the header for live filtering
  • Open Files - Direct click on log entries jumps to the corresponding line
  • Manage Reports - Right-click menu for individual report deletion

πŸ“– Detailed Usage

Log Management

  • πŸ“Š Overview - All log files with badge display of entry count
  • πŸ”„ Auto-Refresh - Automatic updates when files change
  • πŸ“‹ Grouping - Identical messages are summarized (INFO (128, grouped))
  • 🎯 Navigation - Direct jump to specific lines in code

Advanced Search

  • πŸ” Text Search - Simple text input filters all relevant entries
  • ⚑ Real-time Filter - Instant results while typing
  • 🎯 Case-Sensitive - Activatable via settings for exact case matching
  • πŸ”§ Regex Patterns - Advanced search patterns for complex filtering
    • Example: error.*critical finds all ERROR logs with "critical"
    • Example: \[2024-12-\d+\] for all December 2024 entries
  • 🧹 Clear Search - Clear button (visible during active search)

Automatic Cleanup

  • ⏰ Auto-Cleanup - Configurable deletion by file age
    • Supported formats: 30min, 2h, 7d, 2w, 3M
    • Disabled by default for safety
  • πŸ”„ Periodic Cleanup - Automatic execution at intervals
    • Intervals: 5min to 24h selectable
    • Recommended: 1h for production, 6h for development
  • πŸ—‘οΈ Manual Cleanup - Clock icon for immediate cleanup
  • ⚠️ Safety - Confirmation dialogs for critical operations

Report Management

  • πŸ“ Structured View - Automatic title optimization through content parsing
  • πŸ” Separate Search - Independent search function for report files
  • πŸ—‘οΈ Selective Deletion - Individual reports via right-click context menu
  • 🧹 Bulk Operations - Delete all reports at once

βš™οΈ Configuration

Performance Settings

{
  "magentoLogViewer.cacheMaxFiles": 50,        // Max files in cache
  "magentoLogViewer.cacheMaxFileSize": 10,     // Max file size in MB
  "magentoLogViewer.enableCacheStatistics": false  // Debug statistics
}

Cleanup Configuration

{
  "magentoLogViewer.enableAutoCleanup": false,           // Enable auto-cleanup
  "magentoLogViewer.autoCleanupMaxAge": "7d",            // Maximum file age
  "magentoLogViewer.enablePeriodicCleanup": false,       // Periodic execution
  "magentoLogViewer.periodicCleanupInterval": "6h"       // Cleanup interval
}

Display Options

{
  "magentoLogViewer.groupByMessage": true,         // Group messages
  "magentoLogViewer.searchCaseSensitive": false,   // Case-sensitive search
  "magentoLogViewer.searchUseRegex": false         // Regex support
}

🎯 Supported Magento Versions

  • βœ… Magento 2.x (all versions)
  • βœ… Adobe Commerce (On-Premise & Cloud)
  • βœ… Adobe Commerce Cloud
  • βœ… Magento Open Source
  • βœ… Custom Log Structures

πŸ”§ System Requirements

  • VS Code 1.95.0 or higher
  • Magento Project with standard var/log and var/report structure
  • Node.js (automatically installed with VS Code)

🀝 Support & Contributing

Report Issues

Support Development


Built with ❀️ for the Magento Community

Enhance your productivity with intelligent log management directly in VS Code!

About

The Magento Log Viewer extension for Visual Studio Code allows you to easily view and manage log files in your Magento project. This extension provides a tree view of log files, the ability to open and clear log files, and a status bar item showing the number of log files.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 3

  •  
  •  
  •