docs: add guides for errors/retries, keys and sessions, and large uploads

オープン
  • 何か問題がありますか？
#313 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@ffumero2003 がすでに取り組んでいます。

2026年11月8日 から。

評価

この issue はまだ評価されていません。

説明

documentation

Context

The README covers errors, retries, keys/sessions and large/resumable uploads in roughly one line each; backblaze.com/docs has no error/retry guide for the SDKs. Two extension points are also undocumented: blazer accepts a custom transport (b2.Transport(http.RoundTripper), b2/b2.go:158) but the README never mentions it, and blazer's debug logging has no "how to turn it on" doc. (Both gaps surfaced by comparing against the Vercel SDK's docs, which document Retries, Error Handling, Custom HTTP Client and Debugging as standard sections.)

Acceptance criteria

  • R1. Every code sample compiles; wording matches behavior.
  • R2. The transport section shows a working b2.Transport(...) example; the debugging section shows how to enable request logging.

In scope

Add repo guides, linked from the README:

  • Errors and retries: how to check for not-found (and the unwrappable-error helpers), what blazer retries, how Retry-After is applied, and that a retry can create a duplicate version; one example. List the error types/helpers (the "error classes" idea).
  • Keys and sessions: minimal keys and session persistence via WithAccountInfo.
  • Large and resumable uploads: part splitting, resume, and Compose.
  • Custom HTTP client / transport: how to supply your own http.RoundTripper via b2.Transport(...) for timeouts, a proxy, or tracing/instrumentation, and how it composes with blazer's retries.
  • Debugging / request logging: how to see requests and responses (the debug logging / caller logger, see #173), and what is redacted.

Use the Vercel SDK section layout as a template (Retries → Error Handling → Custom HTTP Client → Debugging). Keep every section consistent with shipped behavior (the error-wrapping, Retry-After and upload-retry work). Offer the errors-and-retries text to the docs team afterward.

Out of scope

  • Unrelated work outside the components and behavior described in In scope.

Verification

git diff --check
  • Compile the documented examples, including the custom-transport and logging examples, and record their exact build/test commands.
  • Cross-check error/retry, key/session, upload/resume, and logging statements against shipped behavior. Keep external docs-team coordination explicit rather than claiming it happened.
  • Expected result: the checks above succeed and the observable outcomes in Acceptance criteria are demonstrated. If a check cannot run, report Could not run because: ...; if it starts but fails, report Could not complete because: .... A skipped check is not a pass.

Links

主要言語
Go
スター
66
フォーク
18
平均マージ
1日 10時間
マージ済み PR（30日）
132

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Backblaze/blazer のほかの issue

Backblaze/blazer の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。