ref: readme and format nits

Author: bruno-garcia

.assets/nlog-sentry.png

@@ -8,6 +8,10 @@
 
   <targets>
     <target name="logconsole" xsi:type="ColoredConsole" />
+
+    <!-- REPLACE THE FOLLOWING DSN WITH YOUR OWN:
+    See Program.cs for the DSN used in the code-only example-->
+
     <target xsi:type="Sentry" name="sentry"
             dsn="https://[email protected]/1188141"
             layout="${message}"
@@ -26,7 +30,6 @@
         <includeEventDataOnBreadcrumbs>true</includeEventDataOnBreadcrumbs>
       </options>
 
-
       <!--Add any desired additional tags that will be sent with every message -->
       <tag name="logger" layout="${logger}" />
     </target>

samples/Sentry.Samples.NLog/NLog.config

@@ -1,15 +1,19 @@
 using System;
-
 using NLog;
 using NLog.Config;
 using NLog.Targets;
 
 // ReSharper disable ConvertToConstant.Local
-
 namespace Sentry.Samples.NLog
 {
     public static class Program
     {
+        // Modify the configuration file NLog.config to affect 'UsingNLogConfigFile'
+
+        // DSN used by the example: 'UsingCodeConfiguration'.
+        // #### ADD YOUR DSN HERE:
+        private static string DsnSample = "https://[email protected]/1188141";
+
         private static void Main(string[] args)
         {
             try
@@ -90,7 +94,7 @@ private static void UsingCodeConfiguration()
 
                     // 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.Dsn = new Dsn(DsnSample);
 
                     o.AttachStacktrace = true;
                     o.SendDefaultPii = true; // Send Personal Identifiable information like the username of the user logged in to the device

samples/Sentry.Samples.NLog/Program.cs

@@ -0,0 +1,37 @@
+# Sample integration of NLog with Sentry
+
+This is a simple console application that demonstrates how you can add Sentry to your application using NLog.
+
+This project attempts to sample the integration by using code only and also via the configuration file.
+In both cases **you need to add your own DSN** so you can see the events sent in your Sentry project.
+
+You can get your [Sentry DSN at sentry.io](https://sentry.io).
+Make sure to add it to both `NLog.config` and `Program.cs` in this directory.
+
+## Running this sample
+
+Now you're ready to run the code.
+You can run this sample with Visual Studio, or via the command line.
+
+With the .NET Core SDK:
+
+```sh
+λ dotnet run
+15:34 $ dotnet run
+2019-05-13 15:34:30.7319|TRACE|Sentry.Samples.NLog.Program|Verbose message which is not sent.
+2019-05-13 15:34:30.7716|DEBUG|Sentry.Samples.NLog.Program|Debug message stored as breadcrumb.
+2019-05-13 15:34:30.7782|ERROR|Sentry.Samples.NLog.Program|Some event that includes the previous breadcrumbs. mood = "happy that my error is reported"
+2019-05-13 15:34:30.8547|INFO|Sentry.Samples.NLog.Program|Dividing 10 by 0
+2019-05-13 15:34:30.8567|WARN|Sentry.Samples.NLog.Program|a is 0
+2019-05-13 15:34:30.8586|FATAL|Sentry.Samples.NLog.Program|Error: with exception. { title = compound data object, wowFactor = 11, errorReported = True }
+2019-05-13 15:34:32.1986|TRACE|Sentry.Samples.NLog.Program|Verbose message which is not sent.
+2019-05-13 15:34:32.1997|DEBUG|Sentry.Samples.NLog.Program|Debug message stored as breadcrumb.
+2019-05-13 15:34:32.1997|ERROR|Sentry.Samples.NLog.Program|Some event that includes the previous breadcrumbs. mood = "happy that my error is reported"
+2019-05-13 15:34:32.2005|INFO|Sentry.Samples.NLog.Program|Dividing 10 by 0
+2019-05-13 15:34:32.2005|WARN|Sentry.Samples.NLog.Program|a is 0
+2019-05-13 15:34:32.2010|FATAL|Sentry.Samples.NLog.Program|Error: with exception. { title = compound data object, wowFactor = 11, errorReported = True }
+```
+
+![Sample event in Sentry](.assets/nlog-sentry.png)
+
+**Please refer to the main SDK [documentation for more details](https://getsentry.github.io/sentry-dotnet/).**

samples/Sentry.Samples.NLog/README.md

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net462</TargetFramework>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
@@ -17,5 +17,4 @@
     </None>
   </ItemGroup>
 
-
 </Project>

samples/Sentry.Samples.NLog/Sentry.Samples.NLog.csproj

@@ -34,7 +34,7 @@ public static LoggingConfiguration AddSentry(this LoggingConfiguration configura
         /// Adds a target for Sentry to the NLog configuration.
         /// </summary>
         /// <param name="configuration">The NLog configuration.</param>
-        /// <param name="dsn">          
+        /// <param name="dsn">
         /// The sentry DSN. If DSN is not set, the SDK will look for an environment variable called SENTRY_DSN.
         /// If nothing is found, SDK is disabled.
         /// </param>
@@ -64,7 +64,6 @@ public static LoggingConfiguration AddSentry(this LoggingConfiguration configura
 
             optionsConfig?.Invoke(options);
 
-
             Target.Register<SentryTarget>("Sentry");
 
             var target = new SentryTarget(options)
@@ -95,6 +94,5 @@ public static void AddTag(this SentryNLogOptions options, string name, Layout la
         {
             options.Tags.Add(new TargetPropertyWithContext(name, layout));
         }
-
     }
 }

src/Sentry.NLog/ConfigurationExtensions.cs

@@ -3,7 +3,6 @@
 
 // ReSharper disable LoopCanBePartlyConvertedToQuery
 // ReSharper disable LoopCanBeConvertedToQuery
-
 namespace Sentry.NLog
 {
     internal static class HelperExtensions
@@ -24,7 +23,9 @@ internal static IEnumerable<KeyValuePair<TKey, TValue>> ToKeyValuePairs<TSource,
             }
         }
 
-        internal static IEnumerable<KeyValuePair<TKey, TNewValue>> MapValues<TKey, TValue, TNewValue>(this IEnumerable<KeyValuePair<TKey, TValue>> source, Func<TValue,TNewValue> valueSelector)
+        internal static IEnumerable<KeyValuePair<TKey, TNewValue>> MapValues<TKey, TValue, TNewValue>(
+            this IEnumerable<KeyValuePair<TKey, TValue>> source,
+            Func<TValue,TNewValue> valueSelector)
         {
             if (source is null)
             {

src/Sentry.NLog/HelperExtensions.cs

@@ -75,6 +75,13 @@ public int ShutdownTimeoutSeconds
         [NLogConfigurationIgnoreProperty] // Configure this directly on the target in XML config.
         public IList<TargetPropertyWithContext> Tags { get; } = new List<TargetPropertyWithContext>();
 
+        /// <summary>
+        /// Whether the NLog integration should initialize the SDK.
+        /// </summary>
+        /// <remarks>
+        /// By default, if a DSN is provided to the NLog integration it will initialize the SDK.
+        /// This might be not ideal when using multiple integrations in case you want another one doing the Init.
+        /// </remarks>
         [Advanced]
         public bool InitializeSdk { get; set; } = true;
     }

src/Sentry.NLog/SentryNLogOptions.cs

@@ -244,6 +244,5 @@ private IEnumerable<KeyValuePair<string, object>> GetLoggingEventProperties(LogE
 
             return logEvent.Properties.ToKeyValuePairs(x => x.Key.ToString(), x => x.Value);
         }
-
     }
 }

src/Sentry.NLog/SentryTarget.cs

@@ -2,12 +2,10 @@
 
   <PropertyGroup>
     <TargetFrameworks>netcoreapp2.1;net461</TargetFrameworks>
-  </PropertyGroup>  
+  </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\src\Sentry.NLog\Sentry.NLog.csproj" />
     <ProjectReference Include="..\Sentry.Testing\Sentry.Testing.csproj" />
   </ItemGroup>
 
-  
-
 </Project>