otelgin: Add a WithSpanStartOptions option #7261

arshukla98 · 2025-04-24T07:35:22Z

Closes: #7247

codecov · 2025-04-24T07:38:52Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.1%. Comparing base (c1aeca6) to head (9de11d8).
Report is 14 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #7261   +/-   ##
=====================================
  Coverage   81.1%   81.1%           
=====================================
  Files        204     204           
  Lines      18140   18147    +7     
=====================================
+ Hits       14720   14727    +7     
  Misses      3001    3001           
  Partials     419     419

Files with missing lines	Coverage Δ
...ntation/github.com/gin-gonic/gin/otelgin/config.go	`100.0% <100.0%> (ø)`
...umentation/github.com/gin-gonic/gin/otelgin/gin.go	`93.1% <100.0%> (+0.1%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dmathieu

This is missing tests and a changelog entry.

flc1125 · 2025-04-24T08:09:25Z

instrumentation/github.com/gin-gonic/gin/otelgin/config.go

@@ -89,6 +90,14 @@ func WithPropagators(propagators propagation.TextMapPropagator) Option {
 	})
 }

+// WithSpanOptions configures an additional set of
+// trace.SpanOptions, which are applied to each new span.
+func WithSpanOptions(opts ...oteltrace.SpanStartOption) Option {


WithSpanStartOptions

flc1125 · 2025-04-30T09:14:35Z

CHANGELOG.md

@@ -21,6 +21,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Allow configuring samplers in `go.opentelemetry.io/contrib/otelconf`. (#7148)
 - Slog log bridge now sets `SeverityText` attribute using source value in `go.opentelemetry.io/contrib/bridges/otelslog`. (#7198)
 - Add `http.route` metric attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#7275)
+- Add the `WithSpanOptions` option to add extra attributes, links, etc. to the spans it generates in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#7261)


WithSpanStartOptions

flc1125 · 2025-04-30T09:15:14Z

instrumentation/github.com/gin-gonic/gin/otelgin/gin.go

@@ -31,6 +31,13 @@ const (
 // server handling the request.
 func Middleware(service string, opts ...Option) gin.HandlerFunc {
 	cfg := config{}
+
+	defaultOpts := []Option{
+		WithSpanOptions(oteltrace.WithSpanKind(oteltrace.SpanKindServer)),


What is the reason for moving this part here?

This structure is also used in otelhttp, as seen [here](

opentelemetry-go-contrib/instrumentation/net/http/otelhttp/handler.go

Lines 52 to 60 in f368d04

func NewMiddleware(operation string, opts ...Option) func(http.Handler) http.Handler {

h := middleware{

operation: operation,

}

defaultOpts := []Option{

WithSpanOptions(trace.WithSpanKind(trace.SpanKindServer)),

WithSpanNameFormatter(defaultHandlerFormatter),

}

).

Let me know if you’d prefer to remove it.

According to the principle of Occam's Razor: Do not multiply entities beyond necessity.

From what I understand, the operating result would be the same even without modifying this part.

flc1125 · 2025-04-30T09:15:43Z

instrumentation/github.com/gin-gonic/gin/otelgin/test/gin_test.go

+	router := gin.New()
+	router.Use(otelgin.Middleware("foobar",
+		otelgin.WithTracerProvider(provider),
+		otelgin.WithSpanOptions(trace.WithAttributes(customAttr)),


WithSpanStartOptions

flc1125 · 2025-04-30T09:17:04Z

instrumentation/github.com/gin-gonic/gin/otelgin/test/gin_test.go

+	assert.Contains(t, span.Attributes(), customAttr)
+}
+
+func TestWithSpanOptions_PreservesDefaultSpanKind(t *testing.T) {


I think this part can be integrated with TestWithSpanOptions_AddsCustomAttributes.

Done. The implementation has been incorporated into TestWithSpanOptions_CustomAttributesAndSpanKind.

opentelemetry-go-contrib/instrumentation/github.com/gin-gonic/gin/otelgin/test/gin_test.go

Lines 270 to 273 in 9b26672

func TestWithSpanOptions_CustomAttributesAndSpanKind(t *testing.T) {

sr := tracetest.NewSpanRecorder()

provider := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))

flc1125 · 2025-05-05T12:27:09Z

Additionally, please correct the title of this PR.

flc1125

If you are ready for review, you can remove the draft mode.

github-actions bot requested review from akats7 and flc1125 April 24, 2025 07:35

arshukla98 marked this pull request as ready for review April 28, 2025 07:14

arshukla98 requested a review from a team as a code owner April 28, 2025 07:14

dmathieu reviewed Apr 28, 2025

View reviewed changes

arshukla98 marked this pull request as draft April 28, 2025 08:04

arshukla98 closed this Apr 30, 2025

arshukla98 force-pushed the Issue_7247 branch from f686f9a to b857249 Compare April 30, 2025 07:05

arshukla98 reopened this Apr 30, 2025

flc1125 reviewed Apr 30, 2025

View reviewed changes

arshukla98 force-pushed the Issue_7247 branch from fa3e6e6 to 9b26672 Compare May 5, 2025 06:42

arshukla98 marked this pull request as ready for review May 5, 2025 08:26

arshukla98 marked this pull request as draft May 5, 2025 13:12

otelgin: Add a WithSpanStartOptions option

9de11d8

arshukla98 force-pushed the Issue_7247 branch from 6fc5e70 to 9de11d8 Compare May 6, 2025 08:12

arshukla98 changed the title ~~otelgin: Add a WithSpanOptions option~~ otelgin: Add a WithSpanStartOptions option May 6, 2025

flc1125 approved these changes May 6, 2025

View reviewed changes

arshukla98 marked this pull request as ready for review May 6, 2025 10:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

otelgin: Add a WithSpanStartOptions option #7261

otelgin: Add a WithSpanStartOptions option #7261

arshukla98 commented Apr 24, 2025

codecov bot commented Apr 24, 2025 •

edited

Loading

dmathieu left a comment

flc1125 Apr 24, 2025

arshukla98 May 5, 2025

flc1125 Apr 30, 2025

arshukla98 May 5, 2025

flc1125 Apr 30, 2025

arshukla98 May 5, 2025

flc1125 May 5, 2025 •

edited

Loading

flc1125 Apr 30, 2025

arshukla98 May 5, 2025

flc1125 Apr 30, 2025

arshukla98 May 5, 2025

flc1125 commented May 5, 2025 •

edited

Loading

flc1125 left a comment

	func NewMiddleware(operation string, opts ...Option) func(http.Handler) http.Handler {
	h := middleware{
	operation: operation,
	}

	defaultOpts := []Option{
	WithSpanOptions(trace.WithSpanKind(trace.SpanKindServer)),
	WithSpanNameFormatter(defaultHandlerFormatter),
	}


	func TestWithSpanOptions_CustomAttributesAndSpanKind(t *testing.T) {
	sr := tracetest.NewSpanRecorder()
	provider := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))

otelgin: Add a WithSpanStartOptions option #7261

Are you sure you want to change the base?

otelgin: Add a WithSpanStartOptions option #7261

Conversation

arshukla98 commented Apr 24, 2025

codecov bot commented Apr 24, 2025 • edited Loading

Codecov Report

dmathieu 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

flc1125 May 5, 2025 • 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

flc1125 commented May 5, 2025 • edited Loading

flc1125 left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 24, 2025 •

edited

Loading

flc1125 May 5, 2025 •

edited

Loading

flc1125 commented May 5, 2025 •

edited

Loading