[confighttp]: add an option to add span formatter #11230

VihasMakwana · 2024-09-20T14:40:44Z

Description

This PR adds a new server option to modify span formatter.
it also updates otlpreceiver to use the option.

Link to tracking issue

Testing

Added.

component.ID is not available in this section of code. Since ToServer is intended to be general and can be used by extensions, receivers, and exporters, modifying it to accept internal.Settings would introduce a breaking change, which I'm not comfortable with. Therefore, I believe it would be better to provide an option to change the prefix instead.

codecov · 2024-09-20T14:48:16Z

Codecov Report

Attention: Patch coverage is 94.44444% with 1 line in your changes missing coverage. Please review.

Project coverage is 91.64%. Comparing base (9d2685f) to head (2deac0e).

Files with missing lines	Patch %	Lines
receiver/otlpreceiver/otlp.go	75.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #11230      +/-   ##
==========================================
+ Coverage   91.62%   91.64%   +0.01%     
==========================================
  Files         442      442              
  Lines       23776    23793      +17     
==========================================
+ Hits        21785    21804      +19     
+ Misses       1619     1618       -1     
+ Partials      372      371       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

VihasMakwana · 2024-09-23T14:46:16Z

@bogdandrutu @open-telemetry/collector-approvers I'd appreciate your review on this!

andrzej-stencel

Other than the one nit, this looks sensible to me. Still definitely needs a look from @codeboten or @bogdandrutu who have more insight into this functionality.

config/confighttp/confighttp.go

Co-authored-by: Andrzej Stencel <[email protected]>

VihasMakwana · 2024-09-27T20:55:52Z

@bogdandrutu @codeboten The CI looks good now. PTAL!

mx-psi

LGTM. @bogdandrutu since this is related to a TODO you added, would you mind double checking that this looks good?

VihasMakwana · 2024-10-11T10:41:34Z

@bogdandrutu @open-telemetry/collector-maintainers can someone take a look here?

dmathieu · 2024-10-11T10:56:12Z

config/confighttp/confighttp.go

 			return r.URL.Path
 		}),
 		otelhttp.WithMeterProvider(settings.LeveledMeterProvider(configtelemetry.LevelDetailed)),
 	}

 	// Enable OpenTelemetry observability plugin.
-	// TODO: Consider to use component ID string as prefix for all the operations.
-	handler = otelhttp.NewHandler(handler, "", otelOpts...)
+	handler = otelhttp.NewHandler(handler, serverOpts.spanPrefix, otelOpts...)


This parameter is not a span prefix. It's the operation name.
See https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp#NewHandler
How about naming the option WithOperationName instead of WithSpanPrefix?

@dmathieu I understand your perspective, but we use spanPrefix specifically as a prefix for an operation in this context, using otelhttp.WithSpanNameFormatter

opentelemetry-collector/config/confighttp/confighttp.go

Lines 474 to 479 in dffbad7

otelhttp.WithSpanNameFormatter(func(operation string, r *http.Request) string {

if len(operation) > 0 {

return fmt.Sprintf("%s:%s", operation, r.URL.Path)

}

return r.URL.Path

}),

That's why I named it WithSpanPrefix.

Using WithOperationName might suggest that the option is meant for naming the operation itself, which isn’t accurate. Instead, it serves as a prefix.

For eg.
For example, if you specify WithSpanPrefix("foo") and make an HTTP request to http://host:port/path/bar, the tracer would be named foo:/path/bar.

Does that help clarify?

sfc-gh-bdrutu · 2024-10-11T17:10:19Z

config/confighttp/confighttp.go

+// WithSpanPrefix creates a span prefixed with the specified name.
+// Ideally, this prefix should be the component's ID.
+func WithSpanPrefix(spanPrefix string) ToServerOption {
+	return toServerOptionFunc(func(opts *toServerOptions) {
+		opts.spanPrefix = spanPrefix
+	})
+}


We should make it a bit more generic and accept otelhttp.Option or at least accept exactly same formatter? You may now want this, but later people may want other things, etc.

The problem though, is that otelhttp is not stable, and we are looking to mark this stable soon. So I think we may not be able to accept this until otelhttp is marked stable.

@dmathieu since you are around, any idea of whether otelhttp will be marked stable any time soon?

