Elasticsearch in Adobe Commerce troubleshooter

Last update: 2024-02-16

Elasticsearch issues on Adobe Commerce can be solved using the Elasticsearch troubleshooter tool. Click on each question to reveal the answer in each step of the troubleshooter.

WARNING

On Adobe Commerce on cloud infrastructure please note that service upgrades cannot be pushed to the production environment without 48 business hours’ notice to our infrastructure team. This is required as we need to ensure that we have an infrastructure support engineer available to update your configuration within a desired timeframe with minimal downtime to your production environment. So 48 hours prior to when your changes need to be on production submit a support ticket detailing your required service upgrade and stating the time when you want the upgrade process to start.

Step 1 - Check for Elasticsearch issue

 Could your problem relate to Elasticsearch?

Elasticsearch issues indicated by error messages, "No alive nodes found in your cluster", missing products, and the display of old product information.

a. YES – Proceed to Step 2.
b. NO – Search again on relevant search terms in the Adobe Commerce Help Center Knowledge Base.

Step 2 - Check for installation issue

 Is it a new installation of Elasticsearch?

a. YES – Ensure Elasticsearch is installed properly. Also check whether you are on Adobe Commerce on cloud infrastructure 2.3.1 or later. Merchants that have upgraded to Adobe Commerce on cloud infrastructure (versions 2.3.1 and onwards) and are on a version of Elasticsearch prior to 6.x can experience errors when deploying. To solve this issue the Elasticsearch client module and Elasticsearch service need to be on the latest recommended versions. For steps refer to Elasticsearch issues after Adobe Commerce on cloud infrastructure 2.3.1+ upgrade.
b. NO – Check the health of your cluster. If you are on a Pro staging or production environment run this command: curl -m1 localhost:9200/_cluster/health?pretty. If you are on an integration environment (that includes all the Starter branches) run curl -m1 elasticsearch.internal:9200/_cluster/health?pretty. Proceed to Step 3.

Step 3 - Check if Elasticsearch cluster available

 Did you get a Service response?

a. YES – Proceed to Step 4.
b. NO – Proceed to Step 9.

Step 4 - Verify Elasticsearch cluster healthy

 Response green?

a. YES – Elasticsearch is available for processing data and reindexing should work. Proceed to Step 5.
b. NO – Yellow or red means there are problems with connections between nodes, and some data may not be available. If yellow, run the command: php bin/magento config:show catalog/search/engine to check your search engine. Proceed to Step 6. If red, submit a support ticket.

Step 5 - Verify search working

 Search issue?

Symptoms might include no products, empty categories or no updates to products or products categories are not correct.

a. YES – Run this command to check the status of catalog search: php bin/magento indexer:status. Proceed to Step 8.
b. NO – Run command: php bin/magento config:show catalog/search/engine. Proceed to Step 6.

Step 6 - Check ElasticSuite

 ElasticSuite in use?

a. YES – Check if ElasticSuite is at the current version by running this command: cat composer.lock | grep -A 1 elasticsuite | grep '"version"' To check if this version is depreciated or recommended, refer to Github: Smile-SA/elaticsuite. If ElasticSuite is up to date proceed to Step 10.
b. NO – proceed to Step 7.

Step 7 - Check ECE-tools up-to-date

 Is ECE-tools the latest version?

Run the command: php ./vendor/bin/ece-tools -V and check ECE-tools version. Is it the latest version of ECE-tools?

a. YES – Proceed to Step 5a.
b. NO – Upgrade ECE-tools to the most current version. Run the command php bin/magento config: show catalog/search/engine to check your search engine. Proceed to Step 6.

Step 8 - Check for reindexing

 Is catalog search status in Processing?

a. YES – You need to wait until processing is done and then check if product categories updated. If they have not, submit a support ticket.
b. NO – If the status of catalog search is Reindex required run in CLI/Terminal: php bin/magento cron:run. If this does not work, run: php bin/magento indexer:reindex. If this does not solve the issue, submit a support ticket.

Step 9 - Check yaml configuration

 .yaml file recently updated?

a. YES – Check .yaml Elasticsearch configuration by referring to DevDocs Set up Elasticsearch: To enable Elasticsearch.
b. NO – Submit a support ticket.

Step 10 - Check for tracking indices

 Are there tracking indices listed?

Run curl elasticsearch.internal:9200/_cat/indices (if you are on an integration environment that includes all the Starter branches). If you are on Pro staging or production environment run curl localhost:9200/_cat/indices. Are there tracking indices listed? Check the output for_tracking_log_.

a. YES – If you are on a version of ElasticSuite prior to version 2.8.0 it is recommended that you upgrade to ElasticSuite 2.8.0 to adjust tracking indices retention or disable tracking. If you cannot immediately upgrade you can create a cron to remove tracking indices. However, this could cause performance issues. Once you have upgraded to ElasticSuite 2.8.0 or removed tracking indices run the command (if you are on Pro staging or production environments):localhost:9200/_cat/allocation?v to check available space. If you are on one of the integration environments (that includes all the Starter branches) run elasticsearch.internal:9200/_cat/allocation?v. Proceed to Step 11.
b. NO – If you are on Pro staging or production environments run localhost:9200/_cat/allocation?v and check available space. If you are on one of the integration environments (that includes all the Starter branches) run elasticsearch.internal:9200/_cat/allocation?v. Proceed to Step 11.

Step 11 - Look up specific error

 Specific error?

Adobe Commerce and ES logs, extensions and custom code.

a. YES – Review the Adobe Commerce Help Center Troubleshooting article Ensure Elasticsearch is installed properly or Elasticsearch crashes or has out of memory issues when using ElasticSuite plugin.
b. NO – Proceed to Step 12.

Step 12 - Check available storage

 Storage usage > 85%?

a. YES – You need to increase available storage. Refer to DevDocsSet up Elasticsearch: To enable Elasticsearch. Then run: localhost:9200/_cat/allocation?v (if you are on Pro staging or production environments). If you are on one of the integration environments (that includes all the Starter branches) run: elasticsearch.internal:9200/_cat/allocation?v. Proceed to Step 11.
b. NO – Submit a support ticket.

Back to Step 1

On this page