HCL Commerce Version or later

Collecting Elasticsearch based search-related MustGather data for Search rule issues

Prepare the following MustGather information before you call HCL Support to help with the troubleshooting process.


  1. Log into the Query server Docker container. Locate the directory /profile/apps/search-query.ear/search-query.war/WEB-INF/classes. In this directory, open in a text editor the logback.xml file. Change the trace configuration setting in the file from "error" to "all."
    <logger name="com.hcl.commerce.search" level="all" />
  2. Verify that the file contains the following configuration scan parameters.
    <configuration scan="true" scanPeriod="30 seconds" />

    If you are not already using these parameters, restart the Query server in order for your changes picked up. If you do not do this, you will wait for scanPeriod seconds for the change to take effect.

    Note: To change the log level for the search query service with the above settings, disable the turbo filter by commenting out the turbo filter tag in the logback.xml file. Disabling turbo filter will disable request level tracing.
    <!-- <turboFilter class="ch.qos.logback.classic.turbo.DynamicThresholdFilter">
    </turboFilter> -->
  3. Reproduce your search rule issue. Record the specific steps that you used to reproduce the problem and any details that might be relevant.
  4. Collect the trace files generated in the following directory.
  5. Save the response to the following REST APIs
    GET https://{{transaction_hostname}}/wcs/resources/store/{{storeId}}/espot?q=allSearchTerms
    GET https://{{transaction_hostname}}/wcs/resources/store/{{storeId}}/espot/{{search_term}}/type/search
    where {{search_term}} is the search term on which the search rule is triggered.