@sfc-gh-bdrutu @bogdandrutu can you take a look now? I've made it more generic.

any idea of whether otelhttp will be marked stable any time soon?

That is not on our radar at the moment. However, we are committed to keeping the API stable, or providing deprecation warnings for at least two versions.

@sfc-gh-bdrutu @bogdandrutu can you take a look?

A possible way around this is to move the option to a separate module. We are discussing this in #11769

github-actions · 2024-11-16T03:18:22Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

sfc-gh-bdrutu

I have the concern that we really on the "formater" definition from the httptrace which is not stable. The reason this is a concern compare to using that package, is because be are exposing this in our public API.

Also: The API surface (especially because things are stable now) should be minimal.

sfc-gh-bdrutu · 2024-11-20T17:10:13Z

.chloggen/add-new-server-option.yaml

+# 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: []


sfc-gh-bdrutu · 2024-11-20T17:10:48Z

config/confighttp/confighttp.go

@@ -556,6 +564,15 @@ func maxRequestBodySizeInterceptor(next http.Handler, maxRecvSize int64) http.Ha
 	})
 }

+func PrefixFormatter(prefix string) func(string, *http.Request) string {


why public?

TylerHelmuth · 2024-11-20T17:19:55Z

receiver/otlpreceiver/otlp.go

-	if r.serverHTTP, err = r.cfg.HTTP.ToServer(ctx, host, r.settings.TelemetrySettings, httpMux, confighttp.WithErrorHandler(errorHandler)); err != nil {
+	if r.serverHTTP, err = r.cfg.HTTP.ToServer(ctx, host, r.settings.TelemetrySettings, httpMux,
+		confighttp.WithErrorHandler(errorHandler),
+		confighttp.WithSpanFormatter(confighttp.PrefixFormatter(r.settings.ID.String())),


Is this a breaking change? If this is merged will the spans that the otlpreceiver creates about itself have new names?

@TylerHelmuth Is your concern that we should not do this if it is a breaking change?

flc1125 · 2024-11-29T12:46:34Z

config/confighttp/confighttp.go

+// Ideally, this prefix in span name should be the component's ID.
+func WithSpanFormatter(formater func(string, *http.Request) string) ToServerOption {
+	return toServerOptionFunc(func(opts *toServerOptions) {
+		opts.formater = formater


if formater != nil { // .... }

mx-psi · 2024-12-11T15:26:34Z

receiver/otlpreceiver/otlp.go

-	if r.serverHTTP, err = r.cfg.HTTP.ToServer(ctx, host, r.settings.TelemetrySettings, httpMux, confighttp.WithErrorHandler(errorHandler)); err != nil {
+	if r.serverHTTP, err = r.cfg.HTTP.ToServer(ctx, host, r.settings.TelemetrySettings, httpMux,
+		confighttp.WithErrorHandler(errorHandler),
+		confighttp.WithSpanFormatter(confighttp.PrefixFormatter(r.settings.ID.String())),


If we want to do this, we can use #11769 now :)

VihasMakwana added 3 commits September 20, 2024 20:03

chore: add an option to add span prefix, changelog, tests

cff8392

changelog

ce61bb5

reword changelog

c871eaf

VihasMakwana requested a review from a team as a code owner September 20, 2024 14:40

VihasMakwana requested a review from bogdandrutu September 20, 2024 14:40

VihasMakwana added 2 commits September 26, 2024 23:59

go.mod

06d3361

fix tests

f2641b8

andrzej-stencel approved these changes Sep 27, 2024

View reviewed changes

config/confighttp/confighttp.go Outdated Show resolved Hide resolved

VihasMakwana and others added 3 commits September 27, 2024 15:58

Update config/confighttp/confighttp.go

e4b5fb7

Co-authored-by: Andrzej Stencel <[email protected]>

fix: imports

9171bb7

Merge branch 'main' into span-prefix

63d77c8

VihasMakwana force-pushed the span-prefix branch from 5e2319c to 805a7b5 Compare September 27, 2024 20:09

fix: lint

dffbad7

VihasMakwana force-pushed the span-prefix branch from 805a7b5 to dffbad7 Compare September 27, 2024 20:26

dmitryax approved these changes Sep 27, 2024

View reviewed changes

mx-psi approved these changes Oct 3, 2024

View reviewed changes

dmathieu reviewed Oct 11, 2024

View reviewed changes

VihasMakwana requested a review from dmathieu October 11, 2024 14:30

sfc-gh-bdrutu reviewed Oct 11, 2024

View reviewed changes

chore: make it more generic

e6ab7d5

VihasMakwana requested a review from sfc-gh-bdrutu October 11, 2024 21:48

Merge branch 'main' into span-prefix

6018385

VihasMakwana changed the title ~~[confighttp]: add an option to add span prefix~~ [confighttp]: add an option to add span formatter Oct 15, 2024

VihasMakwana added 2 commits October 15, 2024 19:45

go.mod

4fe1105

Merge branch 'main' into span-prefix

985a5d9

VihasMakwana changed the title ~~[confighttp]: add an option to add span formatter~~ [confighttp]: add an option to add span formater Oct 21, 2024

VihasMakwana changed the title ~~[confighttp]: add an option to add span formater~~ [confighttp]: add an option to add span formatter Oct 21, 2024

chore: lint

43d9d0d

github-actions bot added the Stale label Nov 16, 2024

VihasMakwana and others added 4 commits November 20, 2024 18:48

Merge branch 'main' into span-prefix

f778f3a

fix syntax

e2d4dca

go tidy

d1e3078

lint

2deac0e

songy23 removed the Stale label Nov 20, 2024

sfc-gh-bdrutu suggested changes Nov 20, 2024

View reviewed changes

TylerHelmuth reviewed Nov 20, 2024

View reviewed changes

dmathieu mentioned this pull request Nov 29, 2024

todo: adhere to the HTTP span naming semconv processing checklist open-telemetry/opentelemetry-go-contrib#6375

Open

3 tasks

flc1125 reviewed Nov 29, 2024

View reviewed changes

mx-psi reviewed Dec 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[confighttp]: add an option to add span formatter #11230

[confighttp]: add an option to add span formatter #11230

VihasMakwana commented Sep 20, 2024 •

edited

Loading

codecov bot commented Sep 20, 2024 •

edited

Loading

VihasMakwana commented Sep 23, 2024

andrzej-stencel left a comment

VihasMakwana commented Sep 27, 2024

mx-psi left a comment

VihasMakwana commented Oct 11, 2024

dmathieu Oct 11, 2024 •

edited

Loading

VihasMakwana Oct 11, 2024

sfc-gh-bdrutu Oct 11, 2024

sfc-gh-bdrutu Oct 11, 2024

mx-psi Oct 11, 2024

VihasMakwana Oct 11, 2024

dmathieu Oct 14, 2024

VihasMakwana Oct 31, 2024

mx-psi Nov 29, 2024

github-actions bot commented Nov 16, 2024

sfc-gh-bdrutu left a comment

sfc-gh-bdrutu Nov 20, 2024

sfc-gh-bdrutu Nov 20, 2024

TylerHelmuth Nov 20, 2024

mx-psi Dec 11, 2024

flc1125 Nov 29, 2024

mx-psi Dec 11, 2024

	otelhttp.WithSpanNameFormatter(func(operation string, r *http.Request) string {
	if len(operation) > 0 {
	return fmt.Sprintf("%s:%s", operation, r.URL.Path)
	}
	return r.URL.Path
	}),

[confighttp]: add an option to add span formatter #11230

Are you sure you want to change the base?

[confighttp]: add an option to add span formatter #11230

Conversation

VihasMakwana commented Sep 20, 2024 • edited Loading

Description

Link to tracking issue

Testing

codecov bot commented Sep 20, 2024 • edited Loading

Codecov Report

VihasMakwana commented Sep 23, 2024

andrzej-stencel left a comment

Choose a reason for hiding this comment

VihasMakwana commented Sep 27, 2024

mx-psi left a comment

Choose a reason for hiding this comment

VihasMakwana commented Oct 11, 2024

dmathieu Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 16, 2024

sfc-gh-bdrutu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VihasMakwana commented Sep 20, 2024 •

edited

Loading

codecov bot commented Sep 20, 2024 •

edited

Loading

dmathieu Oct 11, 2024 •

edited

Loading