Skip to content

Commit 94f1261

Browse files
committed
Fix comments about missing properties
1 parent 215c8f4 commit 94f1261

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

tracer/src/Datadog.Trace.Manual/Configuration/TracerSettings.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,12 @@ public bool TracerMetricsEnabled
351351
}
352352

353353
/// <summary>
354-
/// Gets or sets a value indicating whether stats are computed on the tracer side
354+
/// Gets or sets a value indicating whether stats are computed on the tracer side.
355+
///
356+
/// NOTE: as of tracer version 3.27.0, this property cannot be used to enable or
357+
/// disable stats computation. You must use a static configuration source such
358+
/// as environment variables or datadog.json to set the property instead. This
359+
/// property will be marked obsolete and removed in a future version of Datadog.Trace.
355360
/// </summary>
356361
public bool StatsComputationEnabled
357362
{

tracer/src/Datadog.Trace/Configuration/MutableSettings.cs

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,12 @@ private MutableSettings(
135135
public ReadOnlyDictionary<string, string> HeaderTags { get; }
136136

137137
// Additional settings that can be set in code
138-
139-
// TODO: This one will be hard, we should likely consider something completely different to handle these changes
140-
// public const string AgentUriKey = "DD_TRACE_AGENT_URL";
141-
142-
// TODO: this one is a problem - it can be changed in code, but the data pipeline needs to be enabled/disabled based on it
143-
// we will likely need to make a breaking change so that it _can't_ be changed in code
144-
// public const string StatsComputationEnabledKey = "DD_TRACE_STATS_COMPUTATION_ENABLED";
138+
// NOTE: this includes everything except:
139+
// - DD_TRACE_AGENT_URL; This can be set in code, but is handled separately in TracerSettings
140+
// - DD_TRACE_STATS_COMPUTATION_ENABLED; This can currently be set in code, but it's problematic for
141+
// various reasons related to data pipeline, so this change makes it so that you CAN'T set the value
142+
// in code, despite the API appearing to let you. The change is addressed via documentation, and
143+
// in the future we should remove the property entirely (or at least mark it as obsolete)
145144

146145
/// <summary>
147146
/// Gets a value indicating whether the diagnostic log at startup is enabled

0 commit comments

Comments
 (0)