PHPackages                             fsm/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 &amp; Monitoring](/categories/logging)
4. /
5. fsm/module-log-viewer

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

fsm/module-log-viewer
=====================

Magento / Mage-OS admin Log Viewer with per-role glob patterns and download ACL.

v1.0.1(1mo ago)00OSL-3.0PHPPHP &gt;=8.2CI passing

Since Jul 13Pushed 1mo agoCompare

[ Source](https://github.com/fabiano-mallmann/module-log-viewer)[ Packagist](https://packagist.org/packages/fsm/module-log-viewer)[ Docs](https://github.com/fabiano-mallmann/module-log-viewer)[ RSS](/packages/fsm-module-log-viewer/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (1)Dependencies (6)Versions (4)Used By (0)

Fsm\_LogViewer
==============

[](#fsm_logviewer)

[![CI](https://github.com/fabiano-mallmann/module-log-viewer/actions/workflows/ci.yml/badge.svg)](https://github.com/fabiano-mallmann/module-log-viewer/actions/workflows/ci.yml)[![License: OSL-3.0](https://camo.githubusercontent.com/d470a549d2f8a69b81698d6f6851009b9a5248fb6862af014903b7a210e02595/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4f534c2d2d332e302d677265656e2e737667)](LICENSE.txt)[![PHP](https://camo.githubusercontent.com/a68b290dcc313d698dc138a1111aa83eee2f143605449d7e8b5416ea6f88558f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253345253344382e322d3737374242342e737667)](composer.json)

Admin Log Viewer for Magento Open Source / Mage-OS. Lists and displays files under `var/log` with **per-role glob patterns** and optional download permission.

Features
--------

[](#features)

- Grid of log files allowed for the current admin role
- Tail view (last 512 KB) with in-page search
- Download gated by ACL **and** role flag
- Role tab under **System → Permissions → User Roles** to configure patterns

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

[](#requirements)

- PHP 8.2+
- Magento Open Source / Mage-OS 2.4+ (compatible with Magento Backend, User, Authorization, UI)

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

[](#installation)

### Composer (recommended for distribution)

[](#composer-recommended-for-distribution)

```
composer require fsm/module-log-viewer
bin/magento module:enable Fsm_LogViewer
bin/magento setup:upgrade
bin/magento cache:flush
```

### App code

[](#app-code)

Copy this module to `app/code/Fsm/LogViewer`, then run the same `module:enable` / `setup:upgrade` commands.

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

[](#configuration)

1. Open **System → Permissions → User Roles**.
2. Edit a role → **Log Viewer** tab.
3. Enter one glob pattern per line (basename under `var/log`), for example:

    ```
    system.log
    exception.log

    ```
4. Optionally enable **Allow Download**.
5. Assign ACL resources under **System → Tools → Log Viewer**:

    - **View Logs** — list and open files
    - **Download Logs** — download (also requires the role flag)

Empty patterns mean the role sees **no** log files.

The Size column filter uses **bytes** (display is human-readable).

Security
--------

[](#security)

Log files often contain personal data, stack traces, tokens, or other secrets.

- Prefer **specific** patterns (`system.log`, `exception.log`) over `*.log`.
- Grant **Download** only to roles that need full files.
- The module rejects path traversal, null bytes, and symlinks under `var/log`.
- Viewing still exposes file contents to anyone with View ACL and matching patterns — treat role setup as a security control.

To report vulnerabilities, see [SECURITY.md](SECURITY.md).

ACL
---

[](#acl)

ResourceIDLog Viewer`Fsm_LogViewer::logviewer`View Logs`Fsm_LogViewer::view`Download Logs`Fsm_LogViewer::download`Development
-----------

[](#development)

Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/).

### Unit tests (standalone package)

[](#unit-tests-standalone-package)

```
composer install
composer run test
```

### Unit tests (from Magento root)

[](#unit-tests-from-magento-root)

```
vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist \
  app/code/Fsm/LogViewer/Test/Unit --no-extensions
```

### Coding standard

[](#coding-standard)

```
vendor/bin/phpcs --standard=Magento2 app/code/Fsm/LogViewer
```

Coverage includes path/pattern safety, `LogFileService` (ACL, symlink, tail, download), repository, role-save plugin, listing DataProvider, role tab, and admin controllers.

Contributing
------------

[](#contributing)

See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, PR guidelines, and coding standards. Please follow the [Code of Conduct](CODE_OF_CONDUCT.md).

Changelog
---------

[](#changelog)

See [CHANGELOG.md](CHANGELOG.md).

License
-------

[](#license)

Open Software License (OSL 3.0) and Academic Free License (AFL 3.0). See [COPYING.txt](COPYING.txt), [LICENSE.txt](LICENSE.txt), and [LICENSE\_AFL.txt](LICENSE_AFL.txt).

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance90

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity48

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

Every ~0 days

Total

2

Last Release

49d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/25328512?v=4)[Fabiano Mallmann](/maintainers/fabiano-mallmann)[@fabiano-mallmann](https://github.com/fabiano-mallmann)

---

Top Contributors

[![fabiano-mallmann](https://avatars.githubusercontent.com/u/25328512?v=4)](https://github.com/fabiano-mallmann "fabiano-mallmann (3 commits)")

---

Tags

logmagentolog vieweradminmagento2mage-os

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[mage-os/module-admin-activity-log

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

2920.6k1](/packages/mage-os-module-admin-activity-log)[mollie/magento2

Mollie Payment Module for Magento 2

1162.0M19](/packages/mollie-magento2)[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50413.8k26](/packages/dotdigital-dotdigital-magento2-extension)[smile/elasticsuite

Magento 2 merchandising and search engine built on ElasticSearch

8054.9M54](/packages/smile-elasticsuite)[run-as-root/magento2-prometheus-exporter

Magento2 Prometheus Exporter

68365.7k](/packages/run-as-root-magento2-prometheus-exporter)[yireo/magento2-emailtester2

Preview transactional emails and test send them in your backend

34452.5k](/packages/yireo-magento2-emailtester2)

PHPackages © 2026

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