Skip to content

Conversation

@jjbayer
Copy link
Member

@jjbayer jjbayer commented Nov 11, 2025

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

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

Fixes INGEST-624.

@vercel
Copy link

vercel bot commented Nov 11, 2025

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

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Nov 11, 2025 2:53pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
sentry-docs Ignored Ignored Preview Nov 11, 2025 2:53pm

@linear
Copy link

linear bot commented Nov 11, 2025

@jjbayer jjbayer marked this pull request as ready for review November 11, 2025 14:48
@jjbayer jjbayer requested review from a team, Lms24, cleptric and tobias-wilfert November 11, 2025 14:48
"type": "attachment",
"content_type": "application/vnd.sentry.attachment.v2",
"length": 212341234,
"meta_length": 123,
Copy link

Choose a reason for hiding this comment

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

Bug: Incorrect meta_length example in documentation for Attachment v2 envelope item header.
Severity: CRITICAL | Confidence: 1.00

🔍 Detailed Analysis

The documentation specifies "meta_length": 123 as an example value for the Attachment v2 envelope item header, but the actual byte count of the provided example metadata JSON is approximately 190+ bytes when minified. This meta_length field is critical for correctly parsing the envelope by defining the boundary between metadata and the binary attachment body. This discrepancy in the specification for a new feature (INGEST-624) will lead to incorrect SDK implementations and subsequent parsing failures or data corruption.

💡 Suggested Fix

Update the meta_length example value in span-protocol.mdx from 123 to approximately 234 to accurately reflect the byte count of the example metadata JSON.

🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: develop-docs/sdk/telemetry/spans/span-protocol.mdx#L240

Potential issue: The documentation specifies `"meta_length": 123` as an example value
for the Attachment v2 envelope item header, but the actual byte count of the provided
example metadata JSON is approximately 190+ bytes when minified. This `meta_length`
field is critical for correctly parsing the envelope by defining the boundary between
metadata and the binary attachment body. This discrepancy in the specification for a new
feature (INGEST-624) will lead to incorrect SDK implementations and subsequent parsing
failures or data corruption.

Did we get this right? 👍 / 👎 to inform future reviews.

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.

2 participants