fix: updates write reponses, suggests exponential backoffs #6574
+144
−128
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates write response documentation for InfluxDB Cloud Dedicated and InfluxDB Clustered by removing references to Retry-After headers (which are no longer sent by these products) and adding comprehensive guidance on implementing exponential backoff strategies for handling 429 and 503 errors.
Key changes:
- Removes
Retry-Afterheader specifications from API response definitions for 429 and 503 status codes - Updates error descriptions to clarify when 429 and 503 errors occur (resource constraints, concurrent request limits, insufficient healthy ingesters)
- Adds new documentation section with exponential backoff implementation examples in cURL, Python, and JavaScript
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| content/shared/influxdb3-write-guides/troubleshoot-distributed.md | Adds exponential backoff strategy section with code examples and best practices; updates 503 error description to reference new backoff guidance |
| api-docs/influxdb3/clustered/v2/ref.yml | Removes Retry-After headers from 429/503 responses; updates error descriptions for write and query endpoints |
| api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | Removes Retry-After headers from 429 responses for write and query endpoints; updates error descriptions |
| api-docs/influxdb3/cloud-dedicated/v2/ref.yml | Removes Retry-After headers from 429/503 responses; updates error descriptions to clarify resource constraints |
| api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | Removes Retry-After headers from 429 responses; updates error descriptions for write and query endpoints |
content/shared/influxdb3-write-guides/troubleshoot-distributed.md
Outdated
Show resolved
Hide resolved
content/shared/influxdb3-write-guides/troubleshoot-distributed.md
Outdated
Show resolved
Hide resolved
content/shared/influxdb3-write-guides/troubleshoot-distributed.md
Outdated
Show resolved
Hide resolved
content/shared/influxdb3-write-guides/troubleshoot-distributed.md
Outdated
Show resolved
Hide resolved
content/shared/influxdb3-write-guides/troubleshoot-distributed.md
Outdated
Show resolved
Hide resolved
jstirnaman
requested changes
Nov 27, 2025
| <!--pytest.mark.skip--> | ||
| ```sh | ||
| base=1 | ||
| max_delay=30 |
|
|
||
| # compute exponential delay and apply full jitter | ||
| delay=$(awk -v b=$base -v a=$attempt 'BEGIN{d=b*(2^a); if(d>30) d=30; print d}') | ||
| sleep_seconds=$(awk -v d=$delay 'BEGIN{srand(); printf "%.3f", rand()*d}') |
| ### Incremental backoff best practices | ||
|
|
||
| - Only retry on idempotent or safe request semantics your client supports. | ||
| - Retry only for `429` (Too Many Requests) and `503` (Service Unavailable). |
Contributor
There was a problem hiding this comment.
Should we include "Too Many Requests" in the spec (as Copilot recommended)?
2 tasks
Contributor
|
@jstirnaman I've opened a new pull request, #6575, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
#6575) * Initial plan * Fix: use $max_delay variable instead of hardcoded 30 in cURL example Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
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.
Closes influxdata/DAR#557
Retry-Afterheaders from InfluxDB Cloud Dedicated and InfluxDB Clustered API responses