migrate debugAbandonedSpans

Author: mtoffl01

ddtrace/tracer/abandonedspans_test.go

@@ -132,7 +132,7 @@ func TestReportAbandonedSpans(t *testing.T) {
 		tracer, _, _, stop, err := startTestTracer(t, WithLogger(tp), WithDebugSpansMode(100*time.Millisecond))
 		assert.Nil(err)
 		defer stop()
-		assert.True(tracer.config.debugAbandonedSpans)
+		assert.True(tracer.config.internalConfig.DebugAbandonedSpans())
 		assert.Equal(tracer.config.spanTimeout, 100*time.Millisecond)
 	})
 
@@ -350,7 +350,7 @@ func TestDebugAbandonedSpansOff(t *testing.T) {
 
 	t.Run("default", func(t *testing.T) {
 		assert := assert.New(t)
-		assert.False(tracer.config.debugAbandonedSpans)
+		assert.False(tracer.config.internalConfig.DebugAbandonedSpans())
 		assert.Equal(time.Duration(0), tracer.config.spanTimeout)
 		expected := "Abandoned spans logs enabled."
 		s := tracer.StartSpan("operation", StartTime(spanStartTime))

ddtrace/tracer/option.go

@@ -250,9 +250,6 @@ type config struct {
 	// peerServiceMappings holds a set of service mappings to dynamically rename peer.service values.
 	peerServiceMappings map[string]string
 
-	// debugAbandonedSpans controls if the tracer should log when old, open spans are found
-	debugAbandonedSpans bool
-
 	// spanTimeout represents how old a span can be before it should be logged as a possible
 	// misconfiguration
 	spanTimeout time.Duration
@@ -401,8 +398,7 @@ func newConfig(opts ...StartOption) (*config, error) {
 			log.Warn("ignoring DD_TRACE_CLIENT_HOSTNAME_COMPAT, invalid version %q", compatMode)
 		}
 	}
-	c.debugAbandonedSpans = internal.BoolEnv("DD_TRACE_DEBUG_ABANDONED_SPANS", false)
-	if c.debugAbandonedSpans {
+	if c.internalConfig.DebugAbandonedSpans() {
 		c.spanTimeout = internal.DurationEnv("DD_TRACE_ABANDONED_SPAN_TIMEOUT", 10*time.Minute)
 	}
 	c.statsComputationEnabled = internal.BoolEnv("DD_TRACE_STATS_COMPUTATION_ENABLED", true)
@@ -1233,7 +1229,7 @@ func WithProfilerEndpoints(enabled bool) StartOption {
 // be expensive, so it should only be enabled for debugging purposes.
 func WithDebugSpansMode(timeout time.Duration) StartOption {
 	return func(c *config) {
-		c.debugAbandonedSpans = true
+		c.internalConfig.SetDebugAbandonedSpans(true, internalconfig.OriginCode)
 		c.spanTimeout = timeout
 	}
 }

ddtrace/tracer/option_test.go

@@ -881,15 +881,15 @@ func TestTracerOptionsDefaults(t *testing.T) {
 		t.Run("defaults", func(t *testing.T) {
 			c, err := newTestConfig(WithAgentTimeout(2))
 			assert.NoError(t, err)
-			assert.Equal(t, false, c.debugAbandonedSpans)
+			assert.Equal(t, false, c.internalConfig.DebugAbandonedSpans())
 			assert.Equal(t, time.Duration(0), c.spanTimeout)
 		})
 
 		t.Run("debug-on", func(t *testing.T) {
 			t.Setenv("DD_TRACE_DEBUG_ABANDONED_SPANS", "true")
 			c, err := newTestConfig(WithAgentTimeout(2))
 			assert.NoError(t, err)
-			assert.Equal(t, true, c.debugAbandonedSpans)
+			assert.Equal(t, true, c.internalConfig.DebugAbandonedSpans())
 			assert.Equal(t, 10*time.Minute, c.spanTimeout)
 		})
 
@@ -898,15 +898,15 @@ func TestTracerOptionsDefaults(t *testing.T) {
 			t.Setenv("DD_TRACE_ABANDONED_SPAN_TIMEOUT", fmt.Sprint(time.Minute))
 			c, err := newTestConfig(WithAgentTimeout(2))
 			assert.NoError(t, err)
-			assert.Equal(t, true, c.debugAbandonedSpans)
+			assert.Equal(t, true, c.internalConfig.DebugAbandonedSpans())
 			assert.Equal(t, time.Minute, c.spanTimeout)
 		})
 
 		t.Run("with-function", func(t *testing.T) {
 			c, err := newTestConfig(WithAgentTimeout(2))
 			assert.NoError(t, err)
 			WithDebugSpansMode(time.Second)(c)
-			assert.Equal(t, true, c.debugAbandonedSpans)
+			assert.Equal(t, true, c.internalConfig.DebugAbandonedSpans())
 			assert.Equal(t, time.Second, c.spanTimeout)
 		})
 	})

ddtrace/tracer/span.go

@@ -746,7 +746,7 @@ func (s *Span) finish(finishTime int64) {
 			// the agent supports dropping p0's in the client
 			keep = shouldKeep(s)
 		}
-		if tracer.config.debugAbandonedSpans {
+		if tracer.config.internalConfig.DebugAbandonedSpans() {
 			// the tracer supports debugging abandoned spans
 			tracer.submitAbandonedSpan(s, true)
 		}

ddtrace/tracer/tracer.go

@@ -490,7 +490,7 @@ func newTracer(opts ...StartOption) (*tracer, error) {
 			t.reportRuntimeMetrics(defaultMetricsReportInterval)
 		}()
 	}
-	if c.debugAbandonedSpans {
+	if c.internalConfig.DebugAbandonedSpans() {
 		log.Info("Abandoned spans logs enabled.")
 		t.abandonedSpansDebugger = newAbandonedSpansDebugger()
 		t.abandonedSpansDebugger.Start(t.config.spanTimeout)
@@ -806,7 +806,7 @@ func (t *tracer) StartSpan(operationName string, options ...StartSpanOption) *Sp
 	} else {
 		span.pprofCtxRestore = nil
 	}
-	if t.config.debugAbandonedSpans {
+	if t.config.internalConfig.DebugAbandonedSpans() {
 		select {
 		case t.abandonedSpansDebugger.In <- newAbandonedSpanCandidate(span, false):
 			// ok
@@ -972,7 +972,7 @@ func (t *tracer) TracerConf() TracerConf {
 	return TracerConf{
 		CanComputeStats:      t.config.canComputeStats(),
 		CanDropP0s:           t.config.canDropP0s(),
-		DebugAbandonedSpans:  t.config.debugAbandonedSpans,
+		DebugAbandonedSpans:  t.config.internalConfig.DebugAbandonedSpans(),
 		Disabled:             !t.config.enabled.current,
 		PartialFlush:         t.config.internalConfig.PartialFlushEnabled(),
 		PartialFlushMinSpans: t.config.internalConfig.PartialFlushMinSpans(),

internal/config/config.go

@@ -55,9 +55,10 @@ type Config struct {
 	spanAttributeSchemaVersion int
 	peerServiceDefaultsEnabled bool
 	peerServiceMappings        map[string]string
-	debugAbandonedSpans        bool
-	spanTimeout                time.Duration
-	partialFlushMinSpans       int
+	// debugAbandonedSpans controls if the tracer should log when old, open spans are found
+	debugAbandonedSpans  bool
+	spanTimeout          time.Duration
+	partialFlushMinSpans int
 	// partialFlushEnabled specifices whether the tracer should enable partial flushing. Value
 	// from DD_TRACE_PARTIAL_FLUSH_ENABLED, default false.
 	partialFlushEnabled          bool
@@ -326,3 +327,16 @@ func (c *Config) SetDynamicInstrumentationEnabled(enabled bool, origin telemetry
 	c.dynamicInstrumentationEnabled = enabled
 	telemetry.RegisterAppConfig("DD_DYNAMIC_INSTRUMENTATION_ENABLED", enabled, origin)
 }
+
+func (c *Config) DebugAbandonedSpans() bool {
+	c.mu.RLock()
+	defer c.mu.RUnlock()
+	return c.debugAbandonedSpans
+}
+
+func (c *Config) SetDebugAbandonedSpans(enabled bool, origin telemetry.Origin) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	c.debugAbandonedSpans = enabled
+	telemetry.RegisterAppConfig("DD_TRACE_DEBUG_ABANDONED_SPANS", enabled, origin)
+}