feat(ember)!: Use function and ui.task span ops for route hooks and runloop
#22669
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| import { subscribe } from '@ember/instrumentation'; | ||
| import { scheduleOnce } from '@ember/runloop'; | ||
| import type { EmberRunQueues } from '@ember/runloop/-private/types'; | ||
| import { SENTRY_OP, UI_COMPONENT_NAME } from '@sentry/conventions/attributes'; | ||
| import { BROWSER_UI_RENDER_SPAN_OP, BROWSER_UI_TASK_SPAN_OP, GENERAL_FUNCTION_SPAN_OP } from '@sentry/conventions/op'; | ||
| import { getActiveSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/browser'; | ||
| import type { Span } from '@sentry/core'; | ||
| import { browserPerformanceTimeOrigin, timestampInSeconds } from '@sentry/core'; | ||
|
|
@@ -89,10 +91,11 @@ function _instrumentEmberRunloop(config: { minimumRunloopQueueDuration?: number | |
| if ((now - currentQueueStart) * 1000 >= minQueueDuration) { | ||
| startInactiveSpan({ | ||
| attributes: { | ||
| [SENTRY_OP]: BROWSER_UI_TASK_SPAN_OP, | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.ember', | ||
| 'ember.runloop.queue': queue, | ||
| }, | ||
| name: 'runloop', | ||
| startTime: currentQueueStart, | ||
| onlyIfParent: true, | ||
| })?.end(now); | ||
|
|
@@ -147,13 +150,16 @@ function processComponentRenderAfter( | |
| const now = timestampInSeconds(); | ||
| const componentRenderDuration = now - begin.now; | ||
|
|
||
| const name = payload.containerKey || payload.object; | ||
|
|
||
| if (componentRenderDuration * 1000 >= minComponentDuration) { | ||
| startInactiveSpan({ | ||
| name, | ||
| startTime: begin.now, | ||
| attributes: { | ||
| [SENTRY_OP]: op, | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.ember', | ||
| [UI_COMPONENT_NAME]: name, | ||
|
There was a problem hiding this comment. New attribute lacks test coverageLow Severity Newly added Additional Locations (1)  Triggered by project rule: PR Review Guidelines for Cursor Bot Reviewed by Cursor Bugbot for commit 63b4326. Configure here. |
||
| }, | ||
| onlyIfParent: true, | ||
| })?.end(now); | ||
|
|
@@ -178,7 +184,7 @@ function _instrumentComponents(config: { | |
| }, | ||
|
|
||
| after(_name: string, _timestamp: number, payload: Payload, _beganIndex: number) { | ||
| processComponentRenderAfter(payload, beforeEntries, BROWSER_UI_RENDER_SPAN_OP, minComponentDuration); | ||
| }, | ||
| }); | ||
| if (enableComponentDefinitions) { | ||
|
|
@@ -188,7 +194,7 @@ function _instrumentComponents(config: { | |
| }, | ||
|
|
||
| after(_name: string, _timestamp: number, payload: Payload, _beganIndex: number) { | ||
| processComponentRenderAfter(payload, beforeComponentDefinitionEntries, GENERAL_FUNCTION_SPAN_OP, 0); | ||
| }, | ||
| }); | ||
| } | ||
|
|
@@ -230,9 +236,10 @@ function _instrumentInitialLoad(): void { | |
| const endTime = startTime + measure.duration / 1000; | ||
|
|
||
| startInactiveSpan({ | ||
| name: 'init', | ||
| attributes: { | ||
| // TODO(v11): Replace with the `ui.mount` constant from `@sentry/conventions/op` once it is registered there. | ||
| [SENTRY_OP]: 'ui.mount', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.ember', | ||
| }, | ||
| startTime, | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
m: does
ember.runloop.queuealso need to be added to@sentry/conventions?Uh oh!
There was an error while loading. Please reload this page.
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.
I'm not sure whether we want to add library-specific attributes to conventions (I don't think so). If yes we'll probably wanna add it to #18895.
cc @Lms24
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.
yes, all attributes sent from our SDKs should be in conventions
we should always use a more generic attribute if possible that isn't tied to a specific lib or framework. I'm not sure if there's a specific replacement for
ember.runloop.queue. If there's none, we can add an ember-specific attribute. There's precedence for framework-specific attributes, for example, Remix.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.
i'm not really familiar with ember but from a quick search i couldn't find any fitting generic attribute and from this guide it looks like the run queue is a pretty specific/unique concept, so yes we should probably add this ember-specific attribute to conventions then.