|
1 | 1 | # Magento Log Viewer |
2 | 2 |
|
3 | | -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 entries. |
4 | | - |
5 | | - |
| 3 | +The Magento Log Viewer extension for Visual Studio Code provides a convenient way to view and manage Magento log files directly in your workspace. |
6 | 4 |
|
7 | 5 | ## Features |
8 | 6 |
|
9 | | -- **View Log Files**: Displays a tree view of log files in the `var/log` directory of your Magento project. |
10 | | -- **Open Log Files**: Open log files directly in the editor by clicking on them in the tree view. |
11 | | -- **Collapsible Log Lines**: Each log file can be expanded to view individual lines. |
12 | | -- **Clear Log Files**: Clear all log files with a single command. |
13 | | -- **Status Bar Item**: Shows the number of log entries in the status bar. |
14 | | - |
15 | | -## Requirements |
| 7 | +- Tree view of log files from Magento's `var/log` directory |
| 8 | +- Grouped log entries by severity level (ERROR, WARN, DEBUG, INFO) |
| 9 | +- Direct file opening with line highlighting |
| 10 | +- One-click log file clearing |
| 11 | +- Status bar showing total log entries |
| 12 | +- Real-time log file monitoring |
16 | 13 |
|
17 | | -- Visual Studio Code version 1.95.0 or higher. |
18 | | -- A Magento project with log files located in the `var/log` directory. |
| 14 | +## Setup |
19 | 15 |
|
20 | | -## Getting Started |
| 16 | +1. Install the extension from VS Code marketplace |
| 17 | +2. Open your Magento project workspace |
| 18 | +3. When prompted, confirm it's a Magento project |
| 19 | +4. Select your Magento root directory |
| 20 | +5. The extension will now load your log files |
21 | 21 |
|
22 | | -1. **Install the extension**: Install the Magento Log Viewer extension from the Visual Studio Code marketplace. |
23 | | -2. **Open your Magento project**: Open your Magento project in Visual Studio Code. |
24 | | -3. **Configure the extension**: When you open a workspace, the extension will prompt you to specify if it is a Magento project. If you select "Yes", you will be prompted to select the Magento root folder. |
25 | | -4. **View log files**: The log files will be displayed in the tree view under the "Magento Log Viewer" activity bar. |
26 | | -5. **Open log files**: Click on any log file in the tree view to open it in the editor. |
27 | | -6. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines. |
28 | | -7. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory. |
| 22 | +Note: Settings are workspace-specific, allowing different configurations for each Magento project. |
29 | 23 |
|
30 | 24 | ## Usage |
31 | 25 |
|
32 | | -1. **Install the extension**: Install the Magento Log Viewer extension from the Visual Studio Code marketplace. |
33 | | -2. **Configure the extension**: When you open a workspace, the extension will prompt you to specify if it is a Magento project. If you select "Yes", you will be prompted to select the Magento root folder. |
34 | | -3. **View log files**: The log files will be displayed in the tree view under the "Magento Log Viewer" activity bar. |
35 | | -4. **Open log files**: Click on any log file in the tree view to open it in the editor. |
36 | | -5. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines. |
37 | | -6. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory. |
| 26 | +- **View Logs**: Open the Magento Log Viewer sidebar (M logo) |
| 27 | +- **Clear Logs**: Click the trash icon in the view header |
| 28 | +- **Refresh**: Click the refresh icon or wait for auto-update |
| 29 | +- **Navigate**: Click on log entries to jump to specific lines |
| 30 | +- **Filter**: Expand log files to see entries grouped by severity |
| 31 | + |
| 32 | +## Requirements |
| 33 | + |
| 34 | +- VS Code 1.95.0+ |
38 | 35 |
|
39 | 36 | **Enjoy!** |
0 commit comments