Merge pull request #92 from merbla/appsettings-compat

Example using AppSettings.json & README updates

Author: merbla

.dockerignore

@@ -0,0 +1,2 @@
+bin\
+obj\

.gitignore

@@ -235,4 +235,6 @@ _Pvt_Extensions
 # FAKE - F# Make
 .fake/
 
-.vscode/
+.vscode/
+
+sample/Sample/out/

CHANGES.md

@@ -1,3 +1,15 @@
+## 3.0.0
+- [#76](https://github.com/serilog/serilog-sinks-splunk/issues/76) Add strong naming/signing to `Serilog.Sinks.Splunk`.
+- [#88](https://github.com/serilog/serilog-sinks-splunk/issues/88) Split Sinks into separate packages for maintainability.
+- *NOTE* Breaking changes.  TCP & UDP Sinks moved to new packages
+    - Serilog.Sinks.Splunk (3.0.x)
+    - Serilog.Sinks.Splunk.TCP (1.0.x)
+    - Serilog.Sinks.Splunk.UDP (1.0.x)
+
+## 2.5.0
+- [#78](https://github.com/serilog/serilog-sinks-splunk/issues/78) Update `System.Net.Http` references to match other similar sinks.
+- [#79](https://github.com/serilog/serilog-sinks-splunk/issues/79) Addition of optional `LoggingLevelSwitch` param to EventCollector sink.
+
 ## 2.4.0
 - [#62](https://github.com/serilog/serilog-sinks-splunk/issues/62) Default fields added by Serilog to splunk
 - [#63](https://github.com/serilog/serilog-sinks-splunk/issues/63) Possible thread leak when ILogger instances are disposed

Dockerfile

@@ -0,0 +1,10 @@
+FROM microsoft/dotnet:2.0-sdk AS build
+ADD . / 
+WORKDIR /sample/Sample
+RUN dotnet restore
+RUN dotnet publish -c Release -o out -f netcoreapp2.0
+
+FROM microsoft/dotnet:2.0-runtime AS runtime
+WORKDIR /sample/Sample
+COPY --from=build /sample/Sample/out ./
+ENTRYPOINT ["dotnet", "Sample.dll"]

README.md

@@ -1,33 +1,67 @@
 # Serilog.Sinks.Splunk
 
-[![Build status](https://ci.appveyor.com/api/projects/status/yt40wg34t8oj61al?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-splunk) 
-[![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.Splunk.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.Splunk/)
+[![Build status](https://ci.appveyor.com/api/projects/status/yt40wg34t8oj61al?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-splunk) ![NuGet Version](https://buildstats.info/nuget/Serilog.Sinks.Splunk) 
  [![Join the chat at https://gitter.im/serilog/serilog](https://img.shields.io/gitter/room/serilog/serilog.svg)](https://gitter.im/serilog/serilog)
 
 A Serilog sink that writes events to the [Splunk](https://splunk.com). Supports .NET 4.5+, .NET Core, and platforms compatible with the [.NET Platform Standard](https://github.com/dotnet/corefx/blob/master/Documentation/architecture/net-platform-standard.md) 1.1 including Windows 8 & UWP, Windows Phone and Xamarin.
 
-[![Package Logo](http://serilog.net/images/serilog-sink-nuget.png)](http://nuget.org/packages/serilog.sinks.splunk)
+[![Package Logo](https://serilog.net/images/serilog-sink-nuget.png)](https://nuget.org/packages/serilog.sinks.splunk)
 
-**Package** - [Serilog.Sinks.Splunk](http://nuget.org/packages/serilog.sinks.splunk)
+**Package** - [Serilog.Sinks.Splunk](https://nuget.org/packages/serilog.sinks.splunk)
 
 ## Getting started
 
-To get started install the *Serilog.Sinks.Splunk* package from Visual Studio's *NuGet* console:
+To get started install the *Serilog.Sinks.Splunk* package:
 
 ```powershell
 PM> Install-Package Serilog.Sinks.Splunk
 ```
 
-Using the Event Collector (Splunk 6.3 and above)
+OR
 
-```csharp 
+```bash
+$ dotnet add package Serilog.Sinks.Splunk
+```
+
+If using the `TCP` or `UDP` sinks install the following packages
+
+* TCP: `Serilog.Sinks.Splunk.TCP`
+* UDP: `Serilog.Sinks.Splunk.UDP`
+
+To start using the Splunk Event Collector (Splunk 6.3 and above), logging can be setup as follows.
+
+```csharp
 var log = new LoggerConfiguration()
-     .WriteTo.EventCollector("https://mysplunk:8088/services/collector", "myeventcollectortoken")
+    .WriteTo.EventCollector("https://mysplunk:8088/services/collector", "myeventcollectortoken")
     .CreateLogger();
 ```
 
-More information is available on the [wiki](https://github.com/serilog/serilog-sinks-splunk/wiki).
+If using `appsettings.json` for configuration the following example illustrates using the Event Collector and Console sinks.
+
+```javascript
+{
+    "Serilog": {
+        "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.Splunk"],
+        "MinimumLevel": "Information",
+        "WriteTo": [{
+                "Name": "Console"
+            },
+            {
+                "Name": "EventCollector",
+                "Args": {
+                    "splunkHost": "http://splunk:8088",
+                    "eventCollectorToken": "00112233-4455-6677-8899-AABBCCDDEEFF"
+                }
+            }
+        ],
+        "Properties": {
+            "Application": "Serilog Splunk Console Sample"
+        }
+    }
+}
+```
 
+More information about Serilog is available on the [wiki](https://github.com/serilog/serilog-sinks-splunk/wiki).
 ### Build status
 
 Branch  | AppVeyor | Travis

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '2'
+services:
+  splunk:
+    build: ./sample/splunk 
+    image: serilog-splunk
+    ports:
+      - 8000:8000
+      - 8088:8088
+      - 8089:8089
+    environment:
+      SPLUNK_START_ARGS: "--accept-license --answer-yes"
+      SPLUNK_USER: "root"
+  sampleconsoleapp:
+    depends_on:
+      - "splunk"
+    build: .
+    image: serilog-console-sample

sample/Sample/Program.cs

@@ -1,45 +1,75 @@
 using System.Collections.Generic;
 using System.Linq;
+using System.IO;
 using Serilog;
 using Serilog.Sinks.Splunk;
-
+using Microsoft.Extensions.Configuration;
 namespace Sample
 {
     public class Program
     {
-        const string SPLUNK_FULL_ENDPOINT = "http://localhost:8088/services/collector"; // Full splunk url 
-        const string SPLUNK_ENDPOINT = "http://localhost:8088"; //  Your splunk url  
-        const string SPLUNK_HEC_TOKEN = "1AFAC088-BFC6-447F-A358-671FA7465342"; // Your HEC token. See http://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector
+        const string SPLUNK_FULL_ENDPOINT = "http://splunk:8088/services/collector"; // Full splunk url 
+        const string SPLUNK_ENDPOINT = "http://splunk:8088"; //  Your splunk url  
+        const string SPLUNK_HEC_TOKEN = "00112233-4455-6677-8899-AABBCCDDEEFF"; // Your HEC token. See http://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector
         public static string EventCollectorToken = SPLUNK_HEC_TOKEN; 
 
         public static void Main(string[] args)
         {
             var eventsToCreate = 100;
             var runSSL = false;
+            var millisecsToWait = 30000;
 
             if (args.Length > 0)
                 eventsToCreate = int.Parse(args[0]);
 
             if (args.Length == 2)
                 runSSL = bool.Parse(args[1]);
 
-            Log.Information("Sample starting up");
+            if (args.Length == 3)
+                millisecsToWait = int.Parse(args[2]);
+
             Serilog.Debugging.SelfLog.Enable(System.Console.Out);
+            Log.Information("Sample app starting up...");
+
+            Log.Information("Waiting {} millisecs...", millisecsToWait);
 
+            System.Threading.Thread.Sleep(millisecsToWait);
+
+            UsingAppSettingsJson(eventsToCreate);
+            UsingHostOnly(eventsToCreate);
             UsingHostOnly(eventsToCreate);
             UsingFullUri(eventsToCreate);
             OverridingSource(eventsToCreate);
             OverridingSourceType(eventsToCreate);
             OverridingHost(eventsToCreate);
             WithNoTemplate(eventsToCreate);
             WithCompactSplunkFormatter(eventsToCreate);
+
             if (runSSL)
             {
                 UsingSSL(eventsToCreate);
             }
             AddCustomFields(eventsToCreate);
 
-            Log.Debug("Done");
+            Log.Information("Done....");
+        }
+        public static void UsingAppSettingsJson(int eventsToCreate)
+        {
+            var configuration = new ConfigurationBuilder()
+                .SetBasePath(Directory.GetCurrentDirectory())
+                .AddJsonFile("appsettings.json")
+                .Build();
+
+            Log.Logger = new LoggerConfiguration()
+                .ReadFrom.Configuration(configuration)
+                .CreateLogger();
+
+            foreach (var i in Enumerable.Range(0, eventsToCreate))
+            {
+                Log.Information("Running via appsettings.json {Counter}", i);
+            }
+
+            Log.CloseAndFlush();
         }
 
         private static void WithCompactSplunkFormatter(int eventsToCreate)
@@ -59,7 +89,7 @@ private static void WithCompactSplunkFormatter(int eventsToCreate)
 
             foreach (var i in Enumerable.Range(0, eventsToCreate))
             {
-                Log.Information("{Counter}{Message}", i, "Running vanilla loop with CompactSplunkJsonFormatter");
+                Log.Information("{Counter}{Message}", i, " Running vanilla loop with CompactSplunkJsonFormatter");
             }
 
             Log.CloseAndFlush();

sample/Sample/Sample.csproj

@@ -6,11 +6,20 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Serilog" Version="2.6.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.1.0" />
     <PackageReference Include="System.Net.Http" Version="4.3.3" />
+    <PackageReference Include="Serilog.Settings.Configuration" Version="2.6.1" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="2.0.1" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\Serilog.Sinks.Splunk\Serilog.Sinks.Splunk.csproj" />
   </ItemGroup>
+
+    <ItemGroup>
+    <None Update="appsettings.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
 </Project>

sample/Sample/appsettings.json

@@ -0,0 +1,22 @@
+{
+    "Serilog": {
+        "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.Splunk"],
+        "MinimumLevel": "Information",
+        "WriteTo": [{
+                "Name": "Console"
+            },
+            {
+                "Name": "EventCollector",
+                "Args": {
+                    "splunkHost": "http://splunk:8088",
+                    "eventCollectorToken": "00112233-4455-6677-8899-AABBCCDDEEFF"
+                }
+            }
+        ],
+        "Properties": {
+            "Application": "Serilog Splunk Console Sample",
+            "Serilog.Sinks.Splunk.Sample": "ViaEventCollector",
+            "Serilog.Sinks.Splunk.Sample.TestType": "AppSettings.json"
+        }
+    }
+}

sample/splunk/Dockerfile

@@ -0,0 +1,2 @@
+FROM splunk/splunk:6.5.3
+ADD etc ${SPLUNK_HOME}/etc