Tracing: Adds tracing improvements for pkrange refresh calls #5511
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NaluTripician
requested review from
FabianMeiswinkel,
Pilchie,
kirankumarkolli and
sboshra
as code owners
kirankumarkolli
requested changes
Nov 24, 2025
Member
kirankumarkolli
left a comment
kirankumarkolli
left a comment
There was a problem hiding this comment.
Please check comments
xinlian12
reviewed
Nov 24, 2025
Microsoft.Azure.Cosmos/src/MetadataRequestThrottleRetryPolicy.cs
Outdated
Show resolved
Hide resolved
xinlian12
reviewed
Nov 24, 2025
Microsoft.Azure.Cosmos/src/MetadataRequestThrottleRetryPolicy.cs
Outdated
Show resolved
Hide resolved
xinlian12
reviewed
Nov 24, 2025
xinlian12
reviewed
Nov 24, 2025
kirankumarkolli
approved these changes
Nov 25, 2025
microsoft-github-policy-service
bot
deleted the
users/nalutripician/pkRangeTracingImprovements
branch
NaluTripician
added a commit
that referenced
this pull request
Jan 14, 2026
# Pull Request Template ## Description This pull request adds enhanced trace logging to improve observability and debugging of metadata request routing and partition key range cache operations in the Cosmos DB SDK. The most important changes are the addition of detailed trace information for exception handling, request routing, and partition key range cache responses. **Enhanced Exception and Request Logging:** * Added trace logs to `ShouldRetryAsync` in `MetadataRequestThrottleRetryPolicy` to record `StatusCode` and `SubStatusCode` for both `CosmosException` and `DocumentClientException` when evaluating retry logic. [[1]](diffhunk://#diff-a5ed5985909c3dcb6e4ce186cdd662d590dac5297ea14e68560c7d1eca307be4R96) [[2]](diffhunk://#diff-a5ed5985909c3dcb6e4ce186cdd662d590dac5297ea14e68560c7d1eca307be4R106) * Updated trace logging in `OnBeforeSendRequest` to include `collectionName` and `collectionRid` when routing metadata requests, providing more context for diagnostics. **Partition Key Range Cache Diagnostics:** * Added trace logging in `GetRoutingMapForCollectionAsync` to output `collectionRid`, `StatusCode`, `SubstatusCode`, and the ETag value (`ChangeFeedNextIfNoneMatch`) for each response, aiding in troubleshooting partition key range cache issues. ## Type of change Please delete options that are not relevant. - [] New feature (non-breaking change which adds functionality) ## Closing issues To automatically close an issue: closes #IssueNumber
This was referenced Jan 23, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
This pull request adds enhanced trace logging to improve observability and debugging of metadata request routing and partition key range cache operations in the Cosmos DB SDK. The most important changes are the addition of detailed trace information for exception handling, request routing, and partition key range cache responses.
Enhanced Exception and Request Logging:
ShouldRetryAsyncinMetadataRequestThrottleRetryPolicyto recordStatusCodeandSubStatusCodefor bothCosmosExceptionandDocumentClientExceptionwhen evaluating retry logic. [1] [2]OnBeforeSendRequestto includecollectionNameandcollectionRidwhen routing metadata requests, providing more context for diagnostics.Partition Key Range Cache Diagnostics:
GetRoutingMapForCollectionAsyncto outputcollectionRid,StatusCode,SubstatusCode, and the ETag value (ChangeFeedNextIfNoneMatch) for each response, aiding in troubleshooting partition key range cache issues.Type of change
Please delete options that are not relevant.
Closing issues
To automatically close an issue: closes #IssueNumber