https://github.com/openforgeproject/vscode-ext-magento-log-viewer

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.
https://github.com/openforgeproject/vscode-ext-magento-log-viewer

developer-tools development log magento magento2 vscode vscode-extension

Last synced: about 2 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/openforgeproject/vscode-ext-magento-log-viewer
• Owner: OpenForgeProject
• License: apache-2.0
• Created: 2024-11-05T19:29:41.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-01-20T08:17:15.000Z (4 months ago)
• Last Synced: 2025-03-10T17:13:13.608Z (2 months ago)
• Topics: developer-tools, development, log, magento, magento2, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 2.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Magento Log Viewer

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/04d20d74a4bb4f7fb144d320f7008edb)](https://app.codacy.com/gh/OpenForgeProject/vscode-ext-magento-log-viewer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![GitHub Actions](https://github.com/OpenForgeProject/vscode-ext-magento-log-viewer/actions/workflows/test.yml/badge.svg)](https://github.com/OpenForgeProject/vscode-ext-magento-log-viewer/actions/workflows/test.yml)

![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/MathiasElle.magento-log-viewer?color=0891B2)

The Magento Log Viewer extension for Visual Studio Code provides a convenient way to view and manage Magento log files directly in your workspace.

![Magento Log Viewer Screenshot](resources/logVideo.gif)

## Features

- Tree view of log files from Magento's `var/log` directory

- Section for Grouped log entries by severity level (ERROR, WARN, DEBUG, INFO)

- Section for Report files with parsed and opimized titels

- Option to group log entries by message content

- Direct file opening with line highlighting

- One-click log file clearing with confirmation popup

- Status bar showing total log entries

- Real-time log file monitoring

- Badge in the tree view showing the total number of log entries

- Improved report file titles by parsing content for better readability

## Setup

1. Install the extension from VS Code marketplace

2. Open your Magento project workspace

3. When prompted, confirm it's a Magento project

4. Select your Magento root directory

5. The extension will now load your log files

Note: Settings are workspace-specific, allowing different configurations for each Magento project.

## Usage

- **View Logs**: Open the Magento Log Viewer sidebar (M logo)

- **Clear Logs**: Click the trash icon in the view header. A confirmation popup will appear to confirm the action.

- **Refresh**: Click the refresh icon or wait for auto-update

- **Navigate**: Click on log entries to jump to specific lines

- **Filter**: Expand log files to see entries grouped by severity

- **Group by Message**: Enable or disable grouping of log entries by message content in the settings. When enabled, the counter will display "grouped" (e.g., `INFO (128, grouped)`).

## Requirements

- VS Code 1.95.0+

**Enjoy!**