Skip to content
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

[service] implement a noop tracer provider #11026

Merged
merged 3 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .chloggen/codeboten_noop-providers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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: service

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: implement a no-op tracer provider that doesn't propagate the context

# One or more tracking issues or pull requests related to the change
issues: [11026]

# (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: |
The no-op tracer provider supported by the SDK incurs a memory cost of propagating the context no matter
what. This is not needed if tracing is not enabled in the Collector. This implementation of the no-op tracer
provider removes the need to allocate memory when tracing is disabled.

# 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: []
21 changes: 20 additions & 1 deletion service/telemetry/tracer.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"go.opentelemetry.io/otel/propagation"
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
"go.opentelemetry.io/otel/trace"
"go.opentelemetry.io/otel/trace/embedded"
"go.opentelemetry.io/otel/trace/noop"

"go.opentelemetry.io/collector/config/configtelemetry"
Expand Down Expand Up @@ -47,10 +48,28 @@
return attrs
}

type noopNoContextTracer struct {
embedded.Tracer
}

var noopSpan = noop.Span{}

func (n *noopNoContextTracer) Start(ctx context.Context, _ string, _ ...trace.SpanStartOption) (context.Context, trace.Span) {
return ctx, noopSpan

Check warning on line 58 in service/telemetry/tracer.go

View check run for this annotation

Codecov / codecov/patch

service/telemetry/tracer.go#L57-L58

Added lines #L57 - L58 were not covered by tests
}

type noopNoContextTracerProvider struct {
embedded.TracerProvider
}

func (n *noopNoContextTracerProvider) Tracer(_ string, _ ...trace.TracerOption) trace.Tracer {
return &noopNoContextTracer{}

Check warning on line 66 in service/telemetry/tracer.go

View check run for this annotation

Codecov / codecov/patch

service/telemetry/tracer.go#L65-L66

Added lines #L65 - L66 were not covered by tests
}

// New creates a new Telemetry from Config.
func newTracerProvider(ctx context.Context, set Settings, cfg Config) (trace.TracerProvider, error) {
if globalgates.NoopTracerProvider.IsEnabled() || cfg.Traces.Level == configtelemetry.LevelNone {
return noop.NewTracerProvider(), nil
return &noopNoContextTracerProvider{}, nil
}

sch := semconv.SchemaURL
Expand Down
5 changes: 2 additions & 3 deletions service/telemetry/tracer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (

"github.com/stretchr/testify/require"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"go.opentelemetry.io/otel/trace/noop"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config/configtelemetry"
Expand Down Expand Up @@ -76,13 +75,13 @@ func TestNewTracerProvider(t *testing.T) {
Level: configtelemetry.LevelNone,
},
},
wantTracerProvider: noop.TracerProvider{},
wantTracerProvider: &noopNoContextTracerProvider{},
},
{
name: "noop tracer feature gate",
cfg: Config{},
noopTracerGate: true,
wantTracerProvider: noop.TracerProvider{},
wantTracerProvider: &noopNoContextTracerProvider{},
},
{
name: "tracer provider",
Expand Down
Loading