Configure the query rate limit

This is for:

Developer System Administrator

In Coveo for Sitecore, a query rate limit is set to mitigate the outgoing communication to the Coveo index. While the default settings fit the needs of most installations, you might want to customize them further.

To configure these settings

  1. Open the <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo\Coveo.SearchProvider.Rest.Custom.config file in a text editor.

  2. In the sitecore\coveo\restEndpointConfiguration node, add/edit the following parameters:

    Name Description Example value

    Coveo for Sitecore 5.0.788.5

    queryQuotaPerOrgLimit

    The maximum number of queries per second (QPS) that can be sent to the platform.

    The default value is half of your license QPS. This is to account for many CM or CD instances.

    If the number is set higher than the one specified in the license, the license limit is applied.

    Note

    To increase the license limit, contact Coveo Support

    		 
    <queryQuotaPerOrgLimit>
   30
</queryQuotaPerOrgLimit>

    Coveo for Sitecore 5.0.788.5

    querySuggestQuotaPerOrgLimit

    The maximum number query suggestions per second that can be sent to the platform.

    The default value is half of your license query suggestions per second. This is to account for many CM or CD instances.

    If the number is set higher than the one specified in the license, the license limit is applied.

    Note

    To increase the license limit, contact Coveo Support

    		 
    <querySuggestQuotaPerOrgLimit>
   50
</querySuggestQuotaPerOrgLimit>

    Deprecated

    queryRateLimit

    The maximum number queries per second (QPS) that can be sent to the platform.

    The default value is 10.

    If the number is set higher than twice the default value, this limit is applied.

    Important

    This parameter has been deprecated. If you’re using the September 18, 2020 release of Coveo for Sitecore or a more recent version, use queryQuotaPerOrgLimit instead.

    		 
    <queryRateLimit>
   10
</queryRateLimit>

    maximumQueryRateLimitLatency

    The maximum amount of time a query is queued before sending a too many requests response (status code 429).

    The default value is 00:00:05, which is five seconds.

    You can see the request error in the Sitecore logs as a WARN with the description Limit of query reached.

    		 
    <maximumQueryRateLimitLatency>
   00:00:05
</maximumQueryRateLimitLatency>