Skip to content

Commit e99074d

Browse files
authored
[service] implement a noop tracer provider (#11026)
This is to address some of the memory concerns around the SDK's noop tracer provider. Instead of using the published noop tracer provider, we implement our own to avoid the cost of context propagation, which has been proven to be high enough to cause issues for end users. Part of #10858 --------- Signed-off-by: Alex Boten <[email protected]>
1 parent 42b2f81 commit e99074d

File tree

3 files changed

+50
-4
lines changed

3 files changed

+50
-4
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: service
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: implement a no-op tracer provider that doesn't propagate the context
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [11026]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext: |
19+
The no-op tracer provider supported by the SDK incurs a memory cost of propagating the context no matter
20+
what. This is not needed if tracing is not enabled in the Collector. This implementation of the no-op tracer
21+
provider removes the need to allocate memory when tracing is disabled.
22+
23+
# Optional: The change log or logs in which this entry should be included.
24+
# e.g. '[user]' or '[user, api]'
25+
# Include 'user' if the change is relevant to end users.
26+
# Include 'api' if there is a change to a library API.
27+
# Default: '[user]'
28+
change_logs: []

service/telemetry/tracer.go

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"go.opentelemetry.io/otel/propagation"
1414
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
1515
"go.opentelemetry.io/otel/trace"
16+
"go.opentelemetry.io/otel/trace/embedded"
1617
"go.opentelemetry.io/otel/trace/noop"
1718

1819
"go.opentelemetry.io/collector/config/configtelemetry"
@@ -47,10 +48,28 @@ func attributes(set Settings, cfg Config) map[string]interface{} {
4748
return attrs
4849
}
4950

51+
type noopNoContextTracer struct {
52+
embedded.Tracer
53+
}
54+
55+
var noopSpan = noop.Span{}
56+
57+
func (n *noopNoContextTracer) Start(ctx context.Context, _ string, _ ...trace.SpanStartOption) (context.Context, trace.Span) {
58+
return ctx, noopSpan
59+
}
60+
61+
type noopNoContextTracerProvider struct {
62+
embedded.TracerProvider
63+
}
64+
65+
func (n *noopNoContextTracerProvider) Tracer(_ string, _ ...trace.TracerOption) trace.Tracer {
66+
return &noopNoContextTracer{}
67+
}
68+
5069
// New creates a new Telemetry from Config.
5170
func newTracerProvider(ctx context.Context, set Settings, cfg Config) (trace.TracerProvider, error) {
5271
if globalgates.NoopTracerProvider.IsEnabled() || cfg.Traces.Level == configtelemetry.LevelNone {
53-
return noop.NewTracerProvider(), nil
72+
return &noopNoContextTracerProvider{}, nil
5473
}
5574

5675
sch := semconv.SchemaURL

service/telemetry/tracer_test.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import (
99

1010
"github.com/stretchr/testify/require"
1111
sdktrace "go.opentelemetry.io/otel/sdk/trace"
12-
"go.opentelemetry.io/otel/trace/noop"
1312

1413
"go.opentelemetry.io/collector/component"
1514
"go.opentelemetry.io/collector/config/configtelemetry"
@@ -76,13 +75,13 @@ func TestNewTracerProvider(t *testing.T) {
7675
Level: configtelemetry.LevelNone,
7776
},
7877
},
79-
wantTracerProvider: noop.TracerProvider{},
78+
wantTracerProvider: &noopNoContextTracerProvider{},
8079
},
8180
{
8281
name: "noop tracer feature gate",
8382
cfg: Config{},
8483
noopTracerGate: true,
85-
wantTracerProvider: noop.TracerProvider{},
84+
wantTracerProvider: &noopNoContextTracerProvider{},
8685
},
8786
{
8887
name: "tracer provider",

0 commit comments

Comments
 (0)