Skip to content

Commit 65306ed

Browse files
andrewlockandrewlock
committed
Update docs
1 parent af12149 commit 65306ed

File tree

7 files changed

+24
-19
lines changed

7 files changed

+24
-19
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -379,16 +379,16 @@ not null when string.Equals(value, "otlp", StringComparison.OrdinalIgnoreCase) =
379379
.AsBool(defaultValue: true);
380380

381381
SingleSpanAspNetCoreEnabled = config
382-
.WithKeys(ConfigurationKeys.FeatureFlags.SingleSpanAspnetcoreEnabled)
382+
.WithKeys(ConfigurationKeys.FeatureFlags.SingleSpanAspNetCoreEnabled)
383383
.AsBool(defaultValue: false);
384384
#if !NET6_0_OR_GREATER
385385
// single span aspnetcore is only supported in .NET 6+, so override for telemetry purposes
386386
if (SingleSpanAspNetCoreEnabled)
387387
{
388388
SingleSpanAspNetCoreEnabled = false;
389389
Log.Warning(
390-
$"{ConfigurationKeys.FeatureFlags.SingleSpanAspnetcoreEnabled} is set, but is only supported in .NET 6+");
391-
_telemetry.Record(ConfigurationKeys.FeatureFlags.SingleSpanAspnetcoreEnabled, false, ConfigurationOrigins.Calculated);
390+
$"{ConfigurationKeys.FeatureFlags.SingleSpanAspNetCoreEnabled} is set, but is only supported in .NET 6+");
391+
_telemetry.Record(ConfigurationKeys.FeatureFlags.SingleSpanAspNetCoreEnabled, false, ConfigurationOrigins.Calculated);
392392
}
393393
#endif
394394

@@ -1110,7 +1110,7 @@ not null when string.Equals(value, "otlp", StringComparison.OrdinalIgnoreCase) =
11101110
/// <summary>
11111111
/// Gets a value indicating whether single-span ASP.NET Core instrumentation should be used.
11121112
/// </summary>
1113-
/// <seealso cref="ConfigurationKeys.FeatureFlags.SingleSpanAspnetcoreEnabled"/>
1113+
/// <seealso cref="ConfigurationKeys.FeatureFlags.SingleSpanAspNetCoreEnabled"/>
11141114
internal bool SingleSpanAspNetCoreEnabled { get; }
11151115

11161116
/// <summary>

