migrate spanTimeout

Author: mtoffl01

ddtrace/tracer/abandonedspans_test.go

@@ -133,7 +133,7 @@ func TestReportAbandonedSpans(t *testing.T) {
 		assert.Nil(err)
 		defer stop()
 		assert.True(tracer.config.internalConfig.DebugAbandonedSpans())
-		assert.Equal(tracer.config.spanTimeout, 100*time.Millisecond)
+		assert.Equal(tracer.config.internalConfig.SpanTimeout(), 100*time.Millisecond)
 	})
 
 	t.Run("finished", func(t *testing.T) {
@@ -351,7 +351,7 @@ func TestDebugAbandonedSpansOff(t *testing.T) {
 	t.Run("default", func(t *testing.T) {
 		assert := assert.New(t)
 		assert.False(tracer.config.internalConfig.DebugAbandonedSpans())
-		assert.Equal(time.Duration(0), tracer.config.spanTimeout)
+		assert.Equal(10*time.Minute, tracer.config.internalConfig.SpanTimeout())
 		expected := "Abandoned spans logs enabled."
 		s := tracer.StartSpan("operation", StartTime(spanStartTime))
 		time.Sleep(100 * time.Millisecond)

ddtrace/tracer/option.go

@@ -250,10 +250,6 @@ type config struct {
 	// peerServiceMappings holds a set of service mappings to dynamically rename peer.service values.
 	peerServiceMappings map[string]string
 
-	// spanTimeout represents how old a span can be before it should be logged as a possible
-	// misconfiguration
-	spanTimeout time.Duration
-
 	// statsComputationEnabled enables client-side stats computation (aka trace metrics).
 	statsComputationEnabled bool
 
@@ -398,9 +394,6 @@ func newConfig(opts ...StartOption) (*config, error) {
 			log.Warn("ignoring DD_TRACE_CLIENT_HOSTNAME_COMPAT, invalid version %q", compatMode)
 		}
 	}
-	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)
 
 	namingschema.LoadFromEnv()
@@ -1230,7 +1223,7 @@ func WithProfilerEndpoints(enabled bool) StartOption {
 func WithDebugSpansMode(timeout time.Duration) StartOption {
 	return func(c *config) {
 		c.internalConfig.SetDebugAbandonedSpans(true, internalconfig.OriginCode)
-		c.spanTimeout = timeout
+		c.internalConfig.SetSpanTimeout(timeout, internalconfig.OriginCode)
 	}
 }
 

ddtrace/tracer/option_test.go

@@ -882,15 +882,15 @@ func TestTracerOptionsDefaults(t *testing.T) {
 			c, err := newTestConfig(WithAgentTimeout(2))
 			assert.NoError(t, err)
 			assert.Equal(t, false, c.internalConfig.DebugAbandonedSpans())
-			assert.Equal(t, time.Duration(0), c.spanTimeout)
+			assert.Equal(t, 10*time.Minute, c.internalConfig.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.internalConfig.DebugAbandonedSpans())
-			assert.Equal(t, 10*time.Minute, c.spanTimeout)
+			assert.Equal(t, 10*time.Minute, c.internalConfig.SpanTimeout())
 		})
 
 		t.Run("timeout-set", func(t *testing.T) {
@@ -899,15 +899,15 @@ func TestTracerOptionsDefaults(t *testing.T) {
 			c, err := newTestConfig(WithAgentTimeout(2))
 			assert.NoError(t, err)
 			assert.Equal(t, true, c.internalConfig.DebugAbandonedSpans())
-			assert.Equal(t, time.Minute, c.spanTimeout)
+			assert.Equal(t, time.Minute, c.internalConfig.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.internalConfig.DebugAbandonedSpans())
-			assert.Equal(t, time.Second, c.spanTimeout)
+			assert.Equal(t, time.Second, c.internalConfig.SpanTimeout())
 		})
 	})
 

ddtrace/tracer/tracer.go

@@ -493,7 +493,7 @@ func newTracer(opts ...StartOption) (*tracer, error) {
 	if c.internalConfig.DebugAbandonedSpans() {
 		log.Info("Abandoned spans logs enabled.")
 		t.abandonedSpansDebugger = newAbandonedSpansDebugger()
-		t.abandonedSpansDebugger.Start(t.config.spanTimeout)
+		t.abandonedSpansDebugger.Start(t.config.internalConfig.SpanTimeout())
 	}
 	t.wg.Add(1)
 	go func() {

internal/config/config.go

@@ -56,7 +56,9 @@ type Config struct {
 	peerServiceDefaultsEnabled bool
 	peerServiceMappings        map[string]string
 	// debugAbandonedSpans controls if the tracer should log when old, open spans are found
-	debugAbandonedSpans  bool
+	debugAbandonedSpans bool
+	// spanTimeout represents how old a span can be before it should be logged as a possible
+	// misconfiguration. Unused if debugAbandonedSpans is false.
 	spanTimeout          time.Duration
 	partialFlushMinSpans int
 	// partialFlushEnabled specifices whether the tracer should enable partial flushing. Value
@@ -101,7 +103,7 @@ func loadConfig() *Config {
 	cfg.peerServiceDefaultsEnabled = provider.getBool("DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED", false)
 	cfg.peerServiceMappings = provider.getMap("DD_TRACE_PEER_SERVICE_MAPPING", nil)
 	cfg.debugAbandonedSpans = provider.getBool("DD_TRACE_DEBUG_ABANDONED_SPANS", false)
-	cfg.spanTimeout = provider.getDuration("DD_TRACE_ABANDONED_SPAN_TIMEOUT", 0)
+	cfg.spanTimeout = provider.getDuration("DD_TRACE_ABANDONED_SPAN_TIMEOUT", 10*time.Minute)
 	cfg.partialFlushMinSpans = provider.getIntWithValidator("DD_TRACE_PARTIAL_FLUSH_MIN_SPANS", 1000, validatePartialFlushMinSpans)
 	cfg.partialFlushEnabled = provider.getBool("DD_TRACE_PARTIAL_FLUSH_ENABLED", false)
 	cfg.statsComputationEnabled = provider.getBool("DD_TRACE_STATS_COMPUTATION_ENABLED", false)
@@ -340,3 +342,16 @@ func (c *Config) SetDebugAbandonedSpans(enabled bool, origin telemetry.Origin) {
 	c.debugAbandonedSpans = enabled
 	telemetry.RegisterAppConfig("DD_TRACE_DEBUG_ABANDONED_SPANS", enabled, origin)
 }
+
+func (c *Config) SpanTimeout() time.Duration {
+	c.mu.RLock()
+	defer c.mu.RUnlock()
+	return c.spanTimeout
+}
+
+func (c *Config) SetSpanTimeout(timeout time.Duration, origin telemetry.Origin) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	c.spanTimeout = timeout
+	telemetry.RegisterAppConfig("DD_TRACE_ABANDONED_SPAN_TIMEOUT", timeout, origin)
+}