[Cosmos] add doc on client retry configs#30171
Merged
simorenoh merged 14 commits intoAzure:mainfrom May 17, 2023
Merged
Conversation
simorenoh
requested review from
annatisch,
bambriz,
kushagraThapar,
simplynaveen20 and
xinlian12
as code owners
Member
Author
|
Before: After: |
Collaborator
|
API change check API changes are not detected in this pull request. |
ealsur
reviewed
May 2, 2023
ealsur
reviewed
May 2, 2023
ealsur
approved these changes
May 4, 2023
annatisch
reviewed
May 8, 2023
Co-authored-by: Matias Quaranta <ealsur@users.noreply.github.com>
Co-authored-by: Matias Quaranta <ealsur@users.noreply.github.com>
Member
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
annatisch
reviewed
May 16, 2023
annatisch
reviewed
May 16, 2023
annatisch
reviewed
May 16, 2023
annatisch
reviewed
May 16, 2023
annatisch
approved these changes
May 17, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This PR adds one more document for our users to leverage when using our SDK. This document specifies the different options that can be used to change the default configurations our client uses for timeouts and retrying connections. With these, users should have additional visibility into the use they can get from the SDK. Other small changes include the removal of some of the logic in our 408/503 policy and the refactoring of how some of our connection policy pieces get built.
For the timeout retry policy, we no longer mark the endpoint as unavailable, as a 408/503 doesn't necessarily point to the endpoint being unavailable and can happen by several other reasons. Changes have been made to ensure we do not do this. The document we had talking about these retries has also been changed to reflect these changes and was simplified to show that we do not retry regardless of the scenario (server vs. client timeout).
We also mark the
request_timeoutoption as legacy for future reference, but show that theconnection_timeoutvariable is the one that should be used instead.Wondering if we should add a reference to this document anywhere as well, since it dives into the different things Core does: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md