Added layout configs for breadcrumb & events to Options

Added ability to specify a separate layout for breadcrumbs, and added Layout and BreadcrumbLayout to SentryNLogOptions to allow them to be configured programmatically.

Author: Josh DeGraw

samples/Sentry.Samples.NLog/NLog.config

@@ -10,6 +10,8 @@
     <target name="logconsole" xsi:type="ColoredConsole" />
     <target xsi:type="Sentry" name="sentry"
             dsn="https://[email protected]/1188141"
+            layout="${message}"
+            breadcrumbLayout="${message}"
             minimumBreadcrumbLevel="Debug"
             minimumEventLevel="Error">
 

samples/Sentry.Samples.NLog/Program.cs

@@ -32,8 +32,8 @@ private static void Main(string[] args)
 
         private static void DemoLogger(ILogger logger)
         {
-            // Minimum Breadcrumb and Event log levels are set to levels higher than Verbose In this case,
-            // Verbose messages are ignored
+            // Minimum Breadcrumb and Event log levels are set to levels higher than Trace.
+            // In this case, Trace messages are ignored
             logger.Trace("Verbose message which is not sent.");
 
             // Minimum Breadcrumb level is set to Debug so the following message is stored in memory and sent
@@ -82,16 +82,20 @@ private static void UsingCodeConfiguration()
             config
                 .AddSentry(o =>
                 {
-                    o.MinimumBreadcrumbLevel = LogLevel.Debug; // Debug and higher are stored as breadcrumbs (default os Information)
+                    o.Layout = "${message}";
+                    o.BreadcrumbLayout = "${logger}: ${message}"; // Optionally specify a separate format for breadcrumbs
+
+                    o.MinimumBreadcrumbLevel = LogLevel.Debug; // Debug and higher are stored as breadcrumbs (default is Info)
                     o.MinimumEventLevel = LogLevel.Error; // Error and higher is sent as event (default is Error)
 
                     // If DSN is not set, the SDK will look for an environment variable called SENTRY_DSN. If
                     // nothing is found, SDK is disabled.
                     o.Dsn = new Dsn("https://[email protected]/1188141");
+
                     o.AttachStacktrace = true;
-                    o.SendDefaultPii = true; // send Personal Identifiable information like the username of the user logged in to the device
+                    o.SendDefaultPii = true; // Send Personal Identifiable information like the username of the user logged in to the device
 
-                    o.IncludeEventDataOnBreadcrumbs = true;
+                    o.IncludeEventDataOnBreadcrumbs = true; // Optionally include event properties with breadcrumbs
                     o.ShutdownTimeoutSeconds = 5;
 
                     o.AddTag("logger", "${logger}");  // Send the logger name as a tag
@@ -104,6 +108,7 @@ private static void UsingCodeConfiguration()
             config.AddTarget(new ColoredConsoleTarget("console"));
             config.AddRuleForAllLevels("console");
             config.AddRuleForAllLevels("debugger");
+
             LogManager.Configuration = config;
 
             var Log = LogManager.GetCurrentClassLogger();

src/Sentry.NLog/SentryNLogOptions.cs

@@ -3,6 +3,7 @@
 
 using NLog;
 using NLog.Config;
+using NLog.Layouts;
 using NLog.Targets;
 
 namespace Sentry.NLog
@@ -56,6 +57,18 @@ public int ShutdownTimeoutSeconds
         /// </summary>
         public bool IncludeEventDataOnBreadcrumbs { get; set; } = false;
 
+        /// <summary>
+        /// Custom layout for breadcrumbs.
+        /// </summary>
+        [NLogConfigurationIgnoreProperty] // Configure this directly on the target in XML config.
+        public Layout BreadcrumbLayout { get; set; }
+
+        /// <summary>
+        /// Configured layout for the NLog logger.
+        /// </summary>
+        [NLogConfigurationIgnoreProperty] // Configure this directly on the target in XML config.
+        public Layout Layout { get; set; }
+
         /// <summary>
         /// Any additional tags to apply to each logged message.
         /// </summary>

src/Sentry.NLog/SentryTarget.cs

@@ -5,6 +5,7 @@
 
 using NLog;
 using NLog.Config;
+using NLog.Layouts;
 using NLog.Targets;
 
 using Sentry.Extensibility;
@@ -76,6 +77,15 @@ public string Dsn
             set => Options.Dsn = new Dsn(value);
         }
 
+        /// <summary>
+        /// An optional layout specific to breadcrumbs. If not set, uses the same layout as the standard <see cref="TargetWithContext.Layout"/>.
+        /// </summary>
+        public Layout BreadcrumbLayout
+        {
+            get => Options.BreadcrumbLayout ?? Layout;
+            set => Options.BreadcrumbLayout = value;
+        }
+
         /// <summary>
         /// Minimum log level for events to trigger a send to Sentry. Defaults to <see cref="M:LogLevel.Error" />.
         /// </summary>
@@ -108,6 +118,10 @@ protected override void InitializeTarget()
 
             IncludeEventProperties = Options.SendEventPropertiesAsData;
 
+            // If a layout has been configured on the options, replace the default logger.
+            if (Options.Layout != null)
+                Layout = Options.Layout;
+
             // If the sdk is not there, set it on up.
             if (Options.InitializeSdk && _sdkDisposable == null)
             {
@@ -179,9 +193,11 @@ protected override void Write(LogEventInfo logEvent)
             // Whether or not it was sent as event, add breadcrumb so the next event includes it
             if (logEvent.Level >= Options.MinimumBreadcrumbLevel)
             {
-                var message = string.IsNullOrWhiteSpace(formatted)
+                var breadcrumbFormatted = BreadcrumbLayout.Render(logEvent);
+
+                var message = string.IsNullOrWhiteSpace(breadcrumbFormatted)
                     ? exception?.Message ?? string.Empty
-                    : formatted;
+                    : breadcrumbFormatted;
 
                 IDictionary<string, string> data = null;
 

test/Sentry.NLog.Tests/SentryTargetTests.cs

@@ -328,6 +328,22 @@ public void Log_SourceContextContainsSentry_NoScopeConfigured()
 
             _fixture.Hub.DidNotReceive().ConfigureScope(Arg.Any<Action<BaseScope>>());
         }
-    }
 
+        [Fact]
+        public void Log_WithCustomBreadcrumbLayout_RendersCorrectly()
+        {
+            var logger = _fixture.GetLogger(o =>
+            {
+                o.MinimumBreadcrumbLevel = LogLevel.Trace;
+                o.BreadcrumbLayout = "${logger}: ${message}";
+            });
+            const string message = "This is a breadcrumb";
+
+            logger.Debug(message);
+
+            var b = _fixture.Scope.Breadcrumbs.First();
+
+            Assert.Equal($"{logger.Name}: {message}", b.Message);
+        }
+    }
 }