Skip to content

docs(native): HTTP retry and offline caching - #20259

Merged
jpnurmi merged 1 commit into
masterfrom
jpnurmi/native/offline-caching
Oct 28, 2026
Merged

jpnurmi merged 1 commit into
masterfrom
jpnurmi/native/offline-caching

Conversation

@jpnurmi

@jpnurmi jpnurmi commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Neither feature was properly documented for Native. Add dedicated sections to the transports page that explain what gets retried, the backoff, the cache modes and limits, and how they interact with user consent.

List the related options on the options page, and mention the cache_dir header on the external crash reporter page.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Neither feature was documented for Native. Add sections to the
transports page that explain what gets retried, the backoff, the
cache modes and limits, and how they interact with user consent.

List the related options on the options page, and mention the
`cache_dir` header on the external crash reporter page.
@vercel

vercel Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 27, 2026 3:25pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Oct 27, 2026 3:25pm UTC

Request Review

@codeowner-assignment
codeowner-assignment Bot requested review from a team October 27, 2026 15:20
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 27, 2026
@cursor

cursor Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor
  • The change adds HTTP retry and offline cache copy to three existing pages.
  • The plan checks that the new headings and options appear on those pages.
  • An issue escalates when the new copy is missing or page errors or 404s rise.

Monitoring in production

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

The Native transports page now explains HTTP retry and offline caching.
The Native options page now lists the retry, cache, and consent options.
The crash reporter page now mentions the cache_dir envelope header.
sentry-docs must deploy before this change is live.
These files live under docs/platforms/native, so develop-docs does not ship them.

Risk

A bad MDX render can break those three pages for readers.
New C samples can throw in the code highlighter.
New internal links can 404 Native paths.
A failed static build blocks the whole production deploy.
Wrong retry or cache copy can make readers misconfigure Native uploads.

Intended effect

The new copy must appear on the published pages.
Absent means each page still loads and the new strings are missing.

Signal Baseline Rule Source
Transports headings Retrying Failed Uploads and Offline Caching Absent on the live page at 2026-10-27T15:20Z Confirmed when both headings are present. Absent when the page loads without them. GET https://docs.sentry.io/platforms/native/configuration/transports/
Options http_retry, cache_keep, and require_user_consent Absent on the live page at 2026-10-27T15:20Z Confirmed when all three option names are present. Absent when the page loads without them. GET https://docs.sentry.io/platforms/native/configuration/options/
Crash reporter cache_dir envelope header Absent on the live page at 2026-10-27T15:20Z Confirmed when cache_dir is present. Absent when the page loads without it. GET https://docs.sentry.io/platforms/native/advanced-usage/external-crash-reporter/

Regression watch

These three pages take little traffic.
One new error is a large rate change.
Watch Native sibling pages on the same MDX path.

Signal Baseline Rule Source
Client errors on the three changed URLs 0 errors over 2026-10-25T15:20:57Z to 2026-10-27T15:20:57Z. Client page loads in that window were 5. Hold at 0. Escalate when any error appears on these URLs. Sentry org sentry, project docs. Query: environment:production url:platforms/native/configuration/transports OR url:platforms/native/configuration/options OR url:platforms/native/advanced-usage/external-crash-reporter. Dataset errors, count().
Client errors on other Native pages 4 errors against 272 Native page loads, about 1.5%, over 2026-10-25T15:20:57Z to 2026-10-27T15:20:57Z. A 24h url-only query over 2026-10-26T15:20:57Z to 2026-10-27T15:20:57Z returned 3 errors. Hold near 1.5%. Escalate when the 48h share rises above 2% at similar page-load volume. Sentry org sentry, project docs. Errors: environment:production AND (transaction:/platforms/native/ OR url:/platforms/native/), count(). Page loads: metric.name:docs.page.load AND sentry.environment:production AND path:platforms/native, sum(value).
Pageload and navigation failure rate on the three URLs 0% over 2026-10-20T15:20:57Z to 2026-10-27T15:20:57Z, 20 spans. The 48h window had 3 spans at 0%. Hold at 0%. Escalate when any failed pageload or navigation appears. Sentry org sentry, project docs. Query: sentry.environment:production AND span.op:[pageload,navigation] AND url.path:[/platforms/native/configuration/transports/,/platforms/native/configuration/options/,/platforms/native/advanced-usage/external-crash-reporter/]. Fields: count(), failure_rate(). Traces are sampled at 30%.
Native 404s 1 docs.page.not_found with requested_path platforms/native against 272 Native page loads, about 0.4%, over 2026-10-25T15:20:57Z to 2026-10-27T15:20:57Z. Hold at 0-1 per 48h at similar volume. Escalate when Native 404s exceed 1 in 48h. Sentry org sentry, project docs. Query: environment:production requested_path:"platforms/native" on metric docs.page.not_found, sum(value).

Not observable

Whether the new copy matches Native SDK behavior.
Whether search later finds the new headings.
The 24h Native page-load count was not measured, only the 48h total.
The 48h client page-load count for the crash reporter page was zero.

@jpnurmi
jpnurmi merged commit 10c6967 into master Oct 28, 2026
29 of 30 checks passed
@jpnurmi
jpnurmi deleted the jpnurmi/native/offline-caching branch October 28, 2026 09:09

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — f646c04e Deployed Oct 27, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants