feat(core): Replace idle transaction with idle span #9972
Closed
Conversation
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
mydea
commented
Dec 22, 2023
| idleTimeout: number; | ||
| finalTimeout: number; | ||
| // TODO FN: Do we need this?? | ||
| // customSamplingContext?: CustomSamplingContext; |
There was a problem hiding this comment.
This is a general thing that already came up - do we need to add this to startSpan somehow? 🤔
mydea
commented
Dec 22, 2023
| */ | ||
| export function startIdleSpan(options: IdleSpanOptions): Span | undefined { | ||
| // Activities store a list of active spans | ||
| const activities = new Map<string, boolean>(); |
There was a problem hiding this comment.
Keeping this is a map instead of a POJO, makes cleanup etc. easier!
mydea
commented
Dec 22, 2023
|
|
||
| const FINISH_REASON_TAG = 'finishReason'; | ||
|
|
||
| const FINISH_REASON_HEARTBEAT_FAILED = 'heartbeatFailed'; |
There was a problem hiding this comment.
Rewrote this to proper constants instead of accessing array elements.
mydea
commented
Dec 22, 2023
|
|
||
| DEBUG_BUILD && logger.log('[Tracing] finishing idle span', new Date(endTimestamp * 1000).toISOString(), span.op); | ||
|
|
||
| childSpans.forEach(childSpan => { |
There was a problem hiding this comment.
Instead of looking at the spanRecorder of the transaction, we keep the child spans manually here.
mydea
commented
Dec 22, 2023
| } | ||
|
|
||
| client.on('spanStart', span => { | ||
| if (_finished) { |
There was a problem hiding this comment.
Instead of patching the span recorder, we hook into spanStart and check here if the new span is a (nested) child span of the idle span.
mydea
commented
Dec 22, 2023
| _popActivity(span.spanId); | ||
|
|
||
| if (span.spanId === spanId) { | ||
| endIdleSpan(); |
There was a problem hiding this comment.
Instead of monkey-patching end, we instead trigger this here when we detect that we are ending the idle span.
size-limit report 📦
|
Lms24
added a commit
that referenced
this pull request
Jan 16, 2024
Deprecate the `spanRecorder` field on the `Span` class. For now there's no replacement yet. I'm not entirely sure how we're going to keep track of spans within the SDK. #9972 shows an alternative for `IdleSpan` which no longer seems to rely on the `spanRecorder`. Another possibility might be to make the recorder private which might be enough, too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a draft, replacing
startIdleTransactionwithstartIdleSpan.Missing for this is adding tests for this, but wanted to check first if the approach seems good to everyone.
Some notes:
onScopeoption, as we always put it on the scope right now. So no need to expose this for now.This currently depends on "buggy" behavior ofThis for now still usesstartSpanManualin regards to scope forking in Browser. But that's OK I guessscope.setSpan(), we may need to revisit this in v8, but should be OK for now