PHPackages                             hipay/module-log-viewer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. hipay/module-log-viewer

ActiveMagento2-module[Logging & Monitoring](/categories/logging)

hipay/module-log-viewer
=======================

Real-time log viewer for Magento 2

1.0.0(3mo ago)085↓42.3%HTMLPHP ^8.1.0

Since Mar 16Pushed 3mo agoCompare

[ Source](https://github.com/hipay/hipay-fullservice-sdk-magento2-log-viewer)[ Packagist](https://packagist.org/packages/hipay/module-log-viewer)[ RSS](/packages/hipay-module-log-viewer/feed)WikiDiscussions main Synced 2w ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Magento 2 Log Viewer
====================

[](#magento-2-log-viewer)

[![Magento 2](https://camo.githubusercontent.com/360e2de1fd9c704bed173bb02c7cd39ec1713f893d985460f9493be3e29b4e0f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322e342e782d6f72616e67652e737667)](https://magento.com/)[![PHP](https://camo.githubusercontent.com/cd463ce7576fbc49ef5cf4facdc3b555cb3333d224dfeb8c9dd74b38778bfa71/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e31253230253743253230382e32253230253743253230382e33253230253743253230382e342d626c75652e737667)](https://php.net/)

Real-time log monitoring and analysis tool for Magento 2 admin panel.

Overview
--------

[](#overview)

In enterprise environments, comprehensive log analysis and monitoring solutions like **New Relic**, **Datadog**, **Splunk**, **ELK Stack (Elasticsearch, Logstash, Kibana)**, and **Sentry** are essential for tracking application performance, errors, and system health. These powerful platforms provide deep insights, real-time alerting, and advanced analytics capabilities. However, there are many real-world cases where access to such tools is limited, delayed, or entirely unavailable — especially during urgent debugging or in cost-sensitive environments.

**Magento 2 Log Viewer** bridges this gap by providing a lightweight, built-in solution for real-time log monitoring directly within the Magento admin panel. While it doesn't replace comprehensive monitoring platforms, it serves as an invaluable complementary tool for immediate log analysis and debugging.

Features
--------

[](#features)

### 🎯 Core Capabilities

[](#-core-capabilities)

- **Real-time Log Streaming** - View log updates as they happen with auto-refresh functionality
- **Multiple Log File Support** - Switch between different Magento log files (system.log, exception.log, debug.log, etc.)
- **Customizable Refresh Intervals** - Choose from 5 seconds to 5 minutes for auto-refresh
- **Error Filtering** - Focus on critical issues with error-only view mode
- **Adjustable Line Limits** - Display 50 to 500 lines for optimal performance
- **Auto-scroll to Bottom** - Always see the latest log entries first
- **Manual Refresh** - Update logs on-demand with a single click
- **Clear Display** - Clean the log view without affecting actual log files

Installation
------------

[](#installation)

### Via Composer

[](#via-composer)

```
composer require hipay/module-log-viewer
php bin/magento module:enable HiPay_LogViewer
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

```

Configuration
-------------

[](#configuration)

### Access Control

[](#access-control)

The module respects Magento's ACL (Access Control List) system. To grant access:

1. Navigate to **System > User Roles**
2. Select the role you want to configure
3. In Role Resources, expand **HiPay** > **Log Viewer**
4. Check **Access Log Viewer**
5. Save the role

Usage
-----

[](#usage)

### Accessing the Log Viewer

[](#accessing-the-log-viewer)

1. Log in to Magento Admin Panel
2. Navigate to **System > Logs > Log Viewer**
3. The log viewer interface will load with the latest 100 log entries

### Basic Operations

[](#basic-operations)

#### Viewing Logs

[](#viewing-logs)

- Select desired log file from **Log File** dropdown
- Adjust number of lines with **Lines** dropdown (50, 100, 200, 500)
- Click **Refresh** button to manually update the display

#### Auto-Refresh Mode

[](#auto-refresh-mode)

1. Select refresh interval from **Auto Refresh Time** dropdown:

    - 5 seconds (real-time monitoring)
    - 15 seconds (balanced)
    - 30 seconds (moderate)
    - 1 minute (light monitoring)
    - 5 minutes (periodic checks)
2. Click **Auto Refresh: OFF** button to enable
3. Button changes to **Auto Refresh: ON** with primary color
4. Logs will update automatically at the selected interval
5. Change refresh interval on-the-fly without stopping auto-refresh
6. Click **Auto Refresh: ON** to disable automatic updates

#### Error-Only Mode

[](#error-only-mode)

- Check **Errors Only** checkbox to filter:
    - ERROR level logs
    - CRITICAL level logs
    - Exceptions
    - Fatal errors

#### Clear Display

[](#clear-display)

- Click **Clear Display** to remove current view
- Note: This only clears the interface, not the actual log files

### Use Cases

[](#use-cases)

#### Development Debugging

[](#development-debugging)

```
Scenario: Testing a new payment integration
1. Enable Auto Refresh (5 seconds)
2. Check "Errors Only"
3. Perform test transaction
4. Watch for real-time errors or exceptions

```

#### Production Monitoring

[](#production-monitoring)

```
Scenario: Monitoring critical operation during deployment
1. Select system.log
2. Set refresh to 15 seconds
3. Enable Auto Refresh
4. Monitor for any unexpected errors

```

Requirements
------------

[](#requirements)

- Magento 2.4.x or higher
- PHP 8.1, 8.2, 8.3, 8.4
- Read permissions on `var/log/` directory
- Admin panel access with appropriate ACL permissions

Compatibility
-------------

[](#compatibility)

- ✅ Magento Open Source 2.4.x
- ✅ Adobe Commerce 2.4.x
- ✅ Cloud Edition (with proper file system access)
- ✅ Multi-store setups
- ✅ Production, Staging, and Development modes

Author
------

[](#author)

**HiPay**

- Module: hipay/module-log-viewer
- Version: 1.0.0

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance81

Actively maintained with recent releases

Popularity12

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

99d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/12674072?v=4)[HiPay](/maintainers/hipay)[@hipay](https://github.com/hipay)

---

Top Contributors

[![pi-ecommerce](https://avatars.githubusercontent.com/u/54848010?v=4)](https://github.com/pi-ecommerce "pi-ecommerce (1 commits)")

### Embed Badge

![Health badge](/badges/hipay-module-log-viewer/health.svg)

```
[![Health](https://phpackages.com/badges/hipay-module-log-viewer/health.svg)](https://phpackages.com/packages/hipay-module-log-viewer)
```

###  Alternatives

[graycore/magento2-stdlogging

A Magento 2 module that changes all logging handlers to stdout

2486.3k](/packages/graycore-magento2-stdlogging)[fredden/magento2-module-javascript-error-reporting

A Magento 2 module which captures JavaScript errors for later review by website administrators

3139.3k](/packages/fredden-magento2-module-javascript-error-reporting)[mage-os/module-admin-activity-log

The Admin Activity extension makes it easy to track all admin activity with comprehensive audit logging.

293.3k](/packages/mage-os-module-admin-activity-log)[graycore/magento2-graphql-logger

117.5k](/packages/graycore-magento2-graphql-logger)[itonomy/module-admin-activity

A continuation of The Admin Activity extension by KiwiCommerce. This extension makes it easy to track all admin activity and revert the modification.

1272.0k](/packages/itonomy-module-admin-activity)[loki/magento2-components

Core module for defining Alpine.js components with advanced AJAX features

1010.0k22](/packages/loki-magento2-components)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)