-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(spans): Attachment V2 envelope item #15466
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| "type": "attachment", | ||
| "content_type": "application/vnd.sentry.attachment.v2", | ||
| "length": 212341234, | ||
| "meta_length": 123, |
There was a problem hiding this comment.
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.
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.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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.