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,86 @@
+namespace Sentry.NLog;
+
+public sealed partial class SentryTarget
+{
+    private static void CaptureStructuredLog(IHub hub, SentryOptions options, LogEventInfo logEvent)
+    {
+        var level = logEvent.Level.ToSentryLogLevel();
+        if (level.HasValue)
+        {
+            DateTimeOffset timestamp = new(logEvent.TimeStamp);
+            GetStructuredLoggingParametersAndAttributes(logEvent, out var parameters, out var attributes);
+
+            var log = SentryLog.Create(hub, timestamp, level.Value, logEvent.FormattedMessage, logEvent.Message, parameters);
+
+            log.SetDefaultAttributes(options, 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 = new List<KeyValuePair<string, object>>();
+
+        if (logEvent.HasProperties)
+        {
+            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)
+        {
+            // Unnamed holes (e.g. `{}`) have an empty name. Fall back to the positional index so that
+            // multiple unnamed holes don't collide on the same `sentry.message.parameter.` attribute key.
+            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();
+    }
+}

src/Sentry.NLog/SentryTarget.cs

@@ -4,7 +4,7 @@
 /// Sentry NLog Target.
 /// </summary>
 [Target("Sentry")]
-public sealed class SentryTarget : TargetWithContext
+public sealed partial class SentryTarget : TargetWithContext
 {
     // For testing:
     internal Func<IHub> HubAccessor { get; }
@@ -14,6 +14,12 @@
 
     internal static readonly SdkVersion NameAndVersion = typeof(SentryTarget).Assembly.GetNameAndVersion();
 
+    private static readonly SdkVersion Sdk = new()
+    {
+        Name = Constants.SdkName,
+        Version = NameAndVersion.Version,
+    };
+
     internal static readonly string AdditionalGroupingKeyProperty = "AdditionalGroupingKey";
 
     private static readonly string ProtocolPackageName = "nuget:" + NameAndVersion.Name;
@@ -129,6 +135,15 @@
         set => Options.MinimumBreadcrumbLevel = LogLevel.FromString(value);
     }
 
+    /// <summary>
+    /// Controls whether logs are generated and sent.
+    /// </summary>
+    public bool EnableLogs
+    {
+        get => Options.EnableLogs;
+        set => Options.EnableLogs = value;
+    }
+
     /// <summary>
     /// Whether the NLog integration should initialize the SDK.
     /// </summary>
@@ -331,6 +346,15 @@
         var shouldOnlyLogExceptions = exception == null && IgnoreEventsWithNoException;
         var shouldIncludeProperties = ContextProperties?.Count > 0 || ShouldIncludeProperties(logEvent);
 
+        // Read the options from the Hub, rather than the Target's NLog-Options, because 'EnableLogs' is declared in the base 'SentryOptions', rather than the derived 'SentryNLogOptions'.
+        // In cases where Sentry's NLog-Target is added without a DSN (i.e., without initializing the SDK) and the SDK is initialized differently (e.g., through ASP.NET Core),
+        // then the 'EnableLogs' option of this Target's NLog-Options is default, but the Hub's Sentry-Options have the actual user-defined value configured.
+        var sentryOptions = hub.GetSentryOptions();
+        if (sentryOptions?.EnableLogs is true)
+        {
+            CaptureStructuredLog(hub, sentryOptions, logEvent);
+        }
+
         if (logEvent.Level >= Options.MinimumEventLevel && !shouldOnlyLogExceptions)
         {
             var formatted = RenderLogEvent(Layout, logEvent);

src/Sentry/SentryLog.cs

@@ -12,7 +12,7 @@ namespace Sentry;
 /// Sentry .NET SDK Docs: <see href="https://docs.sentry.io/platforms/dotnet/logs/"/>.
 /// </remarks>
 [DebuggerDisplay(@"SentryLog \{ Level = {Level}, Message = '{Message}' \}")]
-public sealed class SentryLog
+public sealed partial class SentryLog
 {
     [SetsRequiredMembers]
     internal SentryLog(DateTimeOffset timestamp, SentryId traceId, SentryLogLevel level, string message)
@@ -27,6 +27,20 @@ internal SentryLog(DateTimeOffset timestamp, SentryId traceId, SentryLogLevel le
         Parameters = ImmutableArray<KeyValuePair<string, object>>.Empty;
     }
 
+    internal static SentryLog Create(IHub hub, DateTimeOffset timestamp, SentryLogLevel level, string message, string? template, ImmutableArray<KeyValuePair<string, object>> parameters)
+    {
+        hub.GetTraceIdAndSpanId(out var traceId, out var spanId);
+
+        SentryLog log = new(timestamp, traceId, level, message)
+        {
+            Template = template,
+            Parameters = parameters,
+            SpanId = spanId,
+        };
+
+        return log;
+    }
+
     /// <summary>
     /// The timestamp of the log.
     /// </summary>

test/Sentry.NLog.Tests/ApiApprovalTests.Run.DotNet10_0.verified.txt

@@ -59,6 +59,7 @@ namespace Sentry.NLog
         public NLog.Layouts.Layout? BreadcrumbCategory { get; set; }
         public NLog.Layouts.Layout? BreadcrumbLayout { get; set; }
         public NLog.Layouts.Layout? Dsn { get; set; }
+        public bool EnableLogs { get; set; }
         public NLog.Layouts.Layout? Environment { get; set; }
         public int FlushTimeoutSeconds { get; set; }
         public bool IgnoreEventsWithNoException { get; set; }

test/Sentry.NLog.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -59,6 +59,7 @@ namespace Sentry.NLog
         public NLog.Layouts.Layout? BreadcrumbCategory { get; set; }
         public NLog.Layouts.Layout? BreadcrumbLayout { get; set; }
         public NLog.Layouts.Layout? Dsn { get; set; }
+        public bool EnableLogs { get; set; }
         public NLog.Layouts.Layout? Environment { get; set; }
         public int FlushTimeoutSeconds { get; set; }
         public bool IgnoreEventsWithNoException { get; set; }

test/Sentry.NLog.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt

@@ -59,6 +59,7 @@ namespace Sentry.NLog
         public NLog.Layouts.Layout? BreadcrumbCategory { get; set; }
         public NLog.Layouts.Layout? BreadcrumbLayout { get; set; }
         public NLog.Layouts.Layout? Dsn { get; set; }
+        public bool EnableLogs { get; set; }
         public NLog.Layouts.Layout? Environment { get; set; }
         public int FlushTimeoutSeconds { get; set; }
         public bool IgnoreEventsWithNoException { get; set; }

test/Sentry.NLog.Tests/ApiApprovalTests.Run.Net4_8.verified.txt

@@ -59,6 +59,7 @@ namespace Sentry.NLog
         public NLog.Layouts.Layout? BreadcrumbCategory { get; set; }
         public NLog.Layouts.Layout? BreadcrumbLayout { get; set; }
         public NLog.Layouts.Layout? Dsn { get; set; }
+        public bool EnableLogs { get; set; }
         public NLog.Layouts.Layout? Environment { get; set; }
         public int FlushTimeoutSeconds { get; set; }
         public bool IgnoreEventsWithNoException { get; set; }

test/Sentry.NLog.Tests/Sentry.NLog.Tests.csproj

@@ -21,4 +21,10 @@
 
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Update="SentryTargetTests.Structured.cs">
+      <DependentUpon>SentryTargetTests.cs</DependentUpon>
+    </Compile>
+  </ItemGroup>
+
 </Project>