Add ILogger.ErrorSkipTelemetry() to exclude certain logs from telemetry

tracer/src/Datadog.Trace.Tools.Analyzers/LogAnalyzer/LogAnalyzer.cs

@@ -66,7 +66,7 @@ private static void AnalyzeSymbol(SyntaxNodeAnalysisContext context)
         }
 
         // is it an IDatadogLogger logging method?
-        if (method.Name is not "Debug" and not "Information" and not "Warning" and not "Error")
+        if (method.Name is not "Debug" and not "Information" and not "Warning" and not "Error" and not "ErrorSkipTelemetry")
         {
             return;
         }

tracer/src/Datadog.Trace/Agent/Api.cs

@@ -163,7 +163,7 @@ private async Task<bool> SendWithRetry<T>(Uri endpoint, SendCallback<T> callback
                     if (isFinalTry || success == SendResult.Failed_DontRetry)
                     {
                         // stop retrying
-                        _log.Error(exception, FailedToSendMessageTemplate, _apiRequestFactory.Info(endpoint));
+                        _log.ErrorSkipTelemetry(exception, FailedToSendMessageTemplate, _apiRequestFactory.Info(endpoint));
                         return false;
                     }
                     else if (_log.IsEnabled(LogEventLevel.Debug))

tracer/src/Datadog.Trace/Ci/CiEnvironment/CIEnvironmentValuesGenerics.cs

@@ -181,11 +181,11 @@ protected override void Setup(IGitInfo gitInfo)
                     {
                         if (string.IsNullOrEmpty(defaultValue))
                         {
-                            Log.Error("DD_GIT_REPOSITORY_URL is set with an empty value, and the Git repository could not be automatically extracted");
+                            Log.ErrorSkipTelemetry("DD_GIT_REPOSITORY_URL is set with an empty value, and the Git repository could not be automatically extracted");
                         }
                         else
                         {
-                            Log.Error("DD_GIT_REPOSITORY_URL is set with an empty value, defaulting to '{Default}'", defaultValue);
+                            Log.ErrorSkipTelemetry("DD_GIT_REPOSITORY_URL is set with an empty value, defaulting to '{Default}'", defaultValue);
                         }
 
                         return false;
@@ -195,11 +195,11 @@ protected override void Setup(IGitInfo gitInfo)
                     {
                         if (string.IsNullOrEmpty(defaultValue))
                         {
-                            Log.Error("DD_GIT_REPOSITORY_URL is set with an invalid value ('{Value}'), and the Git repository could not be automatically extracted", value);
+                            Log.ErrorSkipTelemetry("DD_GIT_REPOSITORY_URL is set with an invalid value ('{Value}'), and the Git repository could not be automatically extracted", value);
                         }
                         else
                         {
-                            Log.Error("DD_GIT_REPOSITORY_URL is set with an invalid value ('{Value}'), defaulting to '{Default}'", value, defaultValue);
+                            Log.ErrorSkipTelemetry("DD_GIT_REPOSITORY_URL is set with an invalid value ('{Value}'), defaulting to '{Default}'", value, defaultValue);
                         }
 
                         return false;

tracer/src/Datadog.Trace/Logging/Internal/DatadogLoggingFactory.cs

@@ -19,6 +19,8 @@
 using Datadog.Trace.Util;
 using Datadog.Trace.Vendors.Serilog;
 using Datadog.Trace.Vendors.Serilog.Core;
+using Datadog.Trace.Vendors.Serilog.Events;
+using Datadog.Trace.Vendors.Serilog.Filters;
 
 namespace Datadog.Trace.Logging;
 
@@ -96,7 +98,7 @@ static bool Contains(string?[]? array, string toMatch)
                .WriteTo.Logger(
                     lc => lc
                          .MinimumLevel.Error()
-                         .Filter.ByExcluding(log => IsExcludedMessage(log.MessageTemplate.Text))
+                         .Filter.ByExcluding(Matching.WithProperty(DatadogSerilogLogger.SkipTelemetryProperty))
                          .WriteTo.Sink(new RedactedErrorLogSink(telemetry.Collector)));
         }
 
@@ -105,6 +107,7 @@ static bool Contains(string?[]? array, string toMatch)
             var managedLogPath = Path.Combine(fileConfig.LogDirectory, $"dotnet-tracer-managed-{domainMetadata.ProcessName}-{domainMetadata.ProcessId.ToString(CultureInfo.InvariantCulture)}.log");
 
             loggerConfiguration
+               .Enrich.With(new RemovePropertyEnricher(LogEventLevel.Error, DatadogSerilogLogger.SkipTelemetryProperty))
                .WriteTo.File(
                     managedLogPath,
                     outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj} {Exception} {Properties}{NewLine}",
@@ -147,13 +150,6 @@ static bool Contains(string?[]? array, string toMatch)
         return new DatadogSerilogLogger(internalLogger, rateLimiter, config.File?.LogDirectory);
     }
 
-    private static bool IsExcludedMessage(string messageTemplateText)
-        => ReferenceEquals(messageTemplateText, Api.FailedToSendMessageTemplate)
-#if NETFRAMEWORK
-        || ReferenceEquals(messageTemplateText, PerformanceCountersListener.InsufficientPermissionsMessageTemplate)
-#endif
-    ;
-
     // Internal for testing
     internal static string GetLogDirectory(IConfigurationTelemetry telemetry)
         => GetLogDirectory(GlobalConfigurationSource.CreateDefaultConfigurationSource(), telemetry);
@@ -276,4 +272,18 @@ private static string GetDefaultLogDirectory(IConfigurationSource source, IConfi
         // If telemetry is disabled
         return null;
     }
+
+    private class RemovePropertyEnricher(LogEventLevel minLevel, string propertyName) : ILogEventEnricher
+    {
+        private readonly LogEventLevel _minLevel = minLevel;
+        private readonly string _propertyName = propertyName;
+
+        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (logEvent.Level >= _minLevel)
+            {
+                logEvent.RemovePropertyIfPresent(_propertyName);
+            }
+        }
+    }
 }