Skip to content

otelrestful: use semconv package for request attributes and span status #6951

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.

Sign up for GitHub

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

Merged
XSAM merged 7 commits into from
Apr 16, 2025
Merged

otelrestful: use semconv package for request attributes and span status #6951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
31014d7
otelrestful: use semconv package for request attributes and span status
dmathieu Mar 18, 2025
8ae3a80
Merge branch 'main' into otelrestful-remove-semconvutil
dmathieu Mar 19, 2025
5b7b171
Merge branch 'main' into otelrestful-remove-semconvutil
dmathieu Mar 24, 2025
29e24fc
Merge branch 'main' into otelrestful-remove-semconvutil
dmathieu Mar 26, 2025
800b877
Merge branch 'main' into otelrestful-remove-semconvutil
dmathieu Apr 9, 2025
b15c691
fix attributes now that we don't have http/dup by default anymore
dmathieu Apr 9, 2025
0486a84
Merge branch 'main' into otelrestful-remove-semconvutil
dmathieu Apr 16, 2025
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
14 changes: 6 additions & 8 deletions instrumentation/github.com/emicklei/go-restful/otelrestful/restful.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ package otelrestful // import "go.opentelemetry.io/contrib/instrumentation/githu
import (
"github.com/emicklei/go-restful/v3"

"go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconv"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/propagation"
oteltrace "go.opentelemetry.io/otel/trace"

"go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconv"
"go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconvutil"
)

// ScopeName is the instrumentation scope name.
Expand Down Expand Up @@ -46,7 +44,7 @@ func OTelFilter(service string, opts ...Option) restful.FilterFunction {
spanName := route

opts := []oteltrace.SpanStartOption{
oteltrace.WithAttributes(semconvutil.HTTPServerRequest(service, r, semconvutil.HTTPServerRequestOptions{}, nil)...),
oteltrace.WithAttributes(semconvServer.RequestTraceAttrs(service, r, semconv.RequestTraceAttrsOpts{})...),
oteltrace.WithSpanKind(oteltrace.SpanKindServer),
}
if route != "" {
Expand All @@ -71,9 +69,9 @@ func OTelFilter(service string, opts ...Option) restful.FilterFunction {
chain.ProcessFilter(req, resp)

status := resp.StatusCode()
span.SetStatus(semconvutil.HTTPServerStatus(status))
if status > 0 {
span.SetAttributes(semconv.HTTPStatusCode(status))
}
span.SetStatus(semconvServer.Status(status))
span.SetAttributes(semconvServer.ResponseTraceAttrs(semconv.ResponseTelemetry{
StatusCode: status,
})...)
}
}
14 changes: 8 additions & 6 deletions instrumentation/github.com/emicklei/go-restful/otelrestful/test/restful_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ func TestChildSpanNames(t *testing.T) {
t,
spans[0],
"/user/{id:[0-9]+}",
attribute.String("net.host.name", "foobar"),
attribute.Int("http.status_code", http.StatusOK),
attribute.String("http.method", "GET"),
attribute.String("server.address", "foobar"),
attribute.Int("http.response.status_code", http.StatusOK),
attribute.String("http.request.method", "GET"),
attribute.String("http.route", "/user/{id:[0-9]+}"),
)

Expand All @@ -110,9 +110,9 @@ func TestChildSpanNames(t *testing.T) {
t,
spans[1],
"/book/{title}",
attribute.String("net.host.name", "foobar"),
attribute.Int("http.status_code", http.StatusOK),
attribute.String("http.method", "GET"),
attribute.String("server.address", "foobar"),
attribute.Int("http.response.status_code", http.StatusOK),
attribute.String("http.request.method", "GET"),
attribute.String("http.route", "/book/{title}"),
)
}
Expand Down Expand Up @@ -336,6 +336,8 @@ func TestWithPublicEndpointFn(t *testing.T) {
}

func assertSpan(t *testing.T, span sdktrace.ReadOnlySpan, name string, attrs ...attribute.KeyValue) {
t.Helper()

assert.Equal(t, name, span.Name())
assert.Equal(t, oteltrace.SpanKindServer, span.SpanKind())

Expand Down
Loading