Merge pull request #53 from datalust/dev

nblumhardt · web-flow · commit a7d1e55c2e93 · 2021-03-08T09:35:40.000+10:00
2.0.0 Release
diff --git a/.gitignore b/.gitignore
@@ -250,3 +250,5 @@ paket-files/
 # JetBrains Rider
 .idea/
 *.sln.iml
+
+.vscode/
diff --git a/Build.ps1 b/Build.ps1
@@ -13,7 +13,7 @@ if(Test-Path .\artifacts) {
 
 $branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$env:APPVEYOR_REPO_BRANCH -ne $NULL];
 $revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:APPVEYOR_BUILD_NUMBER, 10); $false = "local" }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
-$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "master" -and $revision -ne "local"]
+$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "main" -and $revision -ne "local"]
 
 echo "build: Version suffix is $suffix"
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -15,11 +15,11 @@ deploy:
     secure: Hl9pr1a2/2Y9u9XwPO8FUCpGbO8taYFhYVnDRJbvl3rs5fcFaqd91+QbrcrtES/x
   skip_symbols: true
   on:
-    branch: /^(master|dev)$/
+    branch: /^(main|dev)$/
 - provider: GitHub
   auth_token:
     secure: hX+cZmW+9BCXy7vyH8myWsYdtQHyzzil9K5yvjJv7dK9XmyrGYYDj/DPzMqsXSjo
   artifact: /NLog.Targets.Seq.*\.nupkg/
   tag: v$(appveyor_build_version)
   on:
-    branch: master
+    branch: main
diff --git a/global.json b/global.json
@@ -0,0 +1,5 @@
+{
+  "sdk": {
+    "version": "5.0.102"
+  }
+}
diff --git a/nlog-targets-seq.sln b/nlog-targets-seq.sln
@@ -11,6 +11,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "global", "global", "{66B005
 		Build.ps1 = Build.ps1
 		LICENSE = LICENSE
 		README.md = README.md
+		.gitattributes = .gitattributes
+		.gitignore = .gitignore
+		global.json = global.json
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{2ED926D3-7AC8-4BFD-A16B-74D942602968}"
diff --git a/nlog-targets-seq.sln.DotSettings b/nlog-targets-seq.sln.DotSettings
@@ -1,2 +1,6 @@
 ﻿<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
-	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=TypeParameters/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="T" Suffix="" Style="AaBb"&gt;&lt;ExtraRule Prefix="" Suffix="" Style="AA_BB" /&gt;&lt;/Policy&gt;</s:String></wpf:ResourceDictionary>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=TypeParameters/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="T" Suffix="" Style="AaBb"&gt;&lt;ExtraRule Prefix="" Suffix="" Style="AA_BB" /&gt;&lt;/Policy&gt;</s:String>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=preallocated/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Serilog/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Stringified/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Templated/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/sample/Example/Program.cs b/sample/Example/Program.cs
@@ -3,7 +3,7 @@
 
 namespace Example
 {
-    class Program
+    static class Program
     {
         static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
@@ -14,7 +14,7 @@ public static void Main()
             // Structured logging: two named properties are captured using the message template:
             Logger.Info("Hello, {Server}, from {Library}", server, library);
 
-            // Text logging: the two properties are captured using positional arguments:
+            // Text logging: the two properties are formatted into the message using positional arguments:
             Logger.Info("Goodbye, {0}, from {1}", server, library);
 
             // Complex data can be captured and serialized into the event using the `@` directive:
diff --git a/src/NLog.Targets.Seq/LevelMapping.cs b/src/NLog.Targets.Seq/LevelMapping.cs
@@ -0,0 +1,43 @@
+﻿// Seq Target for NLog - Copyright 2014-2020 Datalust and contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+
+namespace NLog.Targets.Seq
+{
+    static class LevelMapping
+    {
+        public static LogLevel ToNLogLevel(SeqLogLevel? level)
+        {
+            switch (level)
+            {
+                case null:
+                case SeqLogLevel.Verbose:
+                    return LogLevel.Trace;
+                case SeqLogLevel.Debug:
+                    return LogLevel.Debug;
+                case SeqLogLevel.Information:
+                    return LogLevel.Info;
+                case SeqLogLevel.Warning:
+                    return LogLevel.Warn;
+                case SeqLogLevel.Error:
+                    return LogLevel.Error;
+                case SeqLogLevel.Fatal:
+                    return LogLevel.Fatal;
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(level), level, null);
+            }
+        }
+    }
+}
diff --git a/src/NLog.Targets.Seq/NLog.Targets.Seq.csproj b/src/NLog.Targets.Seq/NLog.Targets.Seq.csproj
@@ -1,30 +1,41 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <Description>An NLog target that writes structured log events to Seq</Description>
     <Authors>Datalust;Contributors</Authors>
-    <VersionPrefix>1.2.0</VersionPrefix>
-    <TargetFrameworks>net45;netstandard2.0</TargetFrameworks>
+    <VersionPrefix>2.0.0</VersionPrefix>
+    <TargetFrameworks>net4.5;net4.6.2;netstandard2.0;net5.0</TargetFrameworks>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <AssemblyOriginatorKeyFile>../../asset/nlog-targets-seq.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
     <PackageTags>seq;nlog</PackageTags>
-    <PackageIconUrl>https://raw.githubusercontent.com/datalust/nlog-targets-seq/dev/asset/nlog-targets-seq.png</PackageIconUrl>
+    <PackageIcon>nlog-targets-seq.png</PackageIcon>
     <PackageProjectUrl>https://github.com/datalust/nlog-targets-seq</PackageProjectUrl>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <RepositoryUrl>https://github.com/datalust/nlog-targets-seq.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+  </PropertyGroup>
+
   <ItemGroup>
-    <None Include="..\..\LICENSE" Link="LICENSE" Pack="true" PackagePath="" />
+    <None Include="../../LICENSE" Link="LICENSE" Pack="true" PackagePath="" />
+    <None Include="../../asset/nlog-targets-seq.png" Pack="true" PackagePath="/" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="NLog" Version="4.5.11" />
+    <PackageReference Include="NLog" Version="4.7.8" />
+  </ItemGroup>
+  
+  <ItemGroup Condition=" '$(TargetFramework)' != 'netstandard2.0' and '$(TargetFramework)' != 'net5.0' ">
+    <PackageReference Include="System.ValueTuple" Version="4.5.0" />
+    <PackageReference Include="System.Net.Http" Version="4.3.4" />
   </ItemGroup>
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
diff --git a/src/NLog.Targets.Seq/RenderingsLayout.cs b/src/NLog.Targets.Seq/RenderingsLayout.cs
@@ -28,60 +28,56 @@ class RenderingsLayout : Layout
 
         protected override void RenderFormattedMessage(LogEventInfo logEvent, StringBuilder target)
         {
-            StringBuilder result = RenderLogEvent(logEvent, target);
+            var result = RenderLogEvent(logEvent, target);
             if (result == null)
                 target.Append("null");
         }
 
         protected override string GetFormattedMessage(LogEventInfo logEvent)
         {
-            StringBuilder result = RenderLogEvent(logEvent);
+            var result = RenderLogEvent(logEvent);
             return result?.ToString() ?? "null";
         }
 
-        private StringBuilder RenderLogEvent(LogEventInfo logEvent, StringBuilder preallocated = null)
+        StringBuilder RenderLogEvent(LogEventInfo logEvent, StringBuilder preallocated = null)
         {
-            int orgLength = preallocated?.Length ?? 0;
+            var orgLength = preallocated?.Length ?? 0;
             StringBuilder output = null;
 
             try
             {
                 var nextDelimiter = "";
                 var mtp = logEvent.MessageTemplateParameters;
 
-                for (var i = 0; i < mtp.Count; ++i)
+                foreach (var parameter in mtp)
                 {
-                    var parameter = mtp[i];
+                    if (parameter.Format == null) continue;
+                    
+                    if (output == null)
+                    {
+                        output = preallocated ?? new StringBuilder();
+                        output.Append("[");
+                    }
 
-                    if (parameter.Format != null)
+                    var space = new StringWriter();
+
+                    if (logEvent.Properties != null &&
+                        logEvent.Properties.TryGetValue(parameter.Name, out var value))
                     {
-                        if (output == null)
+                        if (parameter.CaptureType == CaptureType.Normal)
                         {
-                            output = preallocated ?? new StringBuilder();
-                            output.Append("[");
+                            var formatString = string.Concat("{0:", parameter.Format, "}");
+                            space.Write(formatString, value);
                         }
-
-                        var space = new StringWriter();
-
-                        if (logEvent.Properties != null &&
-                            logEvent.Properties.TryGetValue(parameter.Name, out var value))
+                        else
                         {
-                            switch (parameter.CaptureType)
-                            {
-                                case CaptureType.Normal:
-                                    var formatString = string.Concat("{0:", parameter.Format, "}");
-                                    space.Write(formatString, value);
-                                    break;
-                                default: // Serialize, Stringify, Unknown
-                                    space.Write(value);
-                                    break;
-                            }
+                            space.Write(value);
                         }
-
-                        output.Append(nextDelimiter);
-                        nextDelimiter = ",";
-                        JsonConverter.SerializeObject(space.ToString(), output);
                     }
+
+                    output.Append(nextDelimiter);
+                    nextDelimiter = ",";
+                    JsonConverter.SerializeObject(space.ToString(), output);
                 }
 
                 return output;
@@ -95,8 +91,7 @@ private StringBuilder RenderLogEvent(LogEventInfo logEvent, StringBuilder preall
             }
             finally
             {
-                if (output != null)
-                    output.Append("]");
+                output?.Append("]");
             }
         }
 
diff --git a/src/NLog.Targets.Seq/SeqApi.cs b/src/NLog.Targets.Seq/SeqApi.cs
@@ -0,0 +1,56 @@
+// Seq Target for NLog - Copyright 2014-2020 Datalust and contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+
+namespace NLog.Targets.Seq
+{
+    static class SeqApi
+    {
+        public const string BulkUploadResource = "api/events/raw";
+        public const string ApiKeyHeaderName = "X-Seq-ApiKey";
+        public const string CompactLogEventFormatMediaType = "application/vnd.serilog.clef";
+
+        // Why not use a JSON parser here? For a very small case, it's not
+        // worth taking on the extra payload/dependency management issues that
+        // a full-fledged parser will entail. If things get more sophisticated
+        // we'll reevaluate.
+        const string LevelMarker = "\"MinimumLevelAccepted\":\"";
+
+        public static SeqLogLevel? ReadMinimumAcceptedLevel(string eventInputResult)
+        {
+            if (eventInputResult == null) return null;
+
+            // Seq 1.5 servers will return JSON including "MinimumLevelAccepted":x, where
+            // x may be null or a JSON string representation of the equivalent LogEventLevel
+            var startProp = eventInputResult.IndexOf(LevelMarker, StringComparison.Ordinal);
+            if (startProp == -1)
+                return null;
+
+            var startValue = startProp + LevelMarker.Length;
+            if (startValue >= eventInputResult.Length)
+                return null;
+
+            var endValue = eventInputResult.IndexOf('"', startValue);
+            if (endValue == -1)
+                return null;
+
+            var value = eventInputResult.Substring(startValue, endValue - startValue);
+            if (!Enum.TryParse(value, out SeqLogLevel minimumLevel))
+                return null;
+
+            return minimumLevel;
+        }
+    }
+}
diff --git a/src/NLog.Targets.Seq/SeqLogLevel.cs b/src/NLog.Targets.Seq/SeqLogLevel.cs
@@ -0,0 +1,26 @@
+﻿// Copyright © Datalust and contributors. 
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace NLog.Targets.Seq
+{
+    enum SeqLogLevel
+    {
+        Verbose,
+        Debug,
+        Information,
+        Warning,
+        Error,
+        Fatal
+    }
+}
diff --git a/src/NLog.Targets.Seq/SeqTarget.cs b/src/NLog.Targets.Seq/SeqTarget.cs
diff --git a/test/NLog.Targets.Seq.Tests/NLog.Targets.Seq.Tests.csproj b/test/NLog.Targets.Seq.Tests/NLog.Targets.Seq.Tests.csproj
diff --git a/test/NLog.Targets.Seq.Tests/SeqTargetTests.cs b/test/NLog.Targets.Seq.Tests/SeqTargetTests.cs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "sdk": {
 +    "version": "5.0.102"
 +  }
 +}
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Example`
`5`	`5`	`{`
`6`		`- class Program`
	`6`	`+ static class Program`
`7`	`7`	`{`
`8`	`8`	`static readonly Logger Logger = LogManager.GetCurrentClassLogger();`
`9`	`9`
`@@ -14,7 +14,7 @@ public static void Main()`
`14`	`14`	`// Structured logging: two named properties are captured using the message template:`
`15`	`15`	`Logger.Info("Hello, {Server}, from {Library}", server, library);`
`16`	`16`
`17`		`- // Text logging: the two properties are captured using positional arguments:`
	`17`	`+ // Text logging: the two properties are formatted into the message using positional arguments:`
`18`	`18`	`Logger.Info("Goodbye, {0}, from {1}", server, library);`
`19`	`19`
`20`	`20`	// Complex data can be captured and serialized into the event using the `@` directive:
Original file line number	Diff line number	Diff line change
`@@ -28,60 +28,56 @@ class RenderingsLayout : Layout`
`28`	`28`
`29`	`29`	`protected override void RenderFormattedMessage(LogEventInfo logEvent, StringBuilder target)`
`30`	`30`	`{`
`31`		`- StringBuilder result = RenderLogEvent(logEvent, target);`
	`31`	`+ var result = RenderLogEvent(logEvent, target);`
`32`	`32`	`if (result == null)`
`33`	`33`	`target.Append("null");`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`protected override string GetFormattedMessage(LogEventInfo logEvent)`
`37`	`37`	`{`
`38`		`- StringBuilder result = RenderLogEvent(logEvent);`
	`38`	`+ var result = RenderLogEvent(logEvent);`
`39`	`39`	`return result?.ToString() ?? "null";`
`40`	`40`	`}`
`41`	`41`
`42`		`- private StringBuilder RenderLogEvent(LogEventInfo logEvent, StringBuilder preallocated = null)`
	`42`	`+ StringBuilder RenderLogEvent(LogEventInfo logEvent, StringBuilder preallocated = null)`
`43`	`43`	`{`
`44`		`- int orgLength = preallocated?.Length ?? 0;`
	`44`	`+ var orgLength = preallocated?.Length ?? 0;`
`45`	`45`	`StringBuilder output = null;`
`46`	`46`
`47`	`47`	`try`
`48`	`48`	`{`
`49`	`49`	`var nextDelimiter = "";`
`50`	`50`	`var mtp = logEvent.MessageTemplateParameters;`
`51`	`51`
`52`		`- for (var i = 0; i < mtp.Count; ++i)`
	`52`	`+ foreach (var parameter in mtp)`
`53`	`53`	`{`
`54`		`- var parameter = mtp[i];`
	`54`	`+ if (parameter.Format == null) continue;`
	`55`	`+`
	`56`	`+ if (output == null)`
	`57`	`+ {`
	`58`	`+ output = preallocated ?? new StringBuilder();`
	`59`	`+ output.Append("[");`
	`60`	`+ }`
`55`	`61`
`56`		`- if (parameter.Format != null)`
	`62`	`+ var space = new StringWriter();`
	`63`	`+`
	`64`	`+ if (logEvent.Properties != null &&`
	`65`	`+ logEvent.Properties.TryGetValue(parameter.Name, out var value))`
`57`	`66`	`{`
`58`		`- if (output == null)`
	`67`	`+ if (parameter.CaptureType == CaptureType.Normal)`
`59`	`68`	`{`
`60`		`- output = preallocated ?? new StringBuilder();`
`61`		`- output.Append("[");`
	`69`	`+ var formatString = string.Concat("{0:", parameter.Format, "}");`
	`70`	`+ space.Write(formatString, value);`
`62`	`71`	`}`
`63`		`-`
`64`		`- var space = new StringWriter();`
`65`		`-`
`66`		`- if (logEvent.Properties != null &&`
`67`		`- logEvent.Properties.TryGetValue(parameter.Name, out var value))`
	`72`	`+ else`
`68`	`73`	`{`
`69`		`- switch (parameter.CaptureType)`
`70`		`- {`
`71`		`- case CaptureType.Normal:`
`72`		`- var formatString = string.Concat("{0:", parameter.Format, "}");`
`73`		`- space.Write(formatString, value);`
`74`		`- break;`
`75`		`- default: // Serialize, Stringify, Unknown`
`76`		`- space.Write(value);`
`77`		`- break;`
`78`		`- }`
	`74`	`+ space.Write(value);`
`79`	`75`	`}`
`80`		`-`
`81`		`- output.Append(nextDelimiter);`
`82`		`- nextDelimiter = ",";`
`83`		`- JsonConverter.SerializeObject(space.ToString(), output);`
`84`	`76`	`}`
	`77`	`+`
	`78`	`+ output.Append(nextDelimiter);`
	`79`	`+ nextDelimiter = ",";`
	`80`	`+ JsonConverter.SerializeObject(space.ToString(), output);`
`85`	`81`	`}`
`86`	`82`
`87`	`83`	`return output;`
`@@ -95,8 +91,7 @@ private StringBuilder RenderLogEvent(LogEventInfo logEvent, StringBuilder preall`
`95`	`91`	`}`
`96`	`92`	`finally`
`97`	`93`	`{`
`98`		`- if (output != null)`
`99`		`- output.Append("]");`
	`94`	`+ output?.Append("]");`
`100`	`95`	`}`
`101`	`96`	`}`
`102`	`97`