fix(sdk-trace-base): always wait on pending export in SimpleSpanProcessor #5303
Conversation
This file contains 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
…impleSpanProcessor
anuraaga
commented
Jan 7, 2025
| @@ -38,16 +38,16 @@ import { Resource } from '@opentelemetry/resources'; | |||
| */ | |||
| export class SimpleSpanProcessor implements SpanProcessor { | |||
| private _shutdownOnce: BindOnceFuture<void>; | |||
| private _unresolvedExports: Set<Promise<void>>; | |||
| private _pendingExports: Set<Promise<void>>; | |||
There was a problem hiding this comment.
unresolved seemed to be referring specifically to the resource so I renamed to pending to be more generic
| @@ -81,26 +86,17 @@ export class SimpleSpanProcessor implements SpanProcessor { | |||
| globalErrorHandler(error); | |||
| }); | |||
|
|
|||
| // Avoid scheduling a promise to make the behavior more predictable and easier to test | |||
There was a problem hiding this comment.
Removed this since it seemed to be misleading - a promise is scheduled by doExport anyways so there's no way to avoid scheduling one
anuraaga
changed the title
anuraaga
changed the title
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #5303 +/- ##
=======================================
Coverage 94.77% 94.78%
=======================================
Files 309 309
Lines 7967 7958 -9
Branches 1678 1674 -4
=======================================
- Hits 7551 7543 -8
+ Misses 416 415 -1
|
anuraaga
changed the title
|
Can anyone review this PR? @trentm maybe? |
codefromthecrypt
approved these changes
Jan 27, 2025
| exportPromise = doExport(); | ||
| } | ||
|
|
||
| // store the unresolved exports |
There was a problem hiding this comment.
Suggested change
| // store the unresolved exports | |
| // If async, enqueue this export to the pending list |
…y-js into simplespanprocessor-waitalways
trentm
reviewed
Feb 11, 2025
packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts
Outdated
Show resolved
Hide resolved
…y-js into simplespanprocessor-waitalways
|
cc @mikeldking suspect y'all will appreciate this! |
trentm
reviewed
Feb 12, 2025
…y-js into simplespanprocessor-waitalways
trentm
pushed a commit
to trentm/opentelemetry-js
that referenced
this pull request
Feb 26, 2025
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.
Which problem is this PR solving?
It isn't possible to know when a
SimpleSpanProcessorhas finished exporting spans, e.g. before asserting on spans in a unit test. AFAIK unit tests are mostly required to useBatchSpanProcessorbecause of this.Fixes #1841
Short description of the changes
Tracks pending exports always in
SimpleSpanProcessor, not only when async resource is used. This is because export itself is async and has the same need for tracking as the async resource path. There isn't a way to avoid "scheduling a promise" if export itself is a promise.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: