rjds / magento2-module-log-viewer

rjds/magento2-module-log-viewer

Magento 2 backend log viewer module.

  • Ruben Eekhof
  • Iede Koffeman
magento2-module Compatibility: 2.4.7-2.4.9 Code Quality: Fail Tests: Pass Security: Pass MIT

Magento 2 Log Viewer

Version
Downloads
License

A Magento 2 module to view and manage log files directly from the admin panel.

Installation

Install from Packagist:

composer require rjds/magento2-module-log-viewer
bin/magento module:enable Rjds_LogViewer
bin/magento setup:upgrade
bin/magento cache:flush

Overview

View Magento logs from the backend without SSH or filesystem access.
The module provides an admin interface to:

  • list available log files
  • inspect log contents
  • filter and search entries
  • safely clear log files when needed

Quick Start

  1. Go to Magento Admin.
  2. Navigate to Reports > Log Viewer > View Logs.
  3. Select a log file (for example system.log, exception.log, or debug.log).
  4. Review entries and apply filters/search as needed.

Screenshots

View Logs

[image: View Logs grid]

View Log

[image: View Log detail]

Configure permissions

Grant access to the Log Viewer in System > Permissions > User Roles.

Make sure administrators who need this feature have the appropriate ACL resource enabled.

Development

composer install

For local development in Magento:

bin/magento setup:upgrade
bin/magento cache:flush

Run your project quality checks (PHPStan, PHPCS, PHPUnit, etc.) according to your repository setup.

Contributing

Contributions are welcome. See CONTRIBUTING.md for contribution guidelines, commit conventions, and pull request workflow.

Migrations

If future major versions introduce breaking changes, migration notes will be documented in MIGRATION.md.

License

This project is released under the MIT License.
See LICENSE for details and CHANGELOG.md for release history.

Changelog

1.1.0 (2026-05-04)

Features

  • added a setting to disable the deletion of log files (#20) (b6a66d0)

1.0.1 (2026-04-29)

Bug Fixes

  • registration: include php-humanize in Magento DI compilation (#18) (665dc89)

1.0.0 (2026-04-24)

Features

  • add store configuration section (#6) (352ea27)
  • delete: added actions to delete logs (#13) (c15472a)
  • implemented the actions to download logs (#7) (de4e16d)
  • initial commit (40d9cd5)
  • log: added a ui component to display all logs (#5) (d24b55f)
  • view: logs UI (#15) (6f38a64)
Versions
Version Stability QA Status Compatibility Released
1.1.0 stable Fail Magento 2.4.7-2.4.9 Details 2026-05-05 07:22:56
1.0.1 stable Not tested Not yet tested Details 2026-04-29 08:52:19
1.0.0 stable Not tested Not yet tested Details 2026-04-24 07:30:13

Requires 2

Package Constraint
ext-zip *
rjds/php-humanize ^3.0

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass Pass
2.4.9 Pass Pass

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.

Static analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

Static analysis results
Tool Status Findings Summary
PHPCS Fail 229 11 errors, 218 warnings (ruleset: Magento2) — 183 auto-fixable with phpcbf
PHPMD Warning 3 3 rule violations (ErrorControlOperator:2, UnusedFormalParameter:1)
Cpd Pass 0
PHP Compatibility Pending 0
Composer validate Pass 0

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 4 4
2.4.8 4 4
2.4.9 4 4

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Integration tests

Integration tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass not tested
2.4.9 Pass not tested

Security

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
MIT
Authors
  • Ruben Eekhof — Developer
  • Iede Koffeman — Developer
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.