Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/element119/module-admin-redis-report
A Magento 2 module to show some Redis-related information in the admin.
https://github.com/element119/module-admin-redis-report
admin magento2 monitoring performance reporting
Last synced: 12 days ago
JSON representation
A Magento 2 module to show some Redis-related information in the admin.
- Host: GitHub
- URL: https://github.com/element119/module-admin-redis-report
- Owner: element119
- License: mit
- Created: 2023-11-06T09:31:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-28T13:58:32.000Z (3 months ago)
- Last Synced: 2024-12-20T16:06:45.067Z (21 days ago)
- Topics: admin, magento2, monitoring, performance, reporting
- Language: HTML
- Homepage:
- Size: 53.7 KB
- Stars: 14
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
element119 | Admin Redis Report
## 📝 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
## ⛔️ 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)
## 🔌 Installation
Run the following command to *install* this module:
```bash
composer require element119/module-admin-redis-report
php bin/magento setup:upgrade
```
## ⏫ Updating
Run the following command to *update* this module:
```bash
composer update element119/module-admin-redis-report
php bin/magento setup:upgrade
```
## ❌ Uninstallation
Run the following command to *uninstall* this module:
```bash
composer remove element119/module-admin-redis-report
php bin/magento setup:upgrade
```
## 📚 User Guide
Configuration for this module can be found in the Magento admin under `Stores -> Settings -> Configuration -> Advanced
-> System -> Redis Report`.
### Redis Report
The Redis information can be found in the admin under `System -> Tools -> Redis Report`.
### 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.
### 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 Report
