Skip to content

Improve documentation for http client timeout#390

Merged
alamb merged 3 commits into
apache:mainfrom
alamb:alamb/update_timeout_docs
Aug 4, 2025
Merged

Improve documentation for http client timeout#390
alamb merged 3 commits into
apache:mainfrom
alamb:alamb/update_timeout_docs

Conversation

@alamb

@alamb alamb commented May 30, 2025

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

It was not 100% clear to me how timeouts and retries are related after #383

@tustvold sorted me out on #386 so let's document that wisdom in the docs hopefully for others to benefit too

What changes are included in this PR?

Clarify how timeouts are applied and retried

Are there any user-facing changes?

Just docs, no functional changes

@alamb alamb added the documentation Improvements or additions to documentation label Jun 6, 2025
@alamb

alamb commented Aug 3, 2025

Copy link
Copy Markdown
Contributor Author

It looks like I lost track of this PR, so I merged up from main and will merge it in once CI passes

@alamb alamb merged commit 94c25d2 into apache:main Aug 4, 2025
8 checks passed
Simon-3008-Simon added a commit to sap-contributions/arrow-rs-object-store that referenced this pull request Oct 14, 2025
* Improve documentation for http client timeout (apache#390)

* chore: fix some clippy 1.89 warnings and ignore some doctests on wasm32 (apache#468)

* chore: fix some clippy 1.89 warnings

* fix another warning

* Skip some doctests for wasm32

* build(deps): bump actions/checkout from 4 to 5 (apache#463)

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Allow "application_credentials" in `impl FromStr for GoogleConfigKey` (apache#467)

* build(deps): bump actions/setup-python from 5 to 6 (apache#476)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5...v6)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump actions/setup-node from 4 to 5 (apache#477)

Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4 to 5.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump actions/github-script from 7 to 8 (apache#478)

Bumps [actions/github-script](https://github.com/actions/github-script) from 7 to 8.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](actions/github-script@v7...v8)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(client/retry): include error info in logs when retry occurs (apache#487)

On a request retry, it logs an info message stating that an error was
encountered and information about the retry process but it hasn't
included any details about the error that is causing the retry. This PR
updates the logging to include the status if it is a server error and
the http error kind if a transport error occurred. While the last error
when retries are exhausted is returned up the call stack, the
intermediate errors need not be exactly the same. It is helpful to
include some minimum information about what error triggered a retry each
time it happens.

* aws: downgrade credential provider info! log messages to debug! (apache#436)

These log messages are very noisy.

* Add storage class for aws, gcp, and azure (apache#456)

* Add storage class for aws and gcp

* Add azure storage class attribute

* Update attribute docs

* Update http client

* Add version 0.12.4 release plan to README (apache#490)

* Fix for clippy 1.90 (apache#492)

* AWS S3: Support STS endpoint, WebIdentity, RoleArn, RoleSession configuration (apache#480)

* Allow setting STS endpoint via env var

* Properly use AmazonS3Builder::credentials_from_env for AssumeRoleWithWebIdentity auth flow

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* Revert "refactor: remove AWS dynamo integration (apache#407)" (apache#493)

This reverts commit 034733f.

* Update version to 0.12.4 and add changelog (apache#491)

* Update version to 0.12.4

* Update update_changelog.sh script

* Update changelog

* Last touchups

* Update changelog

* Reapply "refactor: remove AWS dynamo integration (apache#407)" (apache#494)

This reverts commit bebd53b.

* Add Content_length header to S3 create_multipart (apache#496)

* minor: Fix MSRV CI workflow (apache#502)

* ci: Fix MSRV CI workflow

* Update .github/workflows/rust.yml

* Update .github/workflows/rust.yml

---------

Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>

* All changes to support SAP HDLFS

* add hdlfs

* FOS-9911: support delta path version 2.0

* FOS-10349:  fix object_url (#2)

* FOS-10349: fix object_url

* FOS-11081: sync code

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kyle Barron <kyle@developmentseed.org>
Co-authored-by: Phil Bracikowski <13472206+philjb@users.noreply.github.com>
Co-authored-by: Alfonso Subiotto Marqués <alfonso.subiotto@polarsignals.com>
Co-authored-by: Matthew Turner <me@matthewmturner.com>
Co-authored-by: Matt Friede <7852262+Friede80@users.noreply.github.com>
Co-authored-by: Yongming Ding <yongmingd@nvidia.com>
Simon-3008-Simon added a commit to sap-contributions/arrow-rs-object-store that referenced this pull request Feb 6, 2026
* Improve documentation for http client timeout (apache#390)

* chore: fix some clippy 1.89 warnings and ignore some doctests on wasm32 (apache#468)

* chore: fix some clippy 1.89 warnings

* fix another warning

* Skip some doctests for wasm32

* build(deps): bump actions/checkout from 4 to 5 (apache#463)

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Allow "application_credentials" in `impl FromStr for GoogleConfigKey` (apache#467)

* build(deps): bump actions/setup-python from 5 to 6 (apache#476)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5...v6)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump actions/setup-node from 4 to 5 (apache#477)

Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4 to 5.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump actions/github-script from 7 to 8 (apache#478)

Bumps [actions/github-script](https://github.com/actions/github-script) from 7 to 8.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](actions/github-script@v7...v8)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(client/retry): include error info in logs when retry occurs (apache#487)

On a request retry, it logs an info message stating that an error was
encountered and information about the retry process but it hasn't
included any details about the error that is causing the retry. This PR
updates the logging to include the status if it is a server error and
the http error kind if a transport error occurred. While the last error
when retries are exhausted is returned up the call stack, the
intermediate errors need not be exactly the same. It is helpful to
include some minimum information about what error triggered a retry each
time it happens.

* aws: downgrade credential provider info! log messages to debug! (apache#436)

These log messages are very noisy.

* Add storage class for aws, gcp, and azure (apache#456)

* Add storage class for aws and gcp

* Add azure storage class attribute

* Update attribute docs

* Update http client

* Add version 0.12.4 release plan to README (apache#490)

* Fix for clippy 1.90 (apache#492)

* AWS S3: Support STS endpoint, WebIdentity, RoleArn, RoleSession configuration (apache#480)

* Allow setting STS endpoint via env var

* Properly use AmazonS3Builder::credentials_from_env for AssumeRoleWithWebIdentity auth flow

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* Revert "refactor: remove AWS dynamo integration (apache#407)" (apache#493)

This reverts commit 034733f.

* Update version to 0.12.4 and add changelog (apache#491)

* Update version to 0.12.4

* Update update_changelog.sh script

* Update changelog

* Last touchups

* Update changelog

* Reapply "refactor: remove AWS dynamo integration (apache#407)" (apache#494)

This reverts commit bebd53b.

* Add Content_length header to S3 create_multipart (apache#496)

* minor: Fix MSRV CI workflow (apache#502)

* ci: Fix MSRV CI workflow

* Update .github/workflows/rust.yml

* Update .github/workflows/rust.yml

---------

Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>

* All changes to support SAP HDLFS

* add hdlfs

* FOS-9911: support delta path version 2.0

* FOS-10349:  fix object_url (#2)

* FOS-10349: fix object_url

* FOS-11081: sync code

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kyle Barron <kyle@developmentseed.org>
Co-authored-by: Phil Bracikowski <13472206+philjb@users.noreply.github.com>
Co-authored-by: Alfonso Subiotto Marqués <alfonso.subiotto@polarsignals.com>
Co-authored-by: Matthew Turner <me@matthewmturner.com>
Co-authored-by: Matt Friede <7852262+Friede80@users.noreply.github.com>
Co-authored-by: Yongming Ding <yongmingd@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants