NLog.Targets.Stackify - Added logAllProperties for structured logging

Author: snakefoot

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,7 @@ public class StackifyTarget : TargetWithLayout
         public string callContextKeys { get; set; }
         public bool? logMethodNames { get; set; }
         public bool? logAllParams { get; set; }
+        public bool? logAllProperties { get; set; }
 
         private List<string> _GlobalContextKeys = new List<string>();
         private List<string> _MappedContextKeys = new List<string>();
@@ -99,32 +97,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 +129,8 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                     }
                 }
             }
-            // MappedDiagnosticsContext
 
+            // MappedDiagnosticsContext
             foreach (string mdcKey in _MappedContextKeys)
             {
                 if (NLog.MappedDiagnosticsContext.Contains(mdcKey))
@@ -150,6 +142,20 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                         properties.Add(mdcKey.ToLower(), mdcValue);
                     }
                 }
+            }
+
+            // MappedDiagnosticsLogicalContext (Async CallContext)
+            foreach (string mdlcKey in _MappedContextKeys)
+            {
+                if (NLog.MappedDiagnosticsLogicalContext.Contains(mdlcKey))
+                {
+                    string mdcValue = NLog.MappedDiagnosticsLogicalContext.Get(mdlcKey);
+
+                    if (mdcValue != null)
+                    {
+                        properties.Add(mdlcKey.ToLower(), mdcValue);
+                    }
+                }
             }
 
 #if NET45 || NET40
@@ -170,7 +176,6 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
 
         internal LogMsg Translate(LogEventInfo loggingEvent)
         {
-
             if (loggingEvent == null)
                 return null;
 
@@ -180,14 +185,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 +203,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))
             {
@@ -294,19 +294,29 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
             }
 
             var diags = GetDiagnosticContextProperties();
+
+            if (logAllProperties ?? true)
+            {
+                if (loggingEvent.Properties.Count > 0)
+                {
+                    foreach (KeyValuePair<object, object> eventProperty in loggingEvent.Properties)
+                    {
+                        string propertyKey = eventProperty.Key.ToString();
+                        if (!string.IsNullOrEmpty(propertyKey))
+                        {
+                            string propertyValue = eventProperty.Value != null ? Convert.ToString(eventProperty.Value, loggingEvent.FormatProvider ?? CultureInfo.CurrentCulture) : null;
+                            diags[propertyKey.ToLower()] = propertyValue;
+                        }
+                    }
+                }
+            }
+
             if (diags != null && diags.ContainsKey("transid"))
             {
                 msg.TransID = diags["transid"].ToString();
                 diags.Remove("transid");
             }
 
-
-     
-
-
-
-
-
             if (debugObject != null)
             {
                 msg.data = StackifyLib.Utils.HelperFunctions.SerializeDebugData(debugObject, true, diags);
@@ -315,7 +325,6 @@ internal LogMsg Translate(LogEventInfo loggingEvent)
             {
                 msg.data = StackifyLib.Utils.HelperFunctions.SerializeDebugData(null, false, diags);
             }
-          
 
             if (msg.Msg != null && error != null)
             {
@@ -357,11 +366,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.
@@ -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;