module-admin-redis-report

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #llm #go #android #rust #deep-learning #macos #awesome #awesome-list #pytorch #ios #mcp

module-admin-redis-report

(★ 19)

A Magento 2 module to show some Redis-related information in the admin.

module-admin-redis-report Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

module-admin-redis-report

module-admin-redis-report Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

module-admin-redis-report

module-admin-redis-report Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README