Skip to content

ref(develop/spans): Clarify "strictly required" vs "required" common span attributes#18321

Open
Lms24 wants to merge 3 commits into
masterfrom
lms/ref-develop-strictly-required-attributes
Open

ref(develop/spans): Clarify "strictly required" vs "required" common span attributes#18321
Lms24 wants to merge 3 commits into
masterfrom
lms/ref-develop-strictly-required-attributes

Conversation

@Lms24

@Lms24 Lms24 commented Jun 9, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

As discussed yesterday with @Dav1dde and @elramen, Relay might reject spans without sentry.segment.name and sentry.segment.id attributes. This PR therefore now reflects the change in "requiredness" levels in the common span attributes section so that we clearly point out that the two attributes are always strictly required. It also clarifies that the other attributes are "required if available".

Inspired by our dynamic sampling context specification.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: 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 added an urgent due date to it.
    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

@vercel

vercel Bot commented Jun 9, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Jun 9, 2026 9:44am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Jun 9, 2026 9:44am

Request Review

@Lms24 Lms24 requested a review from cleptric June 9, 2026 09:20
@github-actions github-actions Bot added the sdk-develop-docs PRs touching develop-docs/sdk label Jun 9, 2026
@jared-outpost

jared-outpost Bot commented Jun 9, 2026

Copy link
Copy Markdown

Auto-merge is on hold — the following checks are still running:

  • lint-404
  • Seer Code Review
  • semgrep-cloud-platform/scan
  • Vercel – develop-docs

Will re-evaluate once all checks complete.

Comment thread develop-docs/sdk/telemetry/spans/span-protocol.mdx
Comment thread develop-docs/sdk/telemetry/spans/span-protocol.mdx Outdated
Comment thread develop-docs/sdk/telemetry/spans/span-protocol.mdx Outdated

@sentrivana sentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@elramen elramen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@cleptric

cleptric commented Jun 9, 2026

Copy link
Copy Markdown
Member

Ok with this change, but required also meant it's really required 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants