Rbroughan/add retry docs #29421
Rbroughan/add retry docs #29421
Conversation
|
|
octavia-squidington-iii
added
the
area/documentation
| * 10 total attempts where no data was synchronized | ||
| * 10 total attempts where some data was synchronized | ||
|
|
||
| For oss users, these values are configurable. See [Configuring Airbyte](../operator-guides/configuring-airbyte.md#jobs) for more details. |
|
|
||
| * 5 subsequent attempts where no data was synchronized | ||
| * 10 total attempts where no data was synchronized | ||
| * 10 total attempts where some data was synchronized |
There was a problem hiding this comment.
nit: probably useful to add an example for illustration here, especially for a more complicated case of combination of partial and failed attempts and backoffs.
e.g.
attempt 1: partial success
attempt 2: failed
attempt 3: failed
attempt 4: partial success
There was a problem hiding this comment.
probably after the retry backoff section so we cover the entire feature fully.
There was a problem hiding this comment.
Any ideas on what kind of visualization would work best? All I can think of is a table
There was a problem hiding this comment.
a table seems fine to start.
the main thing is to be explain when backoff happens and how the configured variable affect how many failed attempts and total attempt in a complicated case.
There was a problem hiding this comment.
I'll take a pass at a table
| @@ -10,7 +10,7 @@ To review the sync summary: | |||
|
|
|||
| :::note | |||
|
|
|||
| Airbyte will try to sync your data five times. After a fifth failure, it will stop attempting to sync. | |||
| In the event of a failure, Airbyte will make several attempts to sync your data before giving up. The latest rules can be read about [here](../../understanding-airbyte/jobs.md#retry-rules). | |||
There was a problem hiding this comment.
nit: since Airbyte Cloud can have different retry configs from OSS, I wonder if we should have explicit Airbyte Cloud configs listed here.
for now, probably no need since Cloud <> OSS is the same.
* Update docs with basic attempt information. * Add backoff and env vars docs. * Currently -> by default. * Add retry attempt example tables.
What
Adds docs for new retry behavior. To be merged after OSS released.
How
Updates some docs
Recommended reading order
N/A
Let me know if I need to take any further steps to get the docs properly updated.