Diagnose and troubleshoot "request header too large" or "bad request" messages in Azure Cosmos DB SDK for .NET

APPLIES TO: NoSQL

The "Request header too large" message is thrown with an HTTP error code 400. This error occurs if the size of the request header has grown so large that it exceeds the maximum-allowed size. We recommend that you use the latest version of the Azure Cosmos DB SDK for .NET. We recommend that you use version 3.x because this major version adds header size tracing to the exception message.

The "Request header too large" message occurs if the session or the continuation token is too large. The following sections describe the cause of the issue and its solution in each category.

This section reviews scenarios where the session token is too large.

A 400 bad request most likely occurs because the session token is too large. If the following statements are true, the session token is too large:

• The error occurs on point operations like create, read, and update where there isn't a continuation token.
• The exception started without making any changes to the application. The session token grows as the number of partitions increases in the container. The number of partitions increases as the amount of data increases or if the throughput is increased.

Restart your client application to reset all the session tokens. Eventually, the session token grows back to the previous size that caused the issue. To avoid this issue completely, use the solution in the next section.

1. Follow the guidance in the .NET v3 or .NET v2 performance tips articles. Convert the application to use the direct connection mode with the Transmission Control Protocol (TCP). The direct connection mode with the TCP protocol doesn't have the header size restriction like the HTTP protocol, so it avoids this issue. Make sure to use the latest version of the SDK, which has a fix for query operations when the service interop isn't available.
2. If the direct connection mode with the TCP protocol isn't an option for your workload, mitigate it by changing the client consistency level. The session token is only used for session consistency, which is the default consistency level for Azure Cosmos DB. Other consistency levels don't use the session token.

This section reviews scenarios where the continuation token is too large.

The 400 bad request occurs on query operations where the continuation token is used if the token has grown too large. This error can also occur if different queries have different continuation token sizes.

1. Follow the guidance in the .NET v3 or .NET v2 performance tips articles. Convert the application to use the direct connection mode with the TCP protocol. The direct connection mode with the TCP protocol doesn't have the header size restriction like the HTTP protocol, so it avoids this issue.
2. If the direct connection mode with the TCP protocol isn't an option for your workload, set the ResponseContinuationTokenLimitInKb option. You can find this option in FeedOptions in v2 or QueryRequestOptions in v3.

• Diagnose and troubleshoot issues when you use the Azure Cosmos DB .NET SDK.
• Learn about performance guidelines for .NET v3 and .NET v2.