Skip to content

docs(sdk): Migrate Logs spec to Writing SDK Specs guidelines - #20102

Draft
sentry-junior[bot] wants to merge 3 commits into
junior/migrate-feature-flags-specfrom
junior/migrate-logs-spec
Draft

sentry-junior[bot] wants to merge 3 commits into
junior/migrate-feature-flags-specfrom
junior/migrate-logs-spec

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Migrates the Logs spec to Writing SDK Specs 0.1, using the writing-sdk-specs skill from #20083. Part of stack #20084, on top of #20085.

The page is restructured into Scope, Definitions, Requirements, and Implementation Guidance. Requirements are rewritten as externally observable behavior. Examples that only restated requirements are removed. Existing SpecSection ids are kept so anchors still work. The version goes to 4.0.0 and the page declares spec_guidelines: writing-specs@0.1. The 4.0.0 changelog entry lists every requirement whose level or meaning changed.

Evidence used to keep or remove requirements (Relay):

  • otel_log removed: Relay dropped the item type in ref(ourlogs): Removes support for the envelope otel log item type relay#5082, so it now parses as Unknown (relay-server/src/envelope/item.rs).
  • Kept as MUST because Relay rejects violations: one log item per envelope (processing/logs/validate.rs), content_type and item_count (envelope/container.rs), and required timestamp/trace_id/level/body (relay-event-schema/src/protocol/ourlog/mod.rs).
  • Kept as MUST because Relay reads them: sentry.release and sentry.is_localhost for inbound filters (relay-filter/src/interface.rs), sentry.sdk.name (eap/mobile.rs), and sentry.timestamp.sequence (eap/time.rs).

Level decisions from SDK review:

  • Kept as MUST: sentry.environment and sentry.sdk.version (the product has no other source for them), the sentry.message.template/parameter.<X> rules, the 100-logs-per-envelope cap, sending logs in capture order, and the beforeSendLog option.
  • Lowered to SHOULD / SHOULD NOT: sentry.origin on direct API calls, the logger module, scope and client captureLog and the ban on per-level scope and client methods, sentry.replay_id, batching, and the limit on logs waiting to be sent. Buffering internals are implementation details, so the 1000-log figure moved to Implementation Guidance.
  • "Minimize default attributes" is now "SHOULD NOT attach attributes to every log that this spec doesn't define".

IS YOUR CHANGE URGENT?

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

PRE-MERGE CHECKLIST

  • 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

via @szokeasaurusrex.

--

View Junior Session [Sentry]

@vercel

vercel Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 20, 2026 11:32am UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 20, 2026 11:32am UTC

Request Review

sentry-junior Bot and others added 2 commits October 20, 2026 11:25
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-logs-spec branch from cf83d1f to b189b78 Compare October 20, 2026 11:25
@sentry-junior
sentry-junior Bot changed the base branch from junior/writing-sdk-specs-skill to junior/migrate-feature-flags-spec October 20, 2026 11:27
@sentry-junior
sentry-junior Bot added this pull request to stack #20084 October 20, 2026 11:27

This branch was successfully deployed

1 active deployment
Preview – develop-docs — f8ef75dc Deployed Oct 20, 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 sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant