You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/07/30 16:06:32 UTC
[GitHub] [arrow-rs] tustvold opened a new pull request, #2243: Retry GCP requests on server error
tustvold opened a new pull request, #2243:
URL: https://github.com/apache/arrow-rs/pull/2243
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
Closes #.
Relates to #2176
# Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
The S3 implementation currently has request retry support, as we look to move away from rusoto we need to ensure we can preserve this functionality. This PR therefore adds the necessary functionality to the GCP implementation, which can then be reused for AWS and Azure once they switch away from using SDKs.
# What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
Adds an implementation of exponential backoff, lifted wholesale from the implementation I wrote for [rskafa](https://github.com/influxdata/rskafka/pull/4/files#diff-092b3e65476a76384f9f069bfb43cc2a647107f1f27e0d06eee35b1865ec0596).
# Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking change` label.
-->
Technically yes, GCP requests will now be automatically retried. We could change the default to avoid this but I think it is unlikely to cause issue
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] alamb merged pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
alamb merged PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
tustvold commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r934370802
##########
object_store/Cargo.toml:
##########
@@ -48,6 +48,7 @@ quick-xml = { version = "0.23.0", features = ["serialize"], optional = true }
rustls-pemfile = { version = "1.0", default-features = false, optional = true }
ring = { version = "0.16", default-features = false, features = ["std"] }
base64 = { version = "0.13", default-features = false, optional = true }
+rand = { version = "0.8", optional = true, features = ["std", "std_rng"] }
Review Comment:
I was following the pattern established above, I'm not really sure which is better tbh. Using default-features is nice, but some crates have lots, I went for consistency
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] crepererum commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
crepererum commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r934308485
##########
object_store/src/client/backoff.rs:
##########
@@ -0,0 +1,156 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use rand::prelude::*;
+use std::time::Duration;
+
+/// Exponential backoff with jitter
+///
+/// See <https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/>
+#[allow(missing_copy_implementations)]
+#[derive(Debug, Clone)]
+pub struct BackoffConfig {
+ /// The initial backoff duration
+ pub init_backoff: Duration,
+ /// The maximum backoff duration
+ pub max_backoff: Duration,
+ /// The base of the exponential to use
+ pub base: f64,
+}
+
+impl Default for BackoffConfig {
+ fn default() -> Self {
+ Self {
+ init_backoff: Duration::from_millis(100),
+ max_backoff: Duration::from_secs(15),
+ base: 2.,
+ }
+ }
+}
+
+/// [`Backoff`] can be created from a [`BackoffConfig`]
+///
+/// Consecutive calls to [`Backoff::next`] will return the next backoff interval
+///
+pub struct Backoff {
+ init_backoff: f64,
+ next_backoff_secs: f64,
+ max_backoff_secs: f64,
+ base: f64,
+ rng: Option<Box<dyn RngCore + Sync + Send>>,
+}
+
+impl std::fmt::Debug for Backoff {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ f.debug_struct("Backoff")
+ .field("init_backoff", &self.init_backoff)
+ .field("next_backoff_secs", &self.next_backoff_secs)
+ .field("max_backoff_secs", &self.max_backoff_secs)
+ .field("base", &self.base)
+ .finish()
+ }
+}
+
+impl Backoff {
+ /// Create a new [`Backoff`] from the provided [`BackoffConfig`]
+ pub fn new(config: &BackoffConfig) -> Self {
+ Self::new_with_rng(config, None)
+ }
+
+ /// Creates a new `Backoff` with the optional `rng`
+ ///
+ /// Used [`rand::thread_rng()`] if no rng provided
+ pub fn new_with_rng(
+ config: &BackoffConfig,
+ rng: Option<Box<dyn RngCore + Sync + Send>>,
+ ) -> Self {
+ let init_backoff = config.init_backoff.as_secs_f64();
+ Self {
+ init_backoff,
+ next_backoff_secs: init_backoff,
+ max_backoff_secs: config.max_backoff.as_secs_f64(),
+ base: config.base,
+ rng,
+ }
+ }
+
+ /// Returns the next backoff duration to wait for
+ pub fn next(&mut self) -> Duration {
+ let range = self.init_backoff..(self.next_backoff_secs * self.base);
+
+ let rand_backoff = match self.rng.as_mut() {
+ Some(rng) => rng.gen_range(range),
+ None => thread_rng().gen_range(range),
+ };
+
+ let next_backoff = self.max_backoff_secs.min(rand_backoff);
+ Duration::from_secs_f64(std::mem::replace(
+ &mut self.next_backoff_secs,
+ next_backoff,
+ ))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use rand::rngs::mock::StepRng;
Review Comment:
TIL that there's `rand::rngs::mock` :+1:
##########
object_store/src/client/retry.rs:
##########
@@ -0,0 +1,103 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! A shared HTTP client implementation incorporating retries
+
+use crate::client::backoff::{Backoff, BackoffConfig};
+use futures::future::BoxFuture;
+use futures::FutureExt;
+use reqwest::{Response, Result};
+use std::time::{Duration, Instant};
+
+/// Contains the configuration for how to respond to server errors
+///
+/// By default they will be retried up to some limit, using exponential
+/// backoff with jitter. See [`BackoffConfig`] for more information
+///
+#[derive(Debug, Clone)]
+pub struct RetryConfig {
+ /// The backoff configuration
+ pub backoff: BackoffConfig,
+
+ /// The maximum number of times to retry a request
+ ///
+ /// Set to 0 to disable retries
+ pub max_retries: usize,
+
+ /// The maximum length of time from the initial request
+ /// after which no further retries will be attempted
+ ///
+ /// This not only bounds the length of time before a server
+ /// error will be surfaced to the application, but also bounds
+ /// the length of time a request's credentials must remain valid.
+ ///
+ /// As requests are retried without renewing credentials or
+ /// regenerating request payloads, this number should be kept
+ /// below 5 minutes to avoid errors due to expired credentials
+ /// and/or request payloads
+ pub retry_timeout: Duration,
+}
+
+impl Default for RetryConfig {
+ fn default() -> Self {
+ Self {
+ backoff: Default::default(),
+ max_retries: 10,
+ retry_timeout: Duration::from_secs(3 * 60),
+ }
+ }
+}
+
+pub trait RetryExt {
+ /// Dispatch a request with the given retry configuration
+ ///
+ /// # Panic
+ ///
+ /// This will panic if the request body is a stream
+ fn send_retry(self, config: &RetryConfig) -> BoxFuture<'static, Result<Response>>;
+}
+
+impl RetryExt for reqwest::RequestBuilder {
+ fn send_retry(self, config: &RetryConfig) -> BoxFuture<'static, Result<Response>> {
Review Comment:
Some logging would be nice here for:
- retries
- giving up
##########
object_store/Cargo.toml:
##########
@@ -48,6 +48,7 @@ quick-xml = { version = "0.23.0", features = ["serialize"], optional = true }
rustls-pemfile = { version = "1.0", default-features = false, optional = true }
ring = { version = "0.16", default-features = false, features = ["std"] }
base64 = { version = "0.13", default-features = false, optional = true }
+rand = { version = "0.8", optional = true, features = ["std", "std_rng"] }
Review Comment:
The features listed here are actually the default features that should always be included. So you could remove the explicit listing or pass `default-features = false` to prevent a silent extension of this feature set.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
tustvold commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r934376348
##########
object_store/Cargo.toml:
##########
@@ -48,6 +48,7 @@ quick-xml = { version = "0.23.0", features = ["serialize"], optional = true }
rustls-pemfile = { version = "1.0", default-features = false, optional = true }
ring = { version = "0.16", default-features = false, features = ["std"] }
base64 = { version = "0.13", default-features = false, optional = true }
+rand = { version = "0.8", optional = true, features = ["std", "std_rng"] }
Review Comment:
Oh, oops, yeah that's a typo :sweat_smile:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] crepererum commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
crepererum commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r934375852
##########
object_store/Cargo.toml:
##########
@@ -48,6 +48,7 @@ quick-xml = { version = "0.23.0", features = ["serialize"], optional = true }
rustls-pemfile = { version = "1.0", default-features = false, optional = true }
ring = { version = "0.16", default-features = false, features = ["std"] }
base64 = { version = "0.13", default-features = false, optional = true }
+rand = { version = "0.8", optional = true, features = ["std", "std_rng"] }
Review Comment:
But the crates above also use `default-features = false` which `rand` now doesn't.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] ursabot commented on pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#issuecomment-1203752084
Benchmark runs are scheduled for baseline = b8261629f3d197c5bc40e66a0356a51706ebab96 and contender = 299908ee0c12edb1e720ed9a0465cb7af8352cb3. 299908ee0c12edb1e720ed9a0465cb7af8352cb3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/02e760b762824da3b9a884291e338d15...b7281a35fc064650828888587dcd88c8/)
[Skipped :warning: Benchmarking of arrow-rs-commits is not supported on test-mac-arm] [test-mac-arm](https://conbench.ursa.dev/compare/runs/70a1982f5c3a42158a4331a90151e537...1cca6a8fc7704324a3e2464034e75a3b/)
[Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/07b3c7d0ab8f402da19499eae4431c6e...c2598aab4a014a06ad33c5e8f7aaba5e/)
[Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/dfb330cbb2cf437aa33f175f6b63913f...66a4aa43a8a34fbe88cd85b943eee81e/)
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
tustvold commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r933881306
##########
object_store/src/client/retry.rs:
##########
@@ -0,0 +1,90 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! A shared HTTP client implementation incorporating retries
+
+use crate::client::backoff::{Backoff, BackoffConfig};
+use futures::future::BoxFuture;
+use futures::FutureExt;
+use reqwest::{Response, Result};
+
+/// Contains the configuration for how to respond to server errors
+///
+/// By default they will be retried up to some limit, using exponential
+/// backoff with jitter. See [`BackoffConfig`] for more information
+///
+/// Note: requests are retried without renewing credentials or regenerating
Review Comment:
We could theoretically re-sign requests / regenerate credentials, however, I decided against this for a couple of reasons:
* It's non-trivial additional complexity
* The intent of this feature is to hide intermittent failures, a 5 minute outage is not really intermittent
* We want to surface the error to the user eventually
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] codecov-commenter commented on pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
codecov-commenter commented on PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#issuecomment-1200247889
# [Codecov](https://codecov.io/gh/apache/arrow-rs/pull/2243?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#2243](https://codecov.io/gh/apache/arrow-rs/pull/2243?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (e8718ff) into [master](https://codecov.io/gh/apache/arrow-rs/commit/f41fb1c833c4d89dd1d11fb08200bbe36722b2ca?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (f41fb1c) will **decrease** coverage by `0.06%`.
> The diff coverage is `0.00%`.
```diff
@@ Coverage Diff @@
## master #2243 +/- ##
==========================================
- Coverage 82.30% 82.23% -0.07%
==========================================
Files 241 243 +2
Lines 62437 62493 +56
==========================================
+ Hits 51389 51392 +3
- Misses 11048 11101 +53
```
| [Impacted Files](https://codecov.io/gh/apache/arrow-rs/pull/2243?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [object\_store/src/client/backoff.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-b2JqZWN0X3N0b3JlL3NyYy9jbGllbnQvYmFja29mZi5ycw==) | `0.00% <0.00%> (ø)` | |
| [object\_store/src/client/oauth.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-b2JqZWN0X3N0b3JlL3NyYy9jbGllbnQvb2F1dGgucnM=) | `0.00% <0.00%> (ø)` | |
| [object\_store/src/client/retry.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-b2JqZWN0X3N0b3JlL3NyYy9jbGllbnQvcmV0cnkucnM=) | `0.00% <0.00%> (ø)` | |
| [object\_store/src/client/token.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-b2JqZWN0X3N0b3JlL3NyYy9jbGllbnQvdG9rZW4ucnM=) | `0.00% <ø> (ø)` | |
| [object\_store/src/gcp.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-b2JqZWN0X3N0b3JlL3NyYy9nY3AucnM=) | `0.00% <0.00%> (ø)` | |
| [object\_store/src/lib.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-b2JqZWN0X3N0b3JlL3NyYy9saWIucnM=) | `86.75% <ø> (ø)` | |
| [...row/src/array/builder/string\_dictionary\_builder.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-YXJyb3cvc3JjL2FycmF5L2J1aWxkZXIvc3RyaW5nX2RpY3Rpb25hcnlfYnVpbGRlci5ycw==) | `90.64% <0.00%> (-0.72%)` | :arrow_down: |
| [parquet\_derive/src/parquet\_field.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGFycXVldF9kZXJpdmUvc3JjL3BhcnF1ZXRfZmllbGQucnM=) | `65.75% <0.00%> (-0.23%)` | :arrow_down: |
| [arrow/src/datatypes/datatype.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-YXJyb3cvc3JjL2RhdGF0eXBlcy9kYXRhdHlwZS5ycw==) | `63.00% <0.00%> (+0.31%)` | :arrow_up: |
| [...rquet/src/arrow/record\_reader/definition\_levels.rs](https://codecov.io/gh/apache/arrow-rs/pull/2243/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGFycXVldC9zcmMvYXJyb3cvcmVjb3JkX3JlYWRlci9kZWZpbml0aW9uX2xldmVscy5ycw==) | `89.02% <0.00%> (+1.68%)` | :arrow_up: |
Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
tustvold commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r933882721
##########
object_store/src/client/retry.rs:
##########
@@ -0,0 +1,103 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! A shared HTTP client implementation incorporating retries
+
+use crate::client::backoff::{Backoff, BackoffConfig};
+use futures::future::BoxFuture;
+use futures::FutureExt;
+use reqwest::{Response, Result};
+use std::time::{Duration, Instant};
+
+/// Contains the configuration for how to respond to server errors
+///
+/// By default they will be retried up to some limit, using exponential
+/// backoff with jitter. See [`BackoffConfig`] for more information
+///
+#[derive(Debug, Clone)]
+pub struct RetryConfig {
+ /// The backoff configuration
+ pub backoff: BackoffConfig,
+
+ /// The maximum number of times to retry a request
+ ///
+ /// Set to 0 to disable retries
+ pub max_retries: usize,
+
+ /// The maximum length of time from the initial request
+ /// after which no further retries will be attempted
+ ///
+ /// This not only bounds the length of time before a server
+ /// error will be surfaced to the application, but also bounds
+ /// the length of time a request's credentials must remain valid.
+ ///
+ /// As requests are retried without renewing credentials or
Review Comment:
We could theoretically re-sign requests / regenerate credentials, however, I decided against this for a couple of reasons:
* It's non-trivial additional complexity
* The intent of this feature is to hide intermittent failures, a 5 minute outage is not really intermittent
* We want to surface the error to the user eventually
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
tustvold commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r933881306
##########
object_store/src/client/retry.rs:
##########
@@ -0,0 +1,90 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! A shared HTTP client implementation incorporating retries
+
+use crate::client::backoff::{Backoff, BackoffConfig};
+use futures::future::BoxFuture;
+use futures::FutureExt;
+use reqwest::{Response, Result};
+
+/// Contains the configuration for how to respond to server errors
+///
+/// By default they will be retried up to some limit, using exponential
+/// backoff with jitter. See [`BackoffConfig`] for more information
+///
+/// Note: requests are retried without renewing credentials or regenerating
Review Comment:
We could theoretically re-sign requests / regenerate credentials, however, I decided against this for a couple of reasons:
* It's non-trivial additional complexity
* The intent of this feature is to hide intermittent failures, a 5 minute outage is not really intermittent
* We want to surface the error to the user eventually
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] alamb commented on a diff in pull request #2243: Retry GCP requests on server error
Posted by GitBox <gi...@apache.org>.
alamb commented on code in PR #2243:
URL: https://github.com/apache/arrow-rs/pull/2243#discussion_r936483408
##########
object_store/src/client/retry.rs:
##########
@@ -0,0 +1,106 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! A shared HTTP client implementation incorporating retries
+
+use crate::client::backoff::{Backoff, BackoffConfig};
+use futures::future::BoxFuture;
+use futures::FutureExt;
+use reqwest::{Response, Result};
+use std::time::{Duration, Instant};
+use tracing::info;
+
+/// Contains the configuration for how to respond to server errors
+///
+/// By default they will be retried up to some limit, using exponential
+/// backoff with jitter. See [`BackoffConfig`] for more information
+///
+#[derive(Debug, Clone)]
+pub struct RetryConfig {
+ /// The backoff configuration
+ pub backoff: BackoffConfig,
+
+ /// The maximum number of times to retry a request
+ ///
+ /// Set to 0 to disable retries
+ pub max_retries: usize,
+
+ /// The maximum length of time from the initial request
+ /// after which no further retries will be attempted
+ ///
+ /// This not only bounds the length of time before a server
+ /// error will be surfaced to the application, but also bounds
+ /// the length of time a request's credentials must remain valid.
+ ///
+ /// As requests are retried without renewing credentials or
+ /// regenerating request payloads, this number should be kept
+ /// below 5 minutes to avoid errors due to expired credentials
+ /// and/or request payloads
+ pub retry_timeout: Duration,
+}
+
+impl Default for RetryConfig {
+ fn default() -> Self {
+ Self {
+ backoff: Default::default(),
+ max_retries: 10,
+ retry_timeout: Duration::from_secs(3 * 60),
+ }
+ }
+}
+
+pub trait RetryExt {
+ /// Dispatch a request with the given retry configuration
+ ///
+ /// # Panic
+ ///
+ /// This will panic if the request body is a stream
+ fn send_retry(self, config: &RetryConfig) -> BoxFuture<'static, Result<Response>>;
+}
+
+impl RetryExt for reqwest::RequestBuilder {
+ fn send_retry(self, config: &RetryConfig) -> BoxFuture<'static, Result<Response>> {
+ let mut backoff = Backoff::new(&config.backoff);
+ let max_retries = config.max_retries;
+ let retry_timeout = config.retry_timeout;
+
+ async move {
+ let mut retries = 0;
+ let now = Instant::now();
+
+ loop {
+ let s = self.try_clone().expect("request body must be cloneable");
+ match s.send().await {
+ Err(e)
+ if retries < max_retries
+ && now.elapsed() < retry_timeout
+ && e.status()
+ .map(|s| s.is_server_error())
+ .unwrap_or(false) =>
+ {
+ let sleep = backoff.next();
+ retries += 1;
+ info!("Encountered server error, backing off for {} seconds, retry {} of {}", sleep.as_secs_f32(), retries, max_retries);
Review Comment:
👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org