-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Empty queued spans when ForceFlush called #2335
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
b2dd3c9
Empty queued spans when ForceFlush called
pkwarren 0e621b8
Add a changelog entry.
pkwarren c7e4c51
Update CHANGELOG.md
pkwarren 4eb4f2b
Update sdk/trace/batch_span_processor.go
pkwarren 0180f37
Improve test case to verify multiple flushes.
pkwarren cb23081
Refactor code to use enqueue.
pkwarren bf24f4c
Be more defensive on waiting for queue.
pkwarren c03a61a
Fix linter.
pkwarren 486120a
Merge branch 'main' into issue-2080
Aneurysm9 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,6 +22,7 @@ import ( | |
"time" | ||
|
||
"go.opentelemetry.io/otel" | ||
"go.opentelemetry.io/otel/trace" | ||
) | ||
|
||
// Defaults for BatchSpanProcessorOptions. | ||
|
@@ -153,10 +154,29 @@ func (bsp *batchSpanProcessor) Shutdown(ctx context.Context) error { | |
return err | ||
} | ||
|
||
type forceFlushSpan struct { | ||
ReadOnlySpan | ||
flushed chan struct{} | ||
} | ||
|
||
func (f forceFlushSpan) SpanContext() trace.SpanContext { | ||
return trace.NewSpanContext(trace.SpanContextConfig{TraceFlags: trace.FlagsSampled}) | ||
} | ||
|
||
// ForceFlush exports all ended spans that have not yet been exported. | ||
func (bsp *batchSpanProcessor) ForceFlush(ctx context.Context) error { | ||
var err error | ||
if bsp.e != nil { | ||
flushCh := make(chan struct{}) | ||
if bsp.enqueueBlockOnQueueFull(ctx, forceFlushSpan{flushed: flushCh}, true) { | ||
select { | ||
case <-flushCh: | ||
// Processed any items in queue prior to ForceFlush being called | ||
case <-ctx.Done(): | ||
return ctx.Err() | ||
} | ||
} | ||
|
||
wait := make(chan error) | ||
go func() { | ||
wait <- bsp.exportSpans(ctx) | ||
|
@@ -248,6 +268,10 @@ func (bsp *batchSpanProcessor) processQueue() { | |
otel.Handle(err) | ||
} | ||
case sd := <-bsp.queue: | ||
if ffs, ok := sd.(forceFlushSpan); ok { | ||
close(ffs.flushed) | ||
continue | ||
} | ||
bsp.batchMutex.Lock() | ||
bsp.batch = append(bsp.batch, sd) | ||
shouldExport := len(bsp.batch) >= bsp.o.MaxExportBatchSize | ||
|
@@ -296,8 +320,12 @@ func (bsp *batchSpanProcessor) drainQueue() { | |
} | ||
|
||
func (bsp *batchSpanProcessor) enqueue(sd ReadOnlySpan) { | ||
bsp.enqueueBlockOnQueueFull(context.TODO(), sd, bsp.o.BlockOnQueueFull) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In order to work in the ForceFlush method, it was needed to pass a context (to allow cancellation). |
||
} | ||
|
||
func (bsp *batchSpanProcessor) enqueueBlockOnQueueFull(ctx context.Context, sd ReadOnlySpan, block bool) bool { | ||
if !sd.SpanContext().IsSampled() { | ||
return | ||
return false | ||
} | ||
|
||
// This ensures the bsp.queue<- below does not panic as the | ||
|
@@ -317,18 +345,24 @@ func (bsp *batchSpanProcessor) enqueue(sd ReadOnlySpan) { | |
|
||
select { | ||
case <-bsp.stopCh: | ||
return | ||
return false | ||
default: | ||
} | ||
|
||
if bsp.o.BlockOnQueueFull { | ||
bsp.queue <- sd | ||
return | ||
if block { | ||
select { | ||
case bsp.queue <- sd: | ||
return true | ||
case <-ctx.Done(): | ||
return false | ||
} | ||
} | ||
|
||
select { | ||
case bsp.queue <- sd: | ||
return true | ||
default: | ||
atomic.AddUint32(&bsp.dropped, 1) | ||
} | ||
return false | ||
} |
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
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.
Using enqueue requires that the span being queued is marked as sampled.