-
Notifications
You must be signed in to change notification settings - Fork 1.6k
[exporter][batcher] MergedContext implemented with SpanLink #12318
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
Closed
sfc-gh-sili
wants to merge
1
commit into
open-telemetry:main
from
sfc-gh-sili:sili-fix-new-batching-context
+111
−2
Closed
Changes from all commits
Commits
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 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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
component: exporterhelper | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Link batcher context to all batched request's span contexts. | ||
|
||
# One or more tracking issues or pull requests related to the change | ||
issues: [12212, 8122] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | ||
|
||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [user] |
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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package batcher // import "go.opentelemetry.io/collector/exporter/exporterhelper/internal/batcher" | ||
import ( | ||
"context" | ||
|
||
"go.opentelemetry.io/otel/trace" | ||
) | ||
|
||
type traceContextKeyType int | ||
|
||
const batchSpanLinksKey traceContextKeyType = iota | ||
|
||
// LinksFromContext returns a list of trace links registered in the context. | ||
func LinksFromContext(ctx context.Context) []trace.Link { | ||
if ctx == nil { | ||
return []trace.Link{} | ||
} | ||
if links, ok := ctx.Value(batchSpanLinksKey).([]trace.Link); ok { | ||
return links | ||
} | ||
return []trace.Link{trace.LinkFromContext(ctx)} | ||
} | ||
|
||
func contextWithMergedLinks(ctx1 context.Context, ctx2 context.Context) context.Context { | ||
return context.WithValue( | ||
context.Background(), | ||
batchSpanLinksKey, | ||
append(LinksFromContext(ctx1), LinksFromContext(ctx2)...)) | ||
} |
39 changes: 39 additions & 0 deletions
39
exporter/exporterhelper/internal/batcher/batch_context_test.go
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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package batcher | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
"go.opentelemetry.io/otel/trace" | ||
|
||
"go.opentelemetry.io/collector/component/componenttest" | ||
) | ||
|
||
func TestBatchContextLink(t *testing.T) { | ||
tracerProvider := componenttest.NewTelemetry().NewTelemetrySettings().TracerProvider | ||
tracer := tracerProvider.Tracer("go.opentelemetry.io/collector/exporter/exporterhelper") | ||
|
||
ctx1 := context.Background() | ||
|
||
ctx2, span2 := tracer.Start(ctx1, "span2") | ||
defer span2.End() | ||
|
||
ctx3, span3 := tracer.Start(ctx1, "span3") | ||
defer span3.End() | ||
|
||
ctx4, span4 := tracer.Start(ctx1, "span4") | ||
defer span4.End() | ||
|
||
batchContext := contextWithMergedLinks(ctx2, ctx3) | ||
batchContext = contextWithMergedLinks(batchContext, ctx4) | ||
|
||
actualLinks := LinksFromContext(batchContext) | ||
require.Len(t, actualLinks, 3) | ||
require.Equal(t, trace.SpanContextFromContext(ctx2), actualLinks[0].SpanContext) | ||
require.Equal(t, trace.SpanContextFromContext(ctx3), actualLinks[1].SpanContext) | ||
require.Equal(t, trace.SpanContextFromContext(ctx4), actualLinks[2].SpanContext) | ||
} |
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
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.
When the batcher is disabled (or when it is enabled but only one request ends up in the batch),
contextWithMergedLinks
is never called, and we pass the parent context through directly to the obsreportsender. I think this is fine, but because the latter callsLinksFromContext
, the parent span ends up as both the parent AND as a link.It's not a big deal, but I think it would be better to create links only when we cut the trace, which is to say, when calling
contextWithMergedLinks
.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.
Yeah, I wondered about created a struct like:
at each contextWithMergedLinks
I believe this will reduce overall allocation count. The LinksFromContext() method would repeatedly get the batchSpanLinksKey value and append a link. To improve on this, the caller of LinksFromContext will (or can) know how many requests were put into the batch (I think?), so it can allocate a slice of the correct capacity, then ideally the call
LinksFromContext(into []trace.SpanLink) error
to populate the result, expecting to findlen(into)
many elements.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.
My opinion is that this would be a premature optimization. I think that creating a linked list of new Contexts, which is then resolved into a slice of SpanLinks, would require just as many (if not more) allocations than just
append
ing the SpanLinks to a single slice, even if you allocate the slice with the right length.My suggestion was very different:
LinksFromContext
, retrieve the slice associated with thebatchSpanLinksKey
, or return an empty slice if the key is absent (no merges were performed, so no links are necessary).contextWithMergedLinks
, do something like this: