NLog.Targets.Stackify - Added logAllProperties for structured logging

Author: snakefoot

Src/CoreConsoleApp/CoreConsoleApp.csproj

@@ -21,11 +21,11 @@
 
   <ItemGroup>
     <PackageReference Include="log4net" Version="2.0.7" />
-    <PackageReference Include="NLog" Version="5.0.0-beta05" />
+    <PackageReference Include="NLog" Version="4.5.0-rc02" />
     <PackageReference Include="Serilog" Version="2.4.0" />
-    <PackageReference Include="Microsoft.Extensions.Configuration" Version="1.2.0-preview1-22736" />
-    <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.2.0-preview1-22736" />
-    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="1.2.0-preview1-22736" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="1.1.1" />
   </ItemGroup>
 
 </Project>

Src/CoreWebApp/CoreWebApp.csproj

@@ -36,8 +36,8 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="1.0.2" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.0.2" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="1.0.2" />
-    <PackageReference Include="NLog" Version="5.0.0-beta05" />
-    <PackageReference Include="NLog.Extensions.Logging" Version="1.0.0-rtm-beta2" />
+    <PackageReference Include="NLog" Version="4.5.0-rc02" />
+    <PackageReference Include="NLog.Extensions.Logging" Version="1.0.0-rtm-rc4" />
     <PackageReference Include="Serilog" Version="2.4.0" />
     <PackageReference Include="Serilog.Extensions.Logging" Version="1.4.0" />
     <PackageReference Include="Serilog.Extensions.Logging.File" Version="1.0.0" />

Src/NLog.Targets.Stackify/NLog.Targets.Stackify.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <AssemblyTitle>NLog.Targets.Stackify</AssemblyTitle>
     <VersionPrefix>2.0.0</VersionPrefix>
-    <TargetFrameworks>netstandard1.3;net40;net45</TargetFrameworks>
+    <TargetFrameworks>netstandard1.5;net40;net45</TargetFrameworks>
     <AssemblyName>NLog.Targets.Stackify</AssemblyName>
     <PackageId>NLog.Targets.Stackify</PackageId>
     <PackageTags>stackify;errors;logs</PackageTags>
@@ -27,8 +27,8 @@
     <ProjectReference Include="..\StackifyLib\StackifyLib.csproj" />
   </ItemGroup>
 
-  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.3' ">
-    <PackageReference Include="NLog" Version="5.0.0-beta05" />
+  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.5' ">
+    <PackageReference Include="NLog" Version="4.5.0-rc02" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net40' ">

Src/NLog.Targets.Stackify/StackifyTarget.cs

@@ -7,9 +7,6 @@
 #if NET45 || NET40
 using System.Runtime.Remoting.Messaging;
 #endif
-using System.Security;
-using System.Text;
-using System.Threading.Tasks;
 using StackifyLib;
 using System.Diagnostics;
 using StackifyLib.Internal.Logs;
@@ -31,6 +28,8 @@ public class StackifyTarget : TargetWithLayout
         public string callContextKeys { get; set; }
         public bool? logMethodNames { get; set; }
         public bool? logAllParams { get; set; }
+        public bool? logAllProperties { get; set; }
+        public bool? logLastParameter { get; set; }
 
         private List<string> _GlobalContextKeys = new List<string>();
         private List<string> _MappedContextKeys = new List<string>();
@@ -99,32 +98,26 @@ protected override void Write(LogEventInfo logEvent)
             {
                 StackifyAPILogger.Log(ex.ToString());
             }
-
         }
 
 
         private Dictionary<string, object> GetDiagnosticContextProperties()
         {
-
-
             Dictionary<string, object> properties = new Dictionary<string, object>();
 
-
             string ndc = NLog.NestedDiagnosticsContext.TopMessage;
 
             if (!String.IsNullOrEmpty(ndc))
             {
                 properties["ndc"] = ndc;
             }
 
-
             if (!_HasContextKeys)
             {
                 return properties;
             }
 
             // GlobalDiagnosticsContext
-
             foreach (string gdcKey in _GlobalContextKeys)
             {
                 if (NLog.GlobalDiagnosticsContext.Contains(gdcKey))
@@ -137,8 +130,8 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                     }
                 }
             }
-            // MappedDiagnosticsContext
 
+            // MappedDiagnosticsContext
             foreach (string mdcKey in _MappedContextKeys)
             {
                 if (NLog.MappedDiagnosticsContext.Contains(mdcKey))
@@ -170,7 +163,6 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
 
         internal LogMsg Translate(LogEventInfo loggingEvent)
         {
-
             if (loggingEvent == null)
                 return null;
 
@@ -180,14 +172,11 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
 
             StackifyLib.Models.LogMsg msg = new LogMsg();
 
-
             if (loggingEvent.Level != null)
             {
                 msg.Level = loggingEvent.Level.Name;
             }
 
-         
-
             if (loggingEvent.HasStackTrace && loggingEvent.UserStackFrame != null)
             {
                 var frame = loggingEvent.UserStackFrame;
@@ -201,10 +190,8 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
                         msg.SrcLine = frame.GetFileLineNumber();
                     }
                 }
-
             }
 
-
             //if it wasn't set above for some reason we will do it this way as a fallback
             if (string.IsNullOrEmpty(msg.SrcMethod))
             {
@@ -240,48 +227,63 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
             msg.Msg = (formattedMessage ?? "").Trim();
 
             object debugObject = null;
-            Dictionary<string, object> args = new Dictionary<string, object>();
 
-            if ((loggingEvent.Parameters != null) && (loggingEvent.Parameters.Length > 0))
+            if ((logAllProperties ?? true) && loggingEvent.Properties.Count > 0)
             {
-
-                for (int i = 0; i < loggingEvent.Parameters.Length; i++)
+                Dictionary<string, object> args = new Dictionary<string, object>();
+                foreach (KeyValuePair<object, object> eventProperty in loggingEvent.Properties)
                 {
-                    var item = loggingEvent.Parameters[i];
-
-                    if (item == null)
+                    string propertyKey = eventProperty.Key.ToString();
+                    if (!string.IsNullOrEmpty(propertyKey))
                     {
-                        continue;
+                        args[propertyKey] = eventProperty.Value;
                     }
-                    else if (item is Exception)
+                }
+                debugObject = args;
+            }
+
+            if (loggingEvent.Parameters != null && loggingEvent.Parameters.Length > 0 && (debugObject == null || logAllParams == true))
+            {
+                Dictionary<string, object> args = (logAllParams ?? true) ? new Dictionary<string, object>() : null;
+                if (args != null || (logLastParameter ?? true))
+                {
+                    for (int i = 0; i < loggingEvent.Parameters.Length; i++)
                     {
-                        if (loggingEvent.Exception == null)
+                        var item = loggingEvent.Parameters[i];
+
+                        if (item == null)
                         {
-                            loggingEvent.Exception = (Exception)item;
+                            continue;
+                        }
+                        else if (item is Exception)
+                        {
+                            if (loggingEvent.Exception == null)
+                            {
+                                loggingEvent.Exception = (Exception)item;
+                            }
+                        }
+                        else if (item.ToString() == msg.Msg)
+                        {
+                            //ignore it.   
+                        }
+                        else if (args != null)
+                        {
+                            args["arg" + i] = loggingEvent.Parameters[i];
+                            debugObject = item;
+                        }
+                        else
+                        {
+                            debugObject = item;
                         }
                     }
-                    else if (item.ToString() == msg.Msg)
-                    {
-                        //ignore it.   
-                    }
-                    else if (logAllParams ?? true)
-                    {
-                        args["arg" + i] = loggingEvent.Parameters[i];
-                        debugObject = item;
-                    }
-                    else
+
+                    if (args != null && args.Count > 1)
                     {
-                        debugObject = item;
+                        debugObject = args;
                     }
                 }
-
-                if ((logAllParams ?? true) && args != null && args.Count > 1)
-                {
-                    debugObject = args;
-                }
             }
 
-
             StackifyError error = null;
 
             if (loggingEvent.Exception != null && loggingEvent.Exception is StackifyError)
@@ -300,13 +302,6 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
                 diags.Remove("transid");
             }
 
-
-     
-
-
-
-
-
             if (debugObject != null)
             {
                 msg.data = StackifyLib.Utils.HelperFunctions.SerializeDebugData(debugObject, true, diags);
@@ -315,7 +310,6 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
             {
                 msg.data = StackifyLib.Utils.HelperFunctions.SerializeDebugData(null, false, diags);
             }
-          
 
             if (msg.Msg != null && error != null)
             {
@@ -357,11 +351,8 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
                 msg.Msg += " #errorgoverned";
             }
 
-
             return msg;
         }
 
-
-    
     }
 }

Src/StackifyLib/Utils/HelperFunctions.cs

@@ -16,6 +16,7 @@ public class HelperFunctions
     {
         static List<string> _BadTypes = new List<string>() { "log4net.Util.SystemStringFormat", "System.Object[]" };
         static JsonSerializer serializer = new JsonSerializer { ReferenceLoopHandling = ReferenceLoopHandling.Ignore };
+        static JsonSerializerSettings serializerSettings = new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore, ReferenceLoopHandling = ReferenceLoopHandling.Ignore };
 
         /// <summary>
         /// Trying to serialize something that the user passed in. Sometimes this is used to serialize what we know is additional debug and sometimes it is the primary logged item. This is why the serializeSimpleTypes exists. For additional debug stuff we always serialize it. For the primary logged object we won't because it doesn't make any sense to put a string in the json as well as the main message. It's meant for objects.
@@ -126,21 +127,22 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
                             }
                             else
                             {
-
                                 if (!typeInfo.ContainsGenericParameters)
                                 {
                                     jObject.Add("objectType", type.FullName);
                                 }
-#if NET451 || NET45 || NET40
                                 else
                                 {
-
+#if NET451 || NET45 || NET40
                                     var genericArgs = typeInfo.GetGenericArguments();
-
-                                    if (genericArgs.Any())
+#else
+                                    var genericArgs = typeInfo.IsGenericTypeDefinition ?
+                                        type.GetTypeInfo().GenericTypeParameters :
+                                        type.GetTypeInfo().GenericTypeArguments;
+#endif
+                                    if (genericArgs != null && genericArgs.Length > 0)
                                     {
                                         var childtype = genericArgs.First();
-
 #if NET40
                                         var childtypeinfo = childtype;
 #else
@@ -161,7 +163,6 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
                                         jObject.Add("objectType", type.FullName);
                                     }
                                 }
-#endif
                             }
                         }
                         else if (token is JValue)
@@ -185,7 +186,7 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
             }
 
             string data = null;
-            if (properties != null && properties.Any())
+            if (properties != null && properties.Count > 0)
             {
 
                 if (jObject == null)
@@ -221,12 +222,7 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
 
             if (jObject != null)
             {
-                return JsonConvert.SerializeObject(jObject,
-                                                   new JsonSerializerSettings()
-                                                   {
-                                                       NullValueHandling = NullValueHandling.Ignore,
-                                                       ReferenceLoopHandling = ReferenceLoopHandling.Ignore
-                                                   });
+                return JsonConvert.SerializeObject(jObject, serializerSettings);
             }
 
             return null;