Merge pull request #86 from Nosto/magento2/indexer7

Add indexer 7.0

SUMMARY.md

@@ -27,7 +27,8 @@
   * [Variations \(Configurable Products\)](features/variations-configurable-products.md)
   * [Add to Cart](features/add-to-cart.md)
   * [Indexer](features/indexer/README.md)
-    * [On 5.x](features/indexer/on-5.x.md)
+    * [On 7.x](features/indexer/on-7.x.md)
+    * [On 5.x and 6.x](features/indexer/on-5.x-and-6.x.md)
     * [On 4.x](features/indexer/4.0.0-less-than-5.0.0.md)
     * [On 3.x](features/indexer/legacy-indexer.md)
   * [Customer Group Pricing](features/customer-group-pricing.md)

features/indexer/on-7.x.md

@@ -0,0 +1,137 @@
+# On 7.x
+
+![](https://img.shields.io/badge/nosto-%3E%3D%205.0.0-green)
+
+Indexer logic changed in \(5.0.0\) in order to avoid blocking other indexing processing. As of 5.0.0 the product data is building is done in [bulk operations](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/message-queues/bulk-operations.html).
+
+Version > 5.0.0 has two indexers `Nosto Product Queue`_\(nosto\_index\_product\_queue\)_ and `Nosto Product Queue Processor`_\(nosto\_index\_product\_queue\_processor\)_. The first indexer \(_nosto\_index\_product\_queue_\) listens for product changes in Magento and adds the changed product ids into a queue. The second indexer \(_nosto\_index\_product\_queue\_processor\)_ fetches the product ids from the queue, merges the queues when possible, removes duplicated product ids and sends the product ids to the bulk operation that builds the product data and sends the data to Nosto. [The cache](../product-data-caching/built-in-caching.md) is also updated in bulk operations.
+
+To further optimise the process, the bulk operations can be configured to use [message queues](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/message-queues/message-queues.html).
+
+## Manually Running the Indexer
+
+You can run a full reindex of the product catalog by using Magento's built-in CLI indexer.
+
+To reindex all products, re-run the indexer:
+
+* _nosto\_index\_product_ indexer
+
+  ```bash
+  bin/magento indexer:reset nosto_index_product
+  bin/magento indexer:reindex nosto_index_product
+  ```
+
+## Indexer Parallelisation
+
+Starting with version 2.2.6 Magento [supports parallel reindexing](https://community.magento.com/t5/Magento-DevBlog/Indexers-parallelization-and-optimization/ba-p/104922). Nosto's indexers support parallelization and both the Nosto indexers can be executed in parallel mode. The indexers are scoped based on stores. This means that if a merchant has n-stores, there will be n-processes running in parallel, each indexing a specific store \(also called a "Dimension"\).
+
+There are a few steps to be taken before enabling parallelisation:
+
+#### Check the dimension mode for the indexer
+
+```text
+bin/magento indexer:show-dimensions-mode
+Product Price:                                     none
+Nosto Product Indexer :                            none
+```
+
+#### Set the indexer mode to `store`
+
+```bash
+bin/magento indexer:set-dimensions-mode nosto_index_product store
+```
+> Dimensions mode for indexer "Nosto Product Indexer" was changed from 'none' to 'store'
+
+
+Make sure that the number of threads declared in the env variable `MAGE_INDEXER_THREADS_COUNT` is equal to the max number of stores.
+
+For testing purposes, it can be declared in the CLI, like:
+
+```bash
+MAGE_INDEXER_THREADS_COUNT=3 php -f bin/magento indexer:reindex nosto_index_product
+```
+
+Nosto module uses [Magento's Bulk Operations](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/message-queues/bulk-operations.html) and [Message Queues](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/message-queues/message-queues.html) for rebuilding the product data, populating the product cache and synchronising the product data to Nosto over API. By default the message queues are backed by MySQL but Magento also supports [using RabbitMQ](https://devdocs.magento.com/guides/v2.3/install-gde/prereq/install-rabbitmq.html) for message queues.
+
+## Using Message Queues \(RabbitMQ\)
+
+In order to make Nosto module to use RabbitMQ for message queue processing you need to override the message queue configuration files under Nosto module. You must define the value of `connection` attribute to be `amqp` instead of `db` to the following files. You might also want rename the `exchange` across the configurations files to something else than `magento-db`.
+
+* [etc/queue\_consumer.xml](https://github.com/Nosto/nosto-magento2/blob/master/etc/queue_consumer.xml) 
+* [etc/queue\_publisher.xml](https://github.com/Nosto/nosto-magento2/blob/master/etc/queue_publisher.xml)
+* [etc/queue\_topology.xml](https://github.com/Nosto/nosto-magento2/blob/master/etc/queue_topology.xml)
+
+We recommend also deleting the file [queue.xml](https://github.com/Nosto/nosto-magento2/blob/master/etc/queue.xml) as it's only used when Message Queues are using MySQL.
+
+After the configuration files have been overridden you must run `bin/magento setup:upgrade`.
+
+For overriding the message queue configuration you can use for example [Magento's patches.](https://devdocs.magento.com/guides/v2.3/comp-mgr/patching.html)
+
+## Best Practices
+
+We recommend the following best practices for Nosto indexers.
+
+* We strongly advise that the indexer mode is set to `Update by Schedule` for better performance. This will also make the product updates to Nosto more reliable. For example, the scheduled catalog price rules would not be updated in real-time to Nosto unless the indexer mode is set to  `Update by Schedule` 
+* If you have multiple store views, we recommend that you enable multi-dimensional indexing.
+
+## Troubleshoot
+
+If you are having issues with indexing you want to first enable Magento's debug logging [https://devdocs.magento.com/guides/v2.3/config-guide/cli/logging.html](https://devdocs.magento.com/guides/v2.3/config-guide/cli/logging.html). This will enable more verbose logging for the indexing. You will find indexing related logs from debug log \(`debug.log` by default\). All log entries are prefixed with "nosto".‌
+
+### Indexer is not keeping up with product updates <a id="indexer-is-not-keeping-up-with-product-updates"></a>
+
+‌If you are frequently updating massive amount of products \(for example via API or import\) there's a chance that the indexer cannot process the previous update before the next update batch is executed. In these cases we recommend [parallelising the indexer](https://docs.nosto.com/magento-2/features/indexer/on-5.x#indexer-parallelisation) as a first step.‌
+
+We also recommend figuring out the source of frequent product updates and do optimisations for the [mview subscriptions / triggers](https://github.com/Nosto/nosto-magento2/blob/master/etc/mview.xml#L38). For example if you are using 3rd party module / integration that updates all product images frequently but those images are not used for recommendations you might want to remove [gallery related subscriptions](https://github.com/Nosto/nosto-magento2/blob/master/etc/mview.xml#L45-L46). Modifying the `mview.xml` file can be done for example using [Magento's patches](https://devdocs.magento.com/guides/v2.3/comp-mgr/patching.html).‌
+
+### Warning about `innodb_buffer_pool_size` <a id="warning-about-innodb_buffer_pool_size"></a>
+
+You will most likely see this warning in your Magento logs if you've installed MySQL using the defaults. To get rid of this warning we recommend increasing `innodb_buffer_pool_size` on you MySQL server configuration. You can find more info about indexer optimization from [the official Magento documentation](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/indexer-batch.html).‌
+
+### Products not synchronized to Nosto <a id="products-not-synchronized-to-nosto"></a>
+
+If the product data is not synchronized to Nosto check the following steps:   
+
+1. The `Product Updates via API` flag is enabled. The flag can be found under `Store > Settings > Configurations > Services > Nosto > Feature Flags`. If disabled, please enable the flag   
+
+2. Set the Nosto indexer mode to `Update by Schedule`.
+
+3. Verify the message queue consumers `nosto_product_sync.update` and `nosto_product_sync.delete` are running. Magento cron should take care of running \(and restarting if needed\) the consumers automatically. Cron group name is `consumers`.   
+For testing purpose our consumers can be started by running `bin/magento queue:consumers:start nosto_product_sync.update & bin/magento queue:consumer:start nosto_product_sync.delete &`   
+\(CAUTION! The process started by this command will not terminate and restart automatically\)   
+
+4. Check that messages are being published. If your M2 instance is using MySQL for MQ, the messages can be found in `queue_message` table.   
+
+5. Check that the messages are being consumed. Magento operation results can be found in `magento_operation` table. Check that `magento_operation` has entries with the topic named `nosto_product_sync.update`.      
+
+6. If you are using MySQL 8 or MariaDB &gt; 10.2.3, you can use the following query to have better visibility on the products that are being sent to Nosto
+
+```sql
+SELECT 
+    CONVERT(op.bulk_uuid USING utf8) as uuid,
+    JSON_EXTRACT(CONVERT(op.serialized_data USING utf8), "$.product_ids") as products,  
+    JSON_LENGTH(JSON_EXTRACT(CONVERT(op.serialized_data USING utf8), "$.product_ids")) as product_count,
+    op.status, 
+    op.error_code,
+    op.result_message,        
+    bulk.start_time
+FROM 
+    magento2.magento_operation as op
+JOIN 
+    magento2.magento_bulk as bulk
+ON
+    op.bulk_uuid = bulk.uuid
+WHERE 
+    op.topic_name = "nosto_product_sync.update"
+```
+
+### Bulk attribute updates not synchronized to Nosto <a id="bulk-attribute-updates-not-synchronized-to-nosto"></a>
+
+If you have the indexer running on mode "Update by save" the bulk operations are not automatically reflected to Nosto. This is due to how Magento processes bulk updates internally.‌
+
+It is highly recommended to run all indexers in mode "Update by schedule".‌
+
+### Nosto indexer runs after Nosto module settings are changed ‌ <a id="nosto-indexer-is-blocking-other-magento-indexers"></a>
+
+This happens by design. When Nosto settings that affect Nosto product data are changed and indexers are defined to be run in mode "Update By Schedule" Nosto will automatically initialise a full reindex to keep the product data up to date.
+