Repository navigation
feat(develop-docs): Render span attributes from sentry-conventions - #20638
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
cbfc412 to
4d2be3b
Compare
Add a ConventionAttributes MDX component that reads attribute type, description, deprecation, and example from @sentry/conventions instead of copying them into Markdown tables. Unknown keys fail the build. Migrate the token usage and execute tool tables on the AI agents page.
Keep the table close to the Markdown tables it replaces. Drop the per-key links, the deprecated prefix, and the InlineMarkdown wrapper, and shorten the unknown-attribute error. Add one link under each table to the attribute category page in Sentry Conventions instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ions Migrate the request data, response data, and embedding span tables on the AI agents page to ConventionAttributes, so every attribute table on the page reads from @sentry/conventions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Drop the per-table link to Sentry Conventions, since every table on a page repeated it. Let the description column wrap, because the site table styles keep every column but the last on one line and convention briefs are long. Single-quote stringified JSON examples, matching the tables this replaces, and reject keys inherited from Object.prototype. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The gen_ai.input.messages brief now describes the parts message shape. Both message briefs say the value must be stringified, so drop the [0] footnote from those rows. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The gen_ai message and tool definition briefs in sentry-conventions now cover the stringified value requirement and the parts message shape, including reasoning parts. Remove the footnotes that repeated them and renumber the remaining one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Install @sentry/conventions from a tarball built at sentry-conventions 28c06d3e, which includes the message and tool definition brief fixes from getsentry/sentry-conventions#784 and #785. Temporary until those changes ship in an npm release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pick up getsentry/sentry-conventions#786, #787, and #788. The reasoning level brief now says supported values vary by provider, so drop the page-specific note. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The footnote was only referenced once, so move its text into the span name bullet. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
0.33.0 ships getsentry/sentry-conventions#784 through #788, so the vendored tarball is no longer needed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
66156a3 to
8c164b3
Compare
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Getting ready to monitor this change · Rollout details
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 8c164b3. Configure here.
| } | ||
| const description = micromark([attribute.brief, notes].filter(Boolean).join(' ')) | ||
| .replace(/^<p>/, '') | ||
| .replace(/<\/p>$/, ''); |
There was a problem hiding this comment.
Paragraph unwrap breaks multi-block briefs
Medium Severity
micromark output is unwrapped by stripping a leading <p> and a trailing </p> independently. That only works for a single paragraph. Multi-paragraph brief text, or brief plus notes that form more than one block, leaves mismatched tags inside the cell via dangerouslySetInnerHTML, so later paragraphs pick up prose margins and the description renders inconsistently.
Reviewed by Cursor Bugbot for commit 8c164b3. Configure here.


DESCRIBE YOUR PR
Replaces #20557.
Adds a
<ConventionAttributes>MDX component that renders span attribute tables straight from@sentry/conventions, so the develop docs stop drifting from the conventions repo. The AI agents module page is the first user.ConventionAttributescomponent (with tests), registered inmdxComponents.ts@sentry/conventions@^0.33.0, which ships fix(attributes): Document reasoning parts forgen_ai.*.messagessentry-conventions#784 through Correct ThreadingIntegration import name #788Preview: https://develop-docs-git-cleptric-featconvention-attributes-component.sentry.dev/sdk/telemetry/traces/modules/ai-agents/
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code
AGT-3145