Skip to content

docs: define supported OTel sampling modes - #304

Open
zhongkechen wants to merge 1 commit into
aws:mainfrom
zhongkechen:docs/otel-sampling-contract
Open

zhongkechen wants to merge 1 commit into
aws:mainfrom
zhongkechen:docs/otel-sampling-contract

Conversation

@zhongkechen

@zhongkechen zhongkechen commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

The sampling guide describes changing decisions and application persistence without defining which policies durable traces support. Define the two supported modes for both views: an authoritative upstream decision, or deterministic sampling from the stable canonical trace ID with configuration unchanged across retries and reinvocations.

Explain why Sampled=1 overrides local always_off and ratio policies for durable spans, exclude non-deterministic local policies when no authoritative upstream decision exists, and clarify that in-memory caching is not durable persistence. Configuration and troubleshooting now link to the shared contract.

Part of #295. Merge this guide first so the new shared-contract link is available, then merge the coordinated OTel README updates:

Keep #295 open until all four documentation updates land.

This focused change overlaps the broader guide rewrite in #302. Retain the supported sampling modes section and its anchor when combining the changes.

Validation:

  • Repository-wide Markdown formatting, spelling, and hidden-character checks passed.
  • Zensical 0.0.40 production build completed with no issues; the sampling section was checked in a local browser preview.
  • All 687 example references and vendored asset checks passed; generated HTML heading, list, and local fragment links verified.
  • git diff --check passed. Documentation only; no runtime or cloud tests required.

This branch is waiting to be deployed

1 active and 1 waiting deployments
ai-pr-review — ae47b037 Waiting Oct 30, 2026 by zhongkechen via ai-pr-review / Approve AI PR review #163
ai-pr-review-runtime — ae47b037 Deployed Oct 30, 2026 by zhongkechen via notify / Generate notification summary #82
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant