THIS IS ARCHIVED DOCUMENTATION

Configuring the Query Rate Limit

This is for:

Developer System Administrator

Coveo for Sitecore (October 2016)

In the October 2016 release of Coveo for Sitecore, a query rate limit was introduced 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, open the Coveo.SearchProvider.Rest.Custom.config file. It’s located under <Sitecore Instance>\Website\App_Config\Include\Coveo (for Sitecore 8 instances) or under <Sitecore Instance>\App_Config\Include\Coveo (for Sitecore 9 instances).

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

Name Description Example value
queryRateLimit

The maximum number 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.

To increase the license limit, contact Coveo Support.

 <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 a Limit of query reached description.

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