Merge branch 'develop' into marcdemz/feature/WIN-183

Author: Michael Mantos

.gitignore

@@ -29,3 +29,4 @@ packages/
 
 **/bin/*
 **/obj/*
+BuildOutput/

Dlls/StackifyLib.ELMAH/StackifyLib.ELMAH.dll

@@ -9,17 +9,16 @@ Library for Stackify users to integrate Stackify in to their projects. Provides
 - [Stackify homepage](http://www.stackify.com)
 - [Stackify documentation site](https://docs.stackify.com/docs)
 - [NuGet packages](https://www.nuget.org/packages?q=Stackify)
-- [Configure log4net](https://docs.stackify.com/docs/errors-and-logs-log4net)
+- [Supported .NET logging frameworks](https://docs.stackify.com/docs/errors-and-logs-net-supported-frameworks)
 - [Best practices for logging with C#](https://stackify.com/csharp-logging-best-practices/)
 - [Why you should use tags in your logs](https://stackify.com/get-smarter-log-management-with-log-tags/)
 - [Ultimate log4net Tutorial for .Net Logging](https://stackify.com/log4net-guide-dotnet-logging/)
 
 
-
 **Read me sections:**
 - [Basics](#basics)
 - [Errors & Logs](#errors-and-logs)
-- [StackifyLib NLog](#nlog-2012---v31)
+- [StackifyLib NLog](#nlog)
 - [StackifyLib log4net 2.0+](#log4net-v20-v1211)
 - [StackifyLib log4net 1.2.10](#log4net-v1210)
 - [Direct API](#direct-api)
@@ -94,42 +93,52 @@ static void StackifyAPILogger_OnLogMessage(string data)
 If you log an object with the message, Stackify's log viewer makes it easy to search by these parameters. You can always search by the text in the log message itself, but searching by the logged properties provides a lot more power. If you always logged a "clientid" for example on every log message, you could search in Stackify for "json.clientid:1" and quickly see all logs and errors affecting that specific client. Another big difference and advantage to logging objects is you can do a range type search "json.clientid:[1 TO 10]" which would not be possible by a straight text search.
 
 
-### NLog 4.5
+### NLog
 
 **Install via NuGet package**
 ```
 PM> Install-Package NLog.Targets.Stackify
 ```
 
-Sample config:
+**Sample config:**
 ```xml
 <nlog>
         <extensions>
                 <add assembly="NLog.Targets.Stackify"/>
         </extensions>
         <targets>
-          <target name="stackify" type="StackifyTarget" logAllParams="false">
-            <contextproperty name="gdcKey1" layout="${gdc:item=gdcKey1}" />
-            <contextproperty name="mdlcKey2" layout="${mdlc:item=mdlcKey2}" />
-          </target>
+                <target name="stackify" type="StackifyTarget" logAllParams="false">
+                        <contextproperty name="gdcKey1" layout="${gdc:item=gdcKey1}" />
+                        <contextproperty name="mdlcKey2" layout="${mdlc:item=mdlcKey2}" />
+                </target>
         </targets>
         <rules>
                 <logger name="*" writeTo="stackify" minlevel="Debug" />
         </rules>
 </nlog>
 ```
 
-Logging custom objects is supported and will be searchable in Stackify's log viewer
+
+NLog 4.5 (and newer) supports message templates, where structured properties becomes searchable in Stackify's log viewer
+
+```csharp
+static NLog.Logger nlog = NLog.LogManager.GetCurrentClassLogger();
+nLog.Debug("{clientid} chose {color}", 1, "red");
+```
+
+Logging custom objects are also supported and will be searchable in Stackify's log viewer
 
 ```csharp
 static NLog.Logger nlog = NLog.LogManager.GetCurrentClassLogger();
 Dictionary<string, object> dictionary = new Dictionary<string, object>();
 dictionary["clientid"] = 1;
 dictionary["color"] = "red";
 nlog.Debug("Test message", dictionary);
+
+nlog.Debug("Test message", new { clientid = 2, color = "blue" });
 ```
 
-Options:
+**Options:**
 
 - IncludeEventProperties - Include LogEvent-Properties for structured logging.
 - IncludeMdlc - Include NLog MappedDiagnosticsLogicalContext MDLC-Properties for structured logging.
@@ -156,7 +165,7 @@ Note: Nuget packages are compiled against 2.0.0 (1.2.11) but any newer version w
 </dependentAssembly>
 ```
 
-Sample config:
+**Sample config:**
 ```xml
 <log4net>
         <root>
@@ -183,7 +192,7 @@ Sample config:
 </log4net>
 ```
 
-Options
+**Options:**
 
 - GlobalContext, ThreadContext, and LogicalThreadContext keys are fully supported by setting the parameters in the config as a comma delimited list of keys. See sample config above.
 - CallContextKeys is an additional feature unrelated to log4net that uses the local thread storage for more advanced tracking of context variables. LogicalThreadContext provides the same functionality but uses an internal property collection. We have seen instances where the serialization of that collection can cause exceptions. This was created as an alternative method to the built in function. It is used via CallContext.LogicalSetData(key, value). Research LogicalSetData online to learn more. It is supposed to work better across child Task objects and with async.
@@ -194,7 +203,7 @@ Options
 
 log4net does not internally have methods for logging a log message along with an object. Stackify's appenders work fine if you log an object directly or we have created some friendly extension methods to make it easy to log an object with your message at the same time.
 
-```cshapr
+```csharp
 using StackifyLib; //extension methods are here
 static log4net.ILog logger = log4net.LogManager.GetLogger(typeof(Program));
 Dictionary<string, object> dictionary = new Dictionary<string, object>();

Dlls/StackifyLib.log4net.v1_2_10/StackifyLib.log4net.dll

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Antlr" version="3.5.0.2" targetFramework="net462" />
-  <package id="bootstrap" version="3.3.7" targetFramework="net462" />
+  <package id="bootstrap" version="3.4.1" targetFramework="net462" />
   <package id="jQuery" version="3.3.1" targetFramework="net462" />
   <package id="log4net" version="2.0.8" targetFramework="net462" />
   <package id="Microsoft.AspNet.Mvc" version="5.2.4" targetFramework="net462" />

README.md

@@ -15,7 +15,7 @@
     <GenerateAssemblyCopyrightAttribute>false</GenerateAssemblyCopyrightAttribute>
     <GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
     <GenerateAssemblyFileVersionAttribute>false</GenerateAssemblyFileVersionAttribute>
-    <Version>2.1.6</Version>
+    <Version>2.1.7</Version>
     <PackageLicenseUrl>https://github.com/stackify/stackify-api-dotnet/blob/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://github.com/stackify/stackify-api-dotnet</PackageProjectUrl>
     <PackageIconUrl>https://stackify.com/wp-content/uploads/2017/02/stk.png</PackageIconUrl>

Src/FFWebApp462/packages.config

@@ -10,7 +10,7 @@
     <GenerateAssemblyConfigurationAttribute>false</GenerateAssemblyConfigurationAttribute>
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
-    <Version>2.1.5</Version>
+    <Version>2.1.6</Version>
     <Description>StackifyLib.AspNetCore</Description>
     <PackageLicenseUrl>https://github.com/stackify/stackify-api-dotnet/blob/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://github.com/stackify/stackify-api-dotnet</PackageProjectUrl>

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

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading;
 using StackifyLib.Internal.Logs;
 using StackifyLib.Models;
 using StackifyLib.Utils;
@@ -321,7 +322,7 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                     }
                 }
             }
-#if NETFULL
+
             foreach (string mdcKey in _LogicalThreadContextKeys)
             {
                 object mdcValue = Apache_log4net.LogicalThreadContext.Properties[mdcKey];
@@ -355,8 +356,8 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                     properties[mdcKey.ToLower()] = mdcValue;
                 }
             }
-            
 
+#if NETFULL
             foreach (string key in _CallContextKeys)
             {
                 object value = System.Runtime.Remoting.Messaging.CallContext.LogicalGetData(key);
@@ -366,7 +367,6 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                     properties[key.ToLower()] = value;
                 }
             }
-
 #endif
 
             return properties;

Src/StackifyLib.AspNetCore/StackifyLib.AspNetCore.csproj

@@ -13,7 +13,7 @@
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
     <GenerateAssemblyCopyrightAttribute>false</GenerateAssemblyCopyrightAttribute>
-    <Version>2.1.0</Version>
+    <Version>2.1.5</Version>
     <PackageLicenseUrl>https://github.com/stackify/stackify-api-dotnet/blob/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://github.com/stackify/stackify-api-dotnet</PackageProjectUrl>
     <RepositoryUrl>https://github.com/stackify/stackify-api-dotnet</RepositoryUrl>

Src/StackifyLib.log4net/StackifyAppender.cs

@@ -109,7 +109,13 @@ private void GetAzureInfo()
 
         public static string GetDeviceName()
         {
-            var deviceName = Environment.MachineName;
+            var deviceName = Environment.GetEnvironmentVariable("STACKIFY_DEVICE_NAME");
+            if (!String.IsNullOrEmpty(deviceName))
+            {
+                return deviceName.Substring(0, deviceName.Length > 60 ? 60 : deviceName.Length);
+            }
+
+            deviceName = Environment.MachineName;
 
             if (AzureConfig.InAzure && ((AzureConfig.IsWebsite) || (AzureConfig.InAzure && Environment.MachineName.StartsWith("RD"))))
             {
@@ -129,7 +135,7 @@ public static string GetDeviceName()
                 }
             }
 
-            return deviceName;
+            return deviceName.Substring(0, deviceName.Length > 60 ? 60 : deviceName.Length);
         }
 
         public static string GetEC2InstanceId()
@@ -194,7 +200,13 @@ public static string GetEC2InstanceId()
 #else
         public static string GetDeviceName()
         {
-            var deviceName = Environment.MachineName;
+            var deviceName = Environment.GetEnvironmentVariable("STACKIFY_DEVICE_NAME");
+            if (!String.IsNullOrEmpty(deviceName))
+            {
+                return deviceName.Substring(0, deviceName.Length > 60 ? 60 : deviceName.Length);
+            }
+
+            deviceName = Environment.MachineName;
 
             if (AzureConfig.InAzure && ((AzureConfig.IsWebsite) || (AzureConfig.InAzure && Environment.MachineName.StartsWith("RD"))))
             {
@@ -215,7 +227,7 @@ public static string GetDeviceName()
                 }
             }
 
-            return deviceName;
+            return deviceName.Substring(0, deviceName.Length > 60 ? 60 : deviceName.Length);
         }
 
         public static async Task<string> GetEC2InstanceId()
@@ -233,6 +245,11 @@ public static async Task<string> GetEC2InstanceId()
                 {
                     string id = await content.Content.ReadAsStringAsync();
                     r = string.IsNullOrWhiteSpace(id) ? null : id;
+
+                    if (r.Contains("html"))
+                    {
+                        r = Environment.MachineName;
+                    }
                 }
 
             }