‎tracer/src/Datadog.Trace/Configuration/configuration_keys_mapping.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@
606606
},
607607
{
608608
"env_var": "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED",
609-
"const_name": "SingleSpanAspnetcoreEnabled"
609+
"const_name": "SingleSpanAspNetCoreEnabled"
610610
},
611611
{
612612
"env_var": "DD_SPAN_SAMPLING_RULES",

‎tracer/src/Datadog.Trace/Configuration/supported-configurations-docs.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1038,8 +1038,9 @@ DD_TRACE_SERVICE_MAPPING: |
10381038
<seealso cref="Datadog.Trace.Configuration.MutableSettings.ServiceNameMappings"/>
10391039
10401040
DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED: |
1041-
Feature Flag: enables single-span ASP.NET Core traces, by only creating `aspnet_core.request` spans, without
1042-
creating handler spans or tracking specific route values. Defaults to <c>false</c>. Not compatible with
1041+
Feature Flag: Enables generating only a single span in the ASP.NET Core integration,
1042+
by only creating `aspnet_core.request` spans, without creating handler spans or tracking
1043+
specific route values. Defaults to <c>false</c>. Not compatible with
10431044
DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED (that value is ignored), but may be used
10441045
with DD_TRACE_EXPAND_ROUTE_TEMPLATES_ENABLED. Only supported on .NET 6+.
10451046
<seealso cref="Datadog.Trace.Configuration.TracerSettings.SingleSpanAspNetCoreEnabled"/>

‎tracer/src/Datadog.Trace/Generated/net461/Datadog.Trace.SourceGenerators/ConfigurationKeysGenerator/ConfigurationKeys.FeatureFlags.g.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,14 @@ internal static class FeatureFlags
103103
public const string RouteTemplateResourceNamesEnabled = "DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED";
104104

105105
/// <summary>
106-
/// Feature Flag: enables single-span ASP.NET Core traces, by only creating `aspnet_core.request` spans, without
107-
/// creating handler spans or tracking specific route values. Defaults to <c>false</c>. Not compatible with
106+
/// Feature Flag: Enables generating only a single span in the ASP.NET Core integration,
107+
/// by only creating `aspnet_core.request` spans, without creating handler spans or tracking
108+
/// specific route values. Defaults to <c>false</c>. Not compatible with
108109
/// DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED (that value is ignored), but may be used
109110
/// with DD_TRACE_EXPAND_ROUTE_TEMPLATES_ENABLED. Only supported on .NET 6+.
110111
/// </summary>
111112
/// <seealso cref="Datadog.Trace.Configuration.TracerSettings.SingleSpanAspNetCoreEnabled"/>
112-
public const string SingleSpanAspnetcoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113+
public const string SingleSpanAspNetCoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113114

114115
/// <summary>
115116
/// Feature flag to enable obfuscating the <c>LocalPath</c> of a WCF request that goes

‎tracer/src/Datadog.Trace/Generated/net6.0/Datadog.Trace.SourceGenerators/ConfigurationKeysGenerator/ConfigurationKeys.FeatureFlags.g.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,14 @@ internal static class FeatureFlags
103103
public const string RouteTemplateResourceNamesEnabled = "DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED";
104104

105105
/// <summary>
106-
/// Feature Flag: enables single-span ASP.NET Core traces, by only creating `aspnet_core.request` spans, without
107-
/// creating handler spans or tracking specific route values. Defaults to <c>false</c>. Not compatible with
106+
/// Feature Flag: Enables generating only a single span in the ASP.NET Core integration,
107+
/// by only creating `aspnet_core.request` spans, without creating handler spans or tracking
108+
/// specific route values. Defaults to <c>false</c>. Not compatible with
108109
/// DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED (that value is ignored), but may be used
109110
/// with DD_TRACE_EXPAND_ROUTE_TEMPLATES_ENABLED. Only supported on .NET 6+.
110111
/// </summary>
111112
/// <seealso cref="Datadog.Trace.Configuration.TracerSettings.SingleSpanAspNetCoreEnabled"/>
112-
public const string SingleSpanAspnetcoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113+
public const string SingleSpanAspNetCoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113114

114115
/// <summary>
115116
/// Feature flag to enable obfuscating the <c>LocalPath</c> of a WCF request that goes

‎tracer/src/Datadog.Trace/Generated/netcoreapp3.1/Datadog.Trace.SourceGenerators/ConfigurationKeysGenerator/ConfigurationKeys.FeatureFlags.g.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,14 @@ internal static class FeatureFlags
103103
public const string RouteTemplateResourceNamesEnabled = "DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED";
104104

105105
/// <summary>
106-
/// Feature Flag: enables single-span ASP.NET Core traces, by only creating `aspnet_core.request` spans, without
107-
/// creating handler spans or tracking specific route values. Defaults to <c>false</c>. Not compatible with
106+
/// Feature Flag: Enables generating only a single span in the ASP.NET Core integration,
107+
/// by only creating `aspnet_core.request` spans, without creating handler spans or tracking
108+
/// specific route values. Defaults to <c>false</c>. Not compatible with
108109
/// DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED (that value is ignored), but may be used
109110
/// with DD_TRACE_EXPAND_ROUTE_TEMPLATES_ENABLED. Only supported on .NET 6+.
110111
/// </summary>
111112
/// <seealso cref="Datadog.Trace.Configuration.TracerSettings.SingleSpanAspNetCoreEnabled"/>
112-
public const string SingleSpanAspnetcoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113+
public const string SingleSpanAspNetCoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113114

114115
/// <summary>
115116
/// Feature flag to enable obfuscating the <c>LocalPath</c> of a WCF request that goes

‎tracer/src/Datadog.Trace/Generated/netstandard2.0/Datadog.Trace.SourceGenerators/ConfigurationKeysGenerator/ConfigurationKeys.FeatureFlags.g.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,14 @@ internal static class FeatureFlags
103103
public const string RouteTemplateResourceNamesEnabled = "DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED";
104104

105105
/// <summary>
106-
/// Feature Flag: enables single-span ASP.NET Core traces, by only creating `aspnet_core.request` spans, without
107-
/// creating handler spans or tracking specific route values. Defaults to <c>false</c>. Not compatible with
106+
/// Feature Flag: Enables generating only a single span in the ASP.NET Core integration,
107+
/// by only creating `aspnet_core.request` spans, without creating handler spans or tracking
108+
/// specific route values. Defaults to <c>false</c>. Not compatible with
108109
/// DD_TRACE_ROUTE_TEMPLATE_RESOURCE_NAMES_ENABLED (that value is ignored), but may be used
109110
/// with DD_TRACE_EXPAND_ROUTE_TEMPLATES_ENABLED. Only supported on .NET 6+.
110111
/// </summary>
111112
/// <seealso cref="Datadog.Trace.Configuration.TracerSettings.SingleSpanAspNetCoreEnabled"/>
112-
public const string SingleSpanAspnetcoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113+
public const string SingleSpanAspNetCoreEnabled = "DD_TRACE_SINGLE_SPAN_ASPNETCORE_ENABLED";
113114

114115
/// <summary>
115116
/// Feature flag to enable obfuscating the <c>LocalPath</c> of a WCF request that goes

0 commit comments

Comments
 (0)