README.md

October 17, 2024 ยท View on GitHub

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

admin-indexer-report-all-notices