serv/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2024-12-27 06:03:48 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

tracing: Support placeholders in span name (#5329)

Browse source 
Fixes https://github.com/caddyserver/caddy/issues/5171
This commit is contained in:
David Frickert 2023-01-25 07:26:44 +00:00 committed by GitHub
parent 98867ac346
commit 962310204f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
modules/caddyhttp/tracing/module_test.go
View file

@ -98,7 +98,7 @@ func TestTracing_ServeHTTP_Propagation_Without_Initial_Headers(t *testing.T) {
SpanName: "mySpan", SpanName: "mySpan",
} }
req := httptest.NewRequest("GET", "https://example.com/foo", nil) req := createRequestWithContext("GET", "https://example.com/foo")
w := httptest.NewRecorder() w := httptest.NewRecorder()
var handler caddyhttp.HandlerFunc = func(writer http.ResponseWriter, request *http.Request) error { var handler caddyhttp.HandlerFunc = func(writer http.ResponseWriter, request *http.Request) error {
@ -128,7 +128,7 @@ func TestTracing_ServeHTTP_Propagation_With_Initial_Headers(t *testing.T) {
SpanName: "mySpan", SpanName: "mySpan",
} }
req := httptest.NewRequest("GET", "https://example.com/foo", nil) req := createRequestWithContext("GET", "https://example.com/foo")
req.Header.Set("traceparent", "00-11111111111111111111111111111111-1111111111111111-01") req.Header.Set("traceparent", "00-11111111111111111111111111111111-1111111111111111-01")
w := httptest.NewRecorder() w := httptest.NewRecorder()
@ -159,7 +159,7 @@ func TestTracing_ServeHTTP_Next_Error(t *testing.T) {
SpanName: "mySpan", SpanName: "mySpan",
} }
req := httptest.NewRequest("GET", "https://example.com/foo", nil) req := createRequestWithContext("GET", "https://example.com/foo")
w := httptest.NewRecorder() w := httptest.NewRecorder()
expectErr := errors.New("test error") expectErr := errors.New("test error")
@ -180,3 +180,11 @@ func TestTracing_ServeHTTP_Next_Error(t *testing.T) {
t.Errorf("expected error, got: %v", err) t.Errorf("expected error, got: %v", err)
} }
} }
func createRequestWithContext(method string, url string) *http.Request {
r, _ := http.NewRequest(method, url, nil)
repl := caddy.NewReplacer()
ctx := context.WithValue(r.Context(), caddy.ReplacerCtxKey, repl)
r = r.WithContext(ctx)
return r
}

13
modules/caddyhttp/tracing/tracer.go
View file

@ -69,7 +69,13 @@ func newOpenTelemetryWrapper(
sdktrace.WithResource(res), sdktrace.WithResource(res),
) )
ot.handler = otelhttp.NewHandler(http.HandlerFunc(ot.serveHTTP), ot.spanName, otelhttp.WithTracerProvider(tracerProvider), otelhttp.WithPropagators(ot.propagators)) ot.handler = otelhttp.NewHandler(http.HandlerFunc(ot.serveHTTP),
ot.spanName,
otelhttp.WithTracerProvider(tracerProvider),
otelhttp.WithPropagators(ot.propagators),
otelhttp.WithSpanNameFormatter(ot.spanNameFormatter),
)
return ot, nil return ot, nil
} }
@ -106,3 +112,8 @@ func (ot *openTelemetryWrapper) newResource(
semconv.WebEngineVersionKey.String(webEngineVersion), semconv.WebEngineVersionKey.String(webEngineVersion),
)) ))
} }
// spanNameFormatter performs the replacement of placeholders in the span name
func (ot *openTelemetryWrapper) spanNameFormatter(operation string, r *http.Request) string {
return r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer).ReplaceAll(operation, "")
}