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 organization’s QPS quota. This is to account for multiple CM or CD instances.

    If the number is higher than your organization quota, the quota applies. You can review your quota on the License & Usage (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console. To increase your quota, email the Coveo subscription team.

    		 
    <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 organization’s query suggestions per second quota. This is to account for multiple CM or CD instances.

    If the number is higher than your organization quota, the quota applies. You can review your quota on the License & Usage (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console. To increase it, email the Coveo subscription team.

    		 
    <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, twice the default value 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>