# element119/module-admin-redis-report

> A Magento 2 module that displays Redis information in the admin.

`composer require element119/module-admin-redis-report`

Canonical URL: https://packagento.com/element119/module-admin-redis-report

## At a glance

- **Vendor**: element119 (https://packagento.com/element119.md)
- **Latest version**: 1.5.2 — released 2025-08-09
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/element119/module-admin-redis-report and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require element119/module-admin-redis-report:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

A Magento 2 module that displays Redis information in the admin.

## README

<div align="center">

<!-- Module Image Here -->

</div>

<h1 align="center">element119 | Admin Redis Report</h1>

### 📝 Features
✔️ See a snapshot of the health of Redis from the comfort of the Magento admin

✔️ Visualise historic Redis health statistics 

✔️ Supports Magento Open Source, Adobe Commerce, and Mage-OS

✔️ Built in accordance with Magento best practises

✔️ Dedicated module configuration section and custom admin user controls

✔️ Seamless integration with Magento

✔️ Built with developers and extensibility in mind to make customisations as easy as possible

✔️ Installable via Composer

✔️ Theme agnostic

#### Upcoming
⏳ Ability to filter historic charts by date range

<br/>

### ⛔️ Incompatibilities

> [!CAUTION]
> This module is not compatible with Magento instances that utilise the Redis L2 cache and/or the
> `Magento\Framework\Cache\Backend\RemoteSynchronizedCache` class for the Redis backend cache.
> 
> More information is available in the Magento documentation:
> - [Redis L2 Cache](https://experienceleague.adobe.com/en/docs/commerce-operations/implementation-playbook/best-practices/planning/redis-service-configuration#configure-redis-l2-cache)
> - [Available Redis Backend Cache Classes](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/configure/env/stage/variables-deploy#redis_backend)

<br/>

### 🔌 Installation
Run the following command to *install* this module:
```bash
composer require element119/module-admin-redis-report
php bin/magento setup:upgrade
```

<br/>

### ⏫ Updating
Run the following command to *update* this module:
```bash
composer update element119/module-admin-redis-report
php bin/magento setup:upgrade
```

<br/>

### ❌ Uninstallation
Run the following command to *uninstall* this module:
```bash
composer remove element119/module-admin-redis-report
php bin/magento setup:upgrade
```

<br/>

### 📚 User Guide
Configuration for this module can be found in the Magento admin under `Stores -> Settings -> Configuration -> Advanced
-> System -> Redis Report`.

<br>

#### Redis Report
The Redis information can be found in the admin under `System -> Tools -> Redis Report`.

<br>

#### Enable/Disable Historic Data
The periodic capture of Redis information can be disabled by setting this option to `No`. This is set to `Yes` by
default.

<br>

#### Historic Data Retention Period
The value specified here determines how long Magento will store historic Redis report data, measured in days.
An empty value means data will be kept indefinitely.

### 📸 Screenshots & GIFs
#### Admin Configuration
![admin-config](https://github.com/element119/module-admin-redis-report/assets/40261741/853aea10-d995-4cb1-a4d7-9dc7cdccafd3)

<br>

#### Admin Report
![admin-report](https://github.com/element119/module-admin-redis-report/assets/40261741/5015905d-fb0d-40fe-99f5-b5ec29b207ee)

## Recent Versions

| Version | Released |
|---|---|
| 1.5.2 | 2025-08-09 |
| 1.5.1 | 2024-09-28 |
| 1.5.0 | 2024-07-30 |
| 1.4.1 | 2024-04-13 |
| 1.4.0 | 2023-12-05 |
| 1.3.0 | 2023-12-05 |
| 1.2.0 | 2023-11-22 |
| 1.1.0 | 2023-11-22 |
| 1.0.0 | 2023-11-21 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| ext-json | * |
| magento/module-backend | * |
| php | ^7.4 \|\| ~8.0.0 \|\| ~8.1.0 \|\| ~8.2.0 \|\| ~8.3.0 \|\| ~8.4.0 |

### Suggest

| Package | Constraint |
|---|---|
| ethanyehuda/magento2-cronjobmanager | A module for managing scheduled cron jobs from magento's admin panel |

## Quality

Latest release (1.5.2) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| 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 | not tested |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — 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.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 61 | 61 warnings (ruleset: Magento2) — 33 auto-fixable with phpcbf |
| PHPMD | Warning | 3 | 3 rule violations (IfStatementAssignment:2, UnusedFormalParameter:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 5 | 5 | – | – |
| 2.4.8 | – | 5 | 5 | – |
| 2.4.9 | – | – | 5 | N/A |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| 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

| 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 |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["element119/module-admin-redis-report"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

element119 is a Magento 2 vendor on Packagento. See https://packagento.com/element119.md for their full catalogue.