Elasticsearch with ElasticSuite crashes or out of memory

NOTE: ElasticSuite and its affiliated applications are third-party tools not currently supported by Magento. This content is being presented as informational only and not as an indication of what is enabled for Support coverage.

This article talks about the issue of Elasticsearch crashing or having memory problems if the ElasticSuite plugin is installed.

Affected Products and Versions

It is not confirmed what versions of ElasticSuite have this issue, but the 2.8.0 version contains a fix.

Elasticsearch version compatibility with Magento

• Magento Commerce and Magento Commerce Cloud:
  • v2.2.3+ supports ES 5.x
  • v2.2.8+ and v2.3.1+ support ES 6.x
  • ES v2.x and v5.x are not recommended because of End of Life. However, if you have Magento v2.3.1 and want to use ES 2.x or ES 5.x, you must Change the Elasticsearch php Client.
• Magento Open Source v2.3.0+ supports ES 5.x and 6.x (but 6.x is recommended).

Issue

If the ElasticSuite third-party plugin is installed, you might experience Elasticsearch memory issues, and the Elasticsearch service might crash.

Cause

The errors are caused by tracking indices created and stored by the ElasticSuite Search Analytics Dashboards feature which is enabled by default. These tracking indices record which search terms are the most used, which terms generate the most turnover, and which terms are leading to a no results page so merchants can create synonyms to fix them. The tracking indices eventually use up all resources allocated to Elasticsearch.

Solution

There are two solutions to prevent these out-of-memory issues; upgrade the ElasticSuite plugin to version 2.8.0, or disable the Search Analytics dashboard which stops the ElasticSuite plugin from collecting navigation data. The rest of the module continues to work properly even if tracking is disabled.  

Choose the solution based on what version of Magento you have.

Magento 2.3x or later

Use the following command to upgrade the ElasticSuite plugin to version 2.8.0 or later. In these versions, a fix was added to clear the indices:

1. Change to the root directory in your project environment.
2. Enter the following command to upgrade the ElasticSuite module:
   $ composer update smile/elasticsuite ~2.8.0
3. Wait for project dependencies to update.
4. Enter the following command to commit your changes:
   

   git add -A && git commit . -m "Upgrade ElasticSuite plugin version" && git push origin <branch-name>

5. Once you have upgraded the ElasticSuite plugin to version 2.8.0, you can configure a periodical cleaning of indices. Go to Stores > Configuration > Tracking > Global Configuration > Retention Delay - The default retention period is 365 days. Change to 30 or 15 days.

Magento 2.1.x or 2.2.x 

Use either of the following methods to disable the Search Analytics Dashboards feature:

From the Magento Admin UI:

1. Log in to the Magento Admin UI.
2. Go to Stores > Configuration > Tracking > Global Configuration.
3. Set Enable to No.
4. Save your changes.

Commit configuration in the shared configuration file (these steps are for cloud merchants):

1. Change to the root directory in your project environment.
2. Copy app/etc/config.php file from the cloud environment.
3. Enter the following command to disable the Search Analytics Dashboard:
   $ bin/magento config:set smile_elasticsuite_tracker/general/enabled 0
4. Wait for project dependencies to update.
5. Enter the following command to commit your changes:
   

   git add -A && git commit . -m "Disable the ElasticSuite Search Analytics Dashboard" && git push origin <branch-name>  

If you cannot upgrade to ElasticSuite 2.8.0 or disable the Search Analytics Dashboard feature in the ElasticSuite plugin, you can also create a cron to delete the tracking indices. Follow the steps in ElasticSuite tracking indices causes problems with Elasticsearch.

Related reading

To learn more about Elasticsearch installation and configuration see Set up Elasticsearch service.