docs(js): Add elementTimingIntegration documentation#17162
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
👋 @logaretm, can we review this already, or should we wait until you set the PR to ready? |
|
@inventarSarah please do, I marked it as draft to prevent merging it before the release goes through. It is unblocked now! |
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new standalone elementTimingIntegration, which captures Element Timing API measurements and emits them as Sentry distribution metrics, and wires the new doc into the JavaScript docs navigation/discovery points.
Changes:
- Added a new integration documentation page for
elementTimingIntegration. - Added
elementTimingIntegrationto the JavaScript browser integrations table. - Added an “Integrations” section to the JavaScript metrics page linking to the new integration.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| platform-includes/configuration/integrations/javascript.mdx | Adds elementTimingIntegration to the JavaScript integrations table. |
| docs/platforms/javascript/common/metrics/index.mdx | Adds an “Integrations” section linking metrics users to the new integration page (browser-only). |
| docs/platforms/javascript/common/configuration/integrations/elementtiming.mdx | New docs page describing setup, element marking, emitted metrics, and migration from enableElementTiming. |
inventarSarah
left a comment
inventarSarah
left a comment
There was a problem hiding this comment.
Thank you, looks good to me! 👍
Added two small suggestions
| | Attribute | Description | | ||
| | ----------------------- | ------------------------------------------------ | | ||
| | `ui.element.identifier` | The value of the `elementtiming` HTML attribute. | | ||
| | `ui.element.paint_type` | `image-paint` or `text-paint`. | |
There was a problem hiding this comment.
Can you please also add a short description here, as you did with the other attributes
|
|
||
| </Alert> | ||
|
|
||
| This integration requires [Sentry Metrics](./../../../metrics/) to be available in your Sentry organization. |
There was a problem hiding this comment.
users also need tracing, right? We could mention this here too.
You can use PlatformLink for the link like so:
This integration requires <PlatformLink to="/metrics">Sentry Metrics</PlatformLink> to be available in your Sentry organization.
There was a problem hiding this comment.
This doesn't need tracing, just metrics. It did require it in early implementations, so I will update the snippet above to avoid confusing anyone.
I will use the link component, thanks!
Document the new standalone elementTimingIntegration that collects Element Timing API data as Sentry distribution metrics. This replaces the deprecated enableElementTiming option on browserTracingIntegration. Refs getsentry/sentry-javascript#19869 Co-Authored-By: Claude <noreply@anthropic.com>
- Use PlatformLink for metrics link - Add description for paint_type attribute - Remove browserTracingIntegration from setup snippet (not required) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
logaretm
force-pushed
the
awad/add-element-timing-integration
branch
from
2da78c9 to
0e49616
Compare
DESCRIBE YOUR PR
Document the new standalone
elementTimingIntegrationthat collects Element Timing API data as Sentry distribution metrics. This replaces the deprecatedenableElementTimingoption onbrowserTracingIntegration.Refs getsentry/sentry-javascript#19869
Changes:
docs/platforms/javascript/common/configuration/integrations/elementtiming.mdxelementTimingIntegrationto the browser integrations tableIS 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: