feat(logs): add NLog integration

samples/Sentry.Samples.NLog/NLog.config

@@ -22,7 +22,8 @@
             ignoreEventsWithNoException="False"
             includeEventDataOnBreadcrumbs="False"
             includeEventPropertiesAsTags="True"
-            minimumEventLevel="Error">
+            minimumEventLevel="Error"
+            enableLogs="True">
 
       <!-- Advanced options can be configured here-->
       <options

samples/Sentry.Samples.NLog/Program.cs

@@ -115,6 +115,7 @@ private static void UsingCodeConfiguration()
                 options.MinimumEventLevel = LogLevel.Error; // Error and higher is sent as event (default is Error)
 
                 options.AttachStacktrace = true;
+                options.EnableLogs = true; // send structured logs to Sentry
                 options.SendDefaultPii = true; // Send Personal Identifiable information like the username of the user logged in to the device
 
                 options.IncludeEventDataOnBreadcrumbs = true; // Optionally include event properties with breadcrumbs

src/Sentry.NLog/LogLevelExtensions.cs

@@ -29,4 +29,19 @@ public static BreadcrumbLevel ToBreadcrumbLevel(this LogLevel level)
             _ => BreadcrumbLevel.Info
         };
     }
+
+    public static SentryLogLevel? ToSentryLogLevel(this LogLevel level)
+    {
+        return level.Name switch
+        {
+            nameof(LogLevel.Trace) => SentryLogLevel.Trace,
+            nameof(LogLevel.Debug) => SentryLogLevel.Debug,
+            nameof(LogLevel.Info) => SentryLogLevel.Info,
+            nameof(LogLevel.Warn) => SentryLogLevel.Warning,
+            nameof(LogLevel.Error) => SentryLogLevel.Error,
+            nameof(LogLevel.Fatal) => SentryLogLevel.Fatal,
+            nameof(LogLevel.Off) => null,
+            _ => null,
+        };
+    }
 }

src/Sentry.NLog/Sentry.NLog.csproj

@@ -35,4 +35,10 @@
     <InternalsVisibleTo Include="Sentry.NLog.Tests" PublicKey="$(SentryPublicKey)" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Update="SentryTarget.Structured.cs">
+      <DependentUpon>SentryTarget.cs</DependentUpon>
+    </Compile>
+  </ItemGroup>
+
 </Project>

src/Sentry.NLog/SentryTarget.Structured.cs

@@ -0,0 +1,91 @@
+namespace Sentry.NLog;
+
+public sealed partial class SentryTarget
+{
+    private static void CaptureStructuredLog(IHub hub, SentryOptions options, LogEventInfo logEvent)
+    {
+        if (logEvent.Level.ToSentryLogLevel() is not { } level)
+        {
+            return;
+        }
+
+        DateTimeOffset timestamp = new(logEvent.TimeStamp);
+        GetStructuredLoggingParametersAndAttributes(logEvent, out var parameters, out var attributes);
+
+        var log = SentryLog.Create(hub, timestamp, level, logEvent.FormattedMessage, logEvent.Message, parameters);
+
+        var scope = hub.GetScope();
+        log.SetDefaultAttributes(options, scope, Sdk);
+        log.SetOrigin("auto.log.nlog");
+
+        if (logEvent.LoggerName is not null)
+        {
+            log.Attributes.SetAttribute("category.name", logEvent.LoggerName);
+        }
+
+        foreach (var attribute in attributes)
+        {
+            log.SetAttribute(attribute.Key, attribute.Value);
+        }
+
+        hub.Logger.CaptureLog(log);
+    }
+
+    private static void GetStructuredLoggingParametersAndAttributes(LogEventInfo logEvent, out ImmutableArray<KeyValuePair<string, object>> parameters, out List<KeyValuePair<string, object>> attributes)
+    {
+        parameters = GetParameters(logEvent, out var parameterNames);
+        attributes = [];
+
+        if (!logEvent.HasProperties)
+        {
+            return;
+        }
+
+        foreach (var property in logEvent.Properties)
+        {
+            if (property.Key is string key && !string.IsNullOrWhiteSpace(key) &&
+                property.Value is { } value &&
+                !parameterNames.Contains(key))
+            {
+                attributes.Add(new KeyValuePair<string, object>($"property.{key}", value));
+            }
+        }
+    }
+
+    private static ImmutableArray<KeyValuePair<string, object>> GetParameters(LogEventInfo logEvent, out HashSet<string> parameterNames)
+    {
+        var parameters = logEvent.MessageTemplateParameters;
+
+        if (parameters.Count == 0)
+        {
+            parameterNames = new HashSet<string>();
+            return ImmutableArray<KeyValuePair<string, object>>.Empty;
+        }
+
+        // The HashSet<T> capacity constructor is unavailable on netstandard2.0 and net462 (added in net472).
+#if NETSTANDARD2_0 || NET462
+        parameterNames = new HashSet<string>();
+#else
+        parameterNames = new HashSet<string>(parameters.Count);
+#endif
+
+        var @params = ImmutableArray.CreateBuilder<KeyValuePair<string, object>>(parameters.Count);
+
+        var index = 0;
+        foreach (var parameter in parameters)
+        {
+            // NLog allows passing unnamed holes (e.g. `{}`) - parameters with no names.
+            // To prevent a collision on the attribute key when multiple unnamed holes are present, we fall back to the
+            // positional index of the parameter in these cases (matching the behaviour of MEL).
+            var name = string.IsNullOrEmpty(parameter.Name)
+                ? index.ToString(CultureInfo.InvariantCulture)
+                : parameter.Name;
+
+            parameterNames.Add(name);
+            @params.Add(new KeyValuePair<string, object>(name, parameter.Value));
+            index++;
+        }
+
+        return @params.DrainToImmutable();
+    }
+}