special case for logging factory..

anna-git · anna-git · commit 11dc3980a2a6 · 2025-10-08T15:06:23.000+02:00
diff --git a/tracer/missing-nullability-files.csv b/tracer/missing-nullability-files.csv
@@ -88,7 +88,7 @@ src/Datadog.Trace/Configuration/ConfigurationKeys.Iast.cs
 src/Datadog.Trace/Configuration/ConfigurationKeys.Logging.cs
 src/Datadog.Trace/Configuration/ConfigurationKeys.Rcm.cs
 src/Datadog.Trace/Configuration/DbmPropagationLevel.cs
-src/Datadog.Trace/Configuration/DeprecationMessages.cs
+src/Datadog.Trace/Configuration/DeprecationConstants.cs
 src/Datadog.Trace/Configuration/IDynamicConfigurationManager.cs
 src/Datadog.Trace/Configuration/IntegrationRegistry.cs
 src/Datadog.Trace/Configuration/TracerSettingsConstants.cs
diff --git a/tracer/src/Datadog.Trace.Manual/Configuration/ImmutableTracerSettings.cs b/tracer/src/Datadog.Trace.Manual/Configuration/ImmutableTracerSettings.cs
@@ -131,7 +131,7 @@ public bool TraceEnabled
     /// </summary>
     /// <seealso cref="ConfigurationKeys.GlobalAnalyticsEnabled"/>
 #pragma warning restore CS1574
-    [Obsolete(DeprecationMessages.AppAnalytics)]
+    [Obsolete(DeprecationConstants.AppAnalytics)]
     public bool AnalyticsEnabled
     {
         [Instrumented]
diff --git a/tracer/src/Datadog.Trace.Manual/Configuration/TracerSettings.cs b/tracer/src/Datadog.Trace.Manual/Configuration/TracerSettings.cs
@@ -214,7 +214,7 @@ public string? ServiceVersion
     /// <see cref="Configuration.IntegrationSettings.AnalyticsEnabled"/> on some predetermined integrations.
     /// See the documentation for more details.
     /// </summary>
-    [Obsolete(DeprecationMessages.AppAnalytics)]
+    [Obsolete(DeprecationConstants.AppAnalytics)]
     public bool AnalyticsEnabled
     {
         [Instrumented]
diff --git a/tracer/src/Datadog.Trace.Manual/Datadog.Trace.Manual.csproj b/tracer/src/Datadog.Trace.Manual/Datadog.Trace.Manual.csproj
@@ -26,7 +26,8 @@
     <Compile Include="..\Datadog.Trace\Ci\TestStatus.cs" Link="Ci\%(Filename)%(Extension)" />
     <Compile Include="..\Datadog.Trace\ClrProfiler\AutoInstrumentation\ManualInstrumentation\TracerSettingKeyConstants.cs"  Link="Configuration\%(Filename)%(Extension)" />
     <Compile Include="..\Datadog.Trace\ClrProfiler\AutoInstrumentation\ManualInstrumentation\IntegrationSettingsSerializationHelper.cs"  Link="Configuration\%(Filename)%(Extension)" />
-    <Compile Include="..\Datadog.Trace\Configuration\DeprecationMessages.cs" Link="Configuration\%(Filename)%(Extension)" />
+    <Compile Include="..\Datadog.Trace\Configuration\DeprecationConstants.cs" 
+             Link="Configuration\%(Filename)%(Extension)" />
     <Compile Include="..\Datadog.Trace\DuckTyping\DuckAsClassAttribute.cs" Link="DuckTyping\%(Filename)%(Extension)" />
     <Compile Include="..\Datadog.Trace\HttpHeaderNames.cs" />
     <Compile Include="..\Datadog.Trace\IDatadogOpenTracingTracer.cs" />
diff --git a/tracer/src/Datadog.Trace.Tools.Runner/ProcessConfiguration.cs b/tracer/src/Datadog.Trace.Tools.Runner/ProcessConfiguration.cs
@@ -54,9 +54,10 @@ internal static class ProcessConfiguration
 
             if (logDirectory == null)
             {
-#pragma warning disable 618 // ProfilerLogPath is deprecated but still supported
-                var nativeLogFile = config.WithKeys(ConfigurationKeys.ProfilerLogPath).AsString();
-#pragma warning restore 618
+                // ProfilerLogPath is deprecated but still supported. For now, we bypass the WithKeys analyzer, but later we want to pull deprecations differently as part of centralized file
+#pragma warning disable DD0008, 618
+                var nativeLogFile = config.WithKeys(DeprecationConstants.ProfilerLogPath).AsString();
+#pragma warning restore DD0008, 618
                 if (!string.IsNullOrEmpty(nativeLogFile))
                 {
                     logDirectory = Path.GetDirectoryName(nativeLogFile);
diff --git a/tracer/src/Datadog.Trace.Tools.dd_dotnet/Datadog.Trace.Tools.dd_dotnet.csproj b/tracer/src/Datadog.Trace.Tools.dd_dotnet/Datadog.Trace.Tools.dd_dotnet.csproj
@@ -59,7 +59,7 @@
     <Compile Include="..\Datadog.Trace\Agent\TracesTransportType.cs" Link="TracesTransportType.cs" />
     <Compile Include="..\Datadog.Trace\Configuration\ConfigurationKeys.cs" Link="ConfigurationKeys.cs" />
     <Compile Include="..\Datadog.Trace\Configuration\ConfigurationKeys.Exporter.cs" Link="ConfigurationKeys.Exporter.cs" />
-    <Compile Include="..\Datadog.Trace\Configuration\DeprecationMessages.cs" Link="DeprecationMessages.cs" />
+    <Compile Include="..\Datadog.Trace\Configuration\DeprecationConstants.cs" Link="DeprecationMessages.cs" />
     <Compile Include="..\Datadog.Trace\Configuration\ExporterSettings.Shared.cs" Link="ExporterSettings.Shared.cs" />
   </ItemGroup>
 
diff --git a/tracer/src/Datadog.Trace/Configuration/ConfigurationKeys.Logging.cs b/tracer/src/Datadog.Trace/Configuration/ConfigurationKeys.Logging.cs
@@ -29,17 +29,9 @@ internal static partial class ConfigurationKeys
         /// </summary>
         public const string LogRateLimit = "DD_TRACE_LOGGING_RATE";
 
-        /// <summary>
-        /// Configuration key for setting the path to the .NET Tracer native log file.
-        /// This also determines the output folder of the .NET Tracer managed log files.
-        /// Overridden by <see cref="LogDirectory"/> if present.
-        /// </summary>
-        [Obsolete(DeprecationMessages.LogPath)]
-        public const string ProfilerLogPath = "DD_TRACE_LOG_PATH";
-
         /// <summary>
         /// Configuration key for setting the directory of the .NET Tracer logs.
-        /// Overrides the value in <see cref="ProfilerLogPath"/> if present.
+        /// Overrides the value in <see cref="DeprecationConstants.ProfilerLogPath"/> if present.
         /// Default value is "%ProgramData%"\Datadog .NET Tracer\logs\" on Windows
         /// or "/var/log/datadog/dotnet/" on Linux.
         /// </summary>
diff --git a/tracer/src/Datadog.Trace/Configuration/ConfigurationKeys.cs b/tracer/src/Datadog.Trace/Configuration/ConfigurationKeys.cs
@@ -148,7 +148,7 @@ internal static partial class ConfigurationKeys
         /// Configuration key for enabling or disabling default Analytics.
         /// </summary>
         /// <seealso cref="TracerSettings.AnalyticsEnabled"/>
-        [Obsolete(DeprecationMessages.AppAnalytics)]
+        [Obsolete(DeprecationConstants.AppAnalytics)]
         public const string GlobalAnalyticsEnabled = "DD_TRACE_ANALYTICS_ENABLED";
 
         /// <summary>
diff --git a/tracer/src/Datadog.Trace/Configuration/DeprecationConstants.cs b/tracer/src/Datadog.Trace/Configuration/DeprecationConstants.cs
@@ -1,13 +1,18 @@
-﻿// <copyright file="DeprecationMessages.cs" company="Datadog">
+﻿// <copyright file="DeprecationConstants.cs" company="Datadog">
 // Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
 // This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
 // </copyright>
 
+using System;
+
 namespace Datadog.Trace.Configuration
 {
-    internal static class DeprecationMessages
+    internal static class DeprecationConstants
     {
         public const string AppAnalytics = "App Analytics has been replaced by Tracing without Limits. For more information see https://docs.datadoghq.com/tracing/legacy_app_analytics/";
-        public const string LogPath = "DD_TRACE_LOG_PATH is deprecated. Use DD_TRACE_LOG_DIRECTORY instead";
+        public const string ProfilerLogPathObsoleteMessage = "DD_TRACE_LOG_PATH is deprecated. Use DD_TRACE_LOG_DIRECTORY instead";
+
+        [Obsolete(ProfilerLogPathObsoleteMessage)]
+        public const string ProfilerLogPath = "DD_TRACE_LOG_PATH";
     }
 }
diff --git a/tracer/src/Datadog.Trace/Configuration/IntegrationSettings.cs b/tracer/src/Datadog.Trace/Configuration/IntegrationSettings.cs
@@ -24,13 +24,13 @@ public class IntegrationSettings : IEquatable<IntegrationSettings>
         /// <summary>
         /// Configuration key pattern for enabling or disabling Analytics in an integration.
         /// </summary>
-        [Obsolete(DeprecationMessages.AppAnalytics)]
+        [Obsolete(DeprecationConstants.AppAnalytics)]
         public const string AnalyticsEnabledKey = "DD_TRACE_{0}_ANALYTICS_ENABLED";
 
         /// <summary>
         /// Configuration key pattern for setting Analytics sampling rate in an integration.
         /// </summary>
-        [Obsolete(DeprecationMessages.AppAnalytics)]
+        [Obsolete(DeprecationConstants.AppAnalytics)]
         public const string AnalyticsSampleRateKey = "DD_TRACE_{0}_ANALYTICS_SAMPLE_RATE";
 
         /// <summary>
diff --git a/tracer/src/Datadog.Trace/Configuration/MutableSettings.cs b/tracer/src/Datadog.Trace/Configuration/MutableSettings.cs
@@ -195,7 +195,7 @@ private MutableSettings(
     /// See the documentation for more details.
     /// </summary>
     /// <seealso cref="ConfigurationKeys.GlobalAnalyticsEnabled"/>
-    [Obsolete(DeprecationMessages.AppAnalytics)]
+    [Obsolete(DeprecationConstants.AppAnalytics)]
     public bool AnalyticsEnabled { get; }
 
     /// <summary>
@@ -525,7 +525,7 @@ internal bool IsIntegrationEnabled(IntegrationId integration, bool defaultValue
         return false;
     }
 
-    [Obsolete(DeprecationMessages.AppAnalytics)]
+    [Obsolete(DeprecationConstants.AppAnalytics)]
     internal double? GetIntegrationAnalyticsSampleRate(IntegrationId integration, bool enabledWithGlobalSetting)
     {
         var integrationSettings = Integrations[integration];
diff --git a/tracer/src/Datadog.Trace/Configuration/TracerSettings.cs b/tracer/src/Datadog.Trace/Configuration/TracerSettings.cs
@@ -774,7 +774,7 @@ not null when string.Equals(x, "lowmemory", StringComparison.OrdinalIgnoreCase)
         public ExporterSettings Exporter { get; }
 
         /// <inheritdoc cref="MutableSettings.AnalyticsEnabled"/>
-        [Obsolete(DeprecationMessages.AppAnalytics)]
+        [Obsolete(DeprecationConstants.AppAnalytics)]
         public bool AnalyticsEnabled => MutableSettings.AnalyticsEnabled;
 
         /// <inheritdoc cref="MutableSettings.LogsInjectionEnabled"/>
@@ -1225,7 +1225,7 @@ internal bool IsErrorStatusCode(int statusCode, bool serverStatusCode)
         internal bool IsIntegrationEnabled(IntegrationId integration, bool defaultValue = true)
             => DynamicSettings.TraceEnabled != false && MutableSettings.IsIntegrationEnabled(integration, defaultValue);
 
-        [Obsolete(DeprecationMessages.AppAnalytics)]
+        [Obsolete(DeprecationConstants.AppAnalytics)]
         internal double? GetIntegrationAnalyticsSampleRate(IntegrationId integration, bool enabledWithGlobalSetting)
             => MutableSettings.GetIntegrationAnalyticsSampleRate(integration, enabledWithGlobalSetting);
 
diff --git a/tracer/src/Datadog.Trace/Logging/Internal/DatadogLoggingFactory.cs b/tracer/src/Datadog.Trace/Logging/Internal/DatadogLoggingFactory.cs
@@ -170,12 +170,15 @@ internal static string GetLogDirectory(IConfigurationTelemetry telemetry)
 
     private static string GetLogDirectory(IConfigurationSource source, IConfigurationTelemetry telemetry)
     {
-        var logDirectory = new ConfigurationBuilder(source, telemetry).WithKeys(ConfigurationKeys.LogDirectory).AsString();
+        var configurationBuilder = new ConfigurationBuilder(source, telemetry);
+        var logDirectory = configurationBuilder.WithKeys(ConfigurationKeys.LogDirectory).AsString();
         if (string.IsNullOrEmpty(logDirectory))
         {
-#pragma warning disable 618 // ProfilerLogPath is deprecated but still supported
-            var nativeLogFile = new ConfigurationBuilder(source, telemetry).WithKeys(ConfigurationKeys.ProfilerLogPath).AsString();
-#pragma warning restore 618
+            // todo, handle in phase 2 with deprecations
+// ProfilerLogPath is deprecated but still supported. For now, we bypass the WithKeys analyzer, but later we want to pull deprecations differently as part of centralized file
+#pragma warning disable DD0008, 618
+            var nativeLogFile = configurationBuilder.WithKeys(DeprecationConstants.ProfilerLogPath).AsString();
+#pragma warning restore DD0008, 618
 
             if (!string.IsNullOrEmpty(nativeLogFile))
             {
diff --git a/tracer/test/Datadog.Trace.Tests/Logging/DatadogLoggingFactoryTests.cs b/tracer/test/Datadog.Trace.Tests/Logging/DatadogLoggingFactoryTests.cs
@@ -32,7 +32,7 @@ public void UsesLogDirectoryWhenItExists(string obsoleteLogDirectory)
                 {
                     { ConfigurationKeys.LogDirectory, logDirectory },
 #pragma warning disable CS0618
-                    { ConfigurationKeys.ProfilerLogPath, obsoleteLogDirectory },
+                    { DeprecationConstants.ProfilerLogPath, obsoleteLogDirectory },
 #pragma warning restore CS0618
                 });
 
@@ -55,7 +55,7 @@ public void UsesObsoleteLogDirectoryWhenAvailable(string logDirectory)
                 {
                     { ConfigurationKeys.LogDirectory, logDirectory },
 #pragma warning disable CS0618
-                    { ConfigurationKeys.ProfilerLogPath, obsoleteLogPath },
+                    { DeprecationConstants.ProfilerLogPath, obsoleteLogPath },
 #pragma warning restore CS0618
                 });
 
@@ -76,7 +76,7 @@ public void UsesEnvironmentFallBackWhenBothNull(string logDirectory, string obso
                 {
                     { ConfigurationKeys.LogDirectory, logDirectory },
 #pragma warning disable CS0618
-                    { ConfigurationKeys.ProfilerLogPath, obsoleteLogDirectory },
+                    { DeprecationConstants.ProfilerLogPath, obsoleteLogDirectory },
 #pragma warning restore CS0618
                 });
 

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ public bool TraceEnabled`
`131`	`131`	`/// </summary>`
`132`	`132`	`/// <seealso cref="ConfigurationKeys.GlobalAnalyticsEnabled"/>`
`133`	`133`	`#pragma warning restore CS1574`
`134`		`- [Obsolete(DeprecationMessages.AppAnalytics)]`
	`134`	`+ [Obsolete(DeprecationConstants.AppAnalytics)]`
`135`	`135`	`public bool AnalyticsEnabled`
`136`	`136`	`{`
`137`	`137`	`[Instrumented]`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ public string? ServiceVersion`
`214`	`214`	`/// <see cref="Configuration.IntegrationSettings.AnalyticsEnabled"/> on some predetermined integrations.`
`215`	`215`	`/// See the documentation for more details.`
`216`	`216`	`/// </summary>`
`217`		`- [Obsolete(DeprecationMessages.AppAnalytics)]`
	`217`	`+ [Obsolete(DeprecationConstants.AppAnalytics)]`
`218`	`218`	`public bool AnalyticsEnabled`
`219`	`219`	`{`
`220`	`220`	`[Instrumented]`
Original file line number	Diff line number	Diff line change
`@@ -54,9 +54,10 @@ internal static class ProcessConfiguration`
`54`	`54`
`55`	`55`	`if (logDirectory == null)`
`56`	`56`	`{`
`57`		`-#pragma warning disable 618 // ProfilerLogPath is deprecated but still supported`
`58`		`- var nativeLogFile = config.WithKeys(ConfigurationKeys.ProfilerLogPath).AsString();`
`59`		`-#pragma warning restore 618`
	`57`	`+ // ProfilerLogPath is deprecated but still supported. For now, we bypass the WithKeys analyzer, but later we want to pull deprecations differently as part of centralized file`
	`58`	`+#pragma warning disable DD0008, 618`
	`59`	`+ var nativeLogFile = config.WithKeys(DeprecationConstants.ProfilerLogPath).AsString();`
	`60`	`+#pragma warning restore DD0008, 618`
`60`	`61`	`if (!string.IsNullOrEmpty(nativeLogFile))`
`61`	`62`	`{`
`62`	`63`	`logDirectory = Path.GetDirectoryName(nativeLogFile);`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,18 @@`
`1`		`-// <copyright file="DeprecationMessages.cs" company="Datadog">`
	`1`	`+// <copyright file="DeprecationConstants.cs" company="Datadog">`
`2`	`2`	`// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.`
`3`	`3`	`// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.`
`4`	`4`	`// </copyright>`
`5`	`5`
	`6`	`+using System;`
	`7`	`+`
`6`	`8`	`namespace Datadog.Trace.Configuration`
`7`	`9`	`{`
`8`		`- internal static class DeprecationMessages`
	`10`	`+ internal static class DeprecationConstants`
`9`	`11`	`{`
`10`	`12`	`public const string AppAnalytics = "App Analytics has been replaced by Tracing without Limits. For more information see https://docs.datadoghq.com/tracing/legacy_app_analytics/";`
`11`		`- public const string LogPath = "DD_TRACE_LOG_PATH is deprecated. Use DD_TRACE_LOG_DIRECTORY instead";`
	`13`	`+ public const string ProfilerLogPathObsoleteMessage = "DD_TRACE_LOG_PATH is deprecated. Use DD_TRACE_LOG_DIRECTORY instead";`
	`14`	`+`
	`15`	`+ [Obsolete(ProfilerLogPathObsoleteMessage)]`
	`16`	`+ public const string ProfilerLogPath = "DD_TRACE_LOG_PATH";`
`12`	`17`	`}`
`13`	`18`	`}`