element119/module-admin-indexer-report

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

1.0.0 2024-10-17 15:05 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• hyva-themes/module-magento2-admin: ^1.1
• magento/module-backend: *
• magento/module-catalog: *
• magento/module-indexer: *

proprietary

• element119

README

element119 | Admin Indexer Report

📝 Features

✔️ Allow admins to reindex data, logging who did so and when

✔️ Provide advice for recommended indexer configuration and improvements

✔️ Health report for indexer-related cron jobs

✔️ Surface indexer batch configuration information

✔️ Provide educational resources for indexer configuration and performance

✔️ Supports custom indexer implementations

✔️ Theme agnostic

✔️ Built in accordance with Magento best practises

✔️ Dedicated module configuration section secured with 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

⏳ Data visualisation

⏳ Allow merchants to set indexer batch sizes via the admin

🔌 Installation

Run the following command to install this module:

composer require element119/module-admin-indexer-report
php bin/magento setup:upgrade

⏫ Updating

Run the following command to update this module:

composer update element119/module-admin-indexer-report
php bin/magento setup:upgrade

❌ Uninstallation

Run the following command to uninstall this module:

composer remove element119/module-admin-indexer-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 -> Indexer Report.

Indexer Report

The indexer information can be found below the native indexer grid in the admin under System -> Tools -> Index Management.

Enable Indexer History Log Cron

The periodic capture of indexer-related cron information can be disabled by setting this option to No. This is set to Yes by default.

📸 Screenshots & GIFs