Merge pull request #29 from datalust/dev

1.0.0 Release

Author: nblumhardt

.gitattributes

@@ -0,0 +1,3 @@
+# Auto detect text files and perform LF normalization
+
+* text=auto

Build.ps1

@@ -0,0 +1,46 @@
+# This script originally (c) 2016 Serilog Contributors - license Apache 2.0
+
+echo "build: Build started"
+
+Push-Location $PSScriptRoot
+
+if(Test-Path .\artifacts) {
+	echo "build: Cleaning .\artifacts"
+	Remove-Item .\artifacts -Force -Recurse
+}
+
+& dotnet restore --no-cache
+
+$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"]
+
+echo "build: Version suffix is $suffix"
+
+foreach ($src in ls src/*) {
+    Push-Location $src
+
+	echo "build: Packaging project in $src"
+
+	if ($suffix) {
+	    & dotnet pack -c Release -o ..\..\artifacts --include-source --version-suffix=$suffix
+	} else {
+		& dotnet pack -c Release -o ..\..\artifacts --include-source
+	}
+    if($LASTEXITCODE -ne 0) { exit 1 }    
+
+    Pop-Location
+}
+
+foreach ($test in ls test/*.Tests) {
+    Push-Location $test
+
+	echo "build: Testing project in $test"
+
+    & dotnet test -c Release
+    if($LASTEXITCODE -ne 0) { exit 3 }
+
+    Pop-Location
+}
+
+Pop-Location

README.md

@@ -1,5 +1,67 @@
-# NLog.Targets.Seq
+# NLog.Targets.Seq [![NuGet Pre Release](https://img.shields.io/nuget/vpre/NLog.Targets.Seq.svg)](https://nuget.org/packages/NLog.Targets.Seq) [![Build status](https://ci.appveyor.com/api/projects/status/o22e6dq0mkftaggc?svg=true)](https://ci.appveyor.com/project/datalust/nlog-targets-seq)  [![Join the chat at https://gitter.im/datalust/seq](https://img.shields.io/gitter/room/datalust/seq.svg)](https://gitter.im/datalust/seq)
 
-**Work in progress**
+An NLog target that writes events to [Seq](https://getseq.net). The target takes full advantage of the structured logging support in **NLog 4.5** to provide hassle-free filtering, searching and analysis.
 
-An NLog target that writes events to Seq. Takes advantage of the structured logging support in NLog 4.5; projects targeting earlier NLog versions should install _Seq.Client.NLog_ instead.
+Projects using earlier NLog versions require the [_Seq.Client.NLog_ package](https://nuget.org/packages/seq.client.nlog) instead.
+
+### Getting started
+
+After installing NLog, install the _NLog.Targets.Seq_ package from NuGet:
+
+```
+Install-Package NLog.Targets.Seq -Pre
+```
+
+Then, add the target and rules entries to your NLog configuration:
+
+```xml
+  <targets async="true">
+    <target name="seq" xsi:type="Seq" serverUrl="https://localhost:5341" apiKey="" />
+  </targets>
+  <rules>
+    <logger name="*" minlevel="Info" writeTo="seq" />
+  </rules>
+```
+
+Set the `serverUrl` value to the address of your Seq server, and provide an API key if you have one set up.
+
+A complete sample application and _NLog.config_ file can be found [here in this repository](https://github.com/datalust/nlog-targets-seq/tree/dev/sample/Example).
+
+### Structured logging with NLog
+
+NLog 4.5 adds support for [message templates](https://messagetemplates.org), extended format strings that capture first-class properties along with the usual message text.
+
+```csharp
+var logger = LogManager.GetCurrentClassLogger();
+
+for (var i = 0; i < 10; ++i)
+{
+    logger.Info("Hello, {Name}, on iteration {Counter}", Environment.UserName, i);
+}
+```
+
+When the events logged in this snippet are rendered to a file or console, they'll appear just like regular formatted text. In Seq or another structured log data store, you'll see that the original `Name` and `Counter` values are preserved separately:
+
+![EventsInSeq](https://raw.githubusercontent.com/datalust/nlog-targets-seq/dev/asset/nlog-events-in-seq.png)
+
+This makes filtering with expressions such as `Counter > 8` or `Name like 'nb%'` trivial: no regular expressions or log parsing are needed to recover the original values.
+
+The fully-rendered message is there too, so you can still search for text like `"Hello, nblumhardt"` and find the events you'd expect.
+
+### Attaching additional properties
+
+The `target` declaration in _NLog.config_ can be expanded with additional properties:
+
+```xml
+  <target name="seq" xsi:type="Seq" serverUrl="http://localhost:5341" apiKey="">
+    <property name="ThreadId" value="${threadid}" as="number" />
+    <property name="MachineName" value="${machinename}" />
+    <property name="Source" value="${logger}" />
+  </target>
+```
+
+Any properties specified here will be attached to all outgoing events. You can see examples of `ThreadId` and `MachineName` in the screenshot above. The value can be any supported [layout renderer](https://github.com/NLog/NLog/wiki/Layout-Renderers).
+
+### Acknowledgements
+
+The target is based on the earlier [_Seq.Client.NLog_ project](https://github.com/datalust/seq-client), and benefits from many contributions accepted into that repository.

appveyor.yml

@@ -0,0 +1,26 @@
+version: '{build}'
+skip_tags: true
+image: Visual Studio 2017
+configuration: Release
+install:
+  - ps: mkdir -Force ".\build\" | Out-Null 
+  - ps: nuget update -Self
+build_script:
+- ps: ./Build.ps1
+test: off
+artifacts:
+- path: artifacts/NLog.Targets.Seq.*.nupkg
+deploy:
+- provider: NuGet
+  api_key:
+    secure: PyALDQp7P4HGAHww8oSEHAZ3ltQpua2eKKl+3DooOl+tlk5tMmMEW2YQQdhdwH7e
+  skip_symbols: true
+  on:
+    branch: /^(master|dev)$/
+- provider: GitHub
+  auth_token:
+    secure: hX+cZmW+9BCXy7vyH8myWsYdtQHyzzil9K5yvjJv7dK9XmyrGYYDj/DPzMqsXSjo
+  artifact: /NLog.Targets.Seq.*\.nupkg/
+  tag: v$(appveyor_build_version)
+  on:
+    branch: master

asset/nlog-events-in-seq.png

@@ -0,0 +1,63 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 15
+VisualStudioVersion = 15.0.26730.15
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{AC295EEA-D319-4146-97E0-B978DF6F2557}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "global", "global", "{66B005E9-A083-41E8-BD89-4D6E753CD8BF}"
+	ProjectSection(SolutionItems) = preProject
+		appveyor.yml = appveyor.yml
+		Build.ps1 = Build.ps1
+		LICENSE = LICENSE
+		README.md = README.md
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{2ED926D3-7AC8-4BFD-A16B-74D942602968}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "asset", "asset", "{69238E6E-26AB-494B-8CBD-65F8C1F0696A}"
+	ProjectSection(SolutionItems) = preProject
+		asset\nlog-targets-seq.png = asset\nlog-targets-seq.png
+		asset\nlog-targets-seq.snk = asset\nlog-targets-seq.snk
+		asset\nlog-targets-seq.svg = asset\nlog-targets-seq.svg
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sample", "sample", "{7533E145-1C93-4348-A70D-E68746C5438C}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NLog.Targets.Seq", "src\NLog.Targets.Seq\NLog.Targets.Seq.csproj", "{D4E037DE-9778-4E48-A4A7-E8C1751E637C}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NLog.Targets.Seq.Tests", "test\NLog.Targets.Seq.Tests\NLog.Targets.Seq.Tests.csproj", "{CD473266-4AED-4207-89FD-0B185239F1C7}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Example", "sample\Example\Example.csproj", "{34BBD428-8297-484E-B771-0B72C172C264}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{D4E037DE-9778-4E48-A4A7-E8C1751E637C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D4E037DE-9778-4E48-A4A7-E8C1751E637C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D4E037DE-9778-4E48-A4A7-E8C1751E637C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D4E037DE-9778-4E48-A4A7-E8C1751E637C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CD473266-4AED-4207-89FD-0B185239F1C7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CD473266-4AED-4207-89FD-0B185239F1C7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CD473266-4AED-4207-89FD-0B185239F1C7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CD473266-4AED-4207-89FD-0B185239F1C7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{34BBD428-8297-484E-B771-0B72C172C264}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{34BBD428-8297-484E-B771-0B72C172C264}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{34BBD428-8297-484E-B771-0B72C172C264}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{34BBD428-8297-484E-B771-0B72C172C264}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{D4E037DE-9778-4E48-A4A7-E8C1751E637C} = {AC295EEA-D319-4146-97E0-B978DF6F2557}
+		{CD473266-4AED-4207-89FD-0B185239F1C7} = {2ED926D3-7AC8-4BFD-A16B-74D942602968}
+		{34BBD428-8297-484E-B771-0B72C172C264} = {7533E145-1C93-4348-A70D-E68746C5438C}
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {DEA01469-166A-4CA9-904E-1D9476D64FFB}
+	EndGlobalSection
+EndGlobal

asset/nlog-targets-seq.png

@@ -0,0 +1,2 @@
+<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>