Readme and doco work

merbla · merbla · commit 74a1a6db5883 · 2015-10-08T08:49:22.000+11:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,6 +2,6 @@
  	- Moved the sink from its [original location](https://github.com/serilog/serilog)
 **1.5.30**
 	- Added switch for template rendering
-**2.0**
+**1.6**
   	- Added support for Splunk 6.3 Event Collector
     - Deprecated Splunk HTTP Sink using Management Port/API
diff --git a/README.md b/README.md
@@ -17,40 +17,27 @@ To get started install the *Serilog.Sinks.Splunk* package from Visual Studio's *
 PM> Install-Package Serilog.Sinks.Splunk
 ```
 
-Set up to log via TCP
+Using the new Event Collector in Splunk 6.3
 
-```csharp
+```csharp 
 var log = new LoggerConfiguration()
-    .WriteTo.SplunkViaTcp("127.0.0.1", 10001)
+     .WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", "myeventcollectortoken")
     .CreateLogger();
 ```
 
-Or maybe UDP
+Set up to log via TCP
 
 ```csharp
 var log = new LoggerConfiguration()
-    .WriteTo.SplunkViaUdp("127.0.0.1", 10000)
+    .WriteTo.SplunkViaTcp("127.0.0.1", 10001)
     .CreateLogger();
 ```
 
-Or maybe HTTP
+Or maybe UDP
 
 ```csharp
-var generalSplunkContext = new Context(Scheme.Https, "127.0.0.1", 8089);
-
-var transmitterArgs = new TransmitterArgs
-{
-    Source = "Splunk.Sample",
-    SourceType = "Splunk Sample Source"
-};
-
-const string username = "my splunk user";
-const string password = "my splunk password";
-const string splunkIndex = "mysplunktest";
-
-var serilogContext = new SplunkContext(generalSplunkContext, splunkIndex, username, password, null, transmitterArgs);
-
 var log = new LoggerConfiguration()
-     .WriteTo.SplunkViaHttp(serilogContext, 10, TimeSpan.FromSeconds(5))
+    .WriteTo.SplunkViaUdp("127.0.0.1", 10000)
     .CreateLogger();
 ```
+
diff --git a/sample/Serilog.Sinks.Splunk.Sample/Program.cs b/sample/Serilog.Sinks.Splunk.Sample/Program.cs
@@ -32,7 +32,6 @@ public void Configure()
          {
             ServicePointManager.ServerCertificateValidationCallback += (sender, cert, chain, sslPolicyErrors) => true;
 
-
             Log.Logger = new LoggerConfiguration()
                  .WriteTo.LiterateConsole()
                  .WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", "685546AE-0278-4786-97C4-5971676D5D70")
diff --git a/serilog-sinks-splunk.sln b/serilog-sinks-splunk.sln
@@ -1,7 +1,7 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 2013
-VisualStudioVersion = 12.0.31101.0
+# Visual Studio 14
+VisualStudioVersion = 14.0.23107.0
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serilog.Sinks.Splunk", "src\Serilog.Sinks.Splunk\Serilog.Sinks.Splunk.csproj", "{1493ABC3-811C-46C7-92ED-CEB7567FB588}"
 EndProject
@@ -12,6 +12,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{B9B13339-749C-4098-8845-780ED4FA488A}"
 	ProjectSection(SolutionItems) = preProject
 		Build.ps1 = Build.ps1
+		CHANGES.md = CHANGES.md
 		assets\CommonAssemblyInfo.cs = assets\CommonAssemblyInfo.cs
 		README.md = README.md
 		assets\Serilog.snk = assets\Serilog.snk
diff --git a/src/Serilog.Sinks.Splunk.FullNetFx/LoggerConfigurationSplunkExtensions.cs b/src/Serilog.Sinks.Splunk.FullNetFx/LoggerConfigurationSplunkExtensions.cs
@@ -53,7 +53,7 @@ public static LoggerConfiguration SplunkViaEventCollector(
             if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration));
             if (outputTemplate == null) throw new ArgumentNullException(nameof(outputTemplate));
             var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider);
-            return sinkConfiguration.Sink(new SplunkViaEventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);
+            return sinkConfiguration.Sink(new EventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);
         }
 
 
@@ -76,7 +76,7 @@ public static LoggerConfiguration SplunkViaUdp(
             IFormatProvider formatProvider = null,
             bool renderTemplate = true)
         {
-            var sink = new SplunkViaUdpSink(host, port, formatProvider, renderTemplate);
+            var sink = new UdpSink(host, port, formatProvider, renderTemplate);
 
             return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
         }
@@ -101,7 +101,7 @@ public static LoggerConfiguration SplunkViaUdp(
             IFormatProvider formatProvider = null,
             bool renderTemplate = true)
         {
-            var sink = new SplunkViaUdpSink(hostAddresss, port, formatProvider, renderTemplate);
+            var sink = new UdpSink(hostAddresss, port, formatProvider, renderTemplate);
 
             return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
         }
@@ -125,7 +125,7 @@ public static LoggerConfiguration SplunkViaTcp(
             IFormatProvider formatProvider = null,
              bool renderTemplate = true)
         {
-            var sink = new SplunkViaTcpSink(hostAddresss, port, formatProvider, renderTemplate);
+            var sink = new TcpSink(hostAddresss, port, formatProvider, renderTemplate);
 
             return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
         }
@@ -149,7 +149,7 @@ public static LoggerConfiguration SplunkViaTcp(
             IFormatProvider formatProvider = null,
              bool renderTemplate = true)
         {
-            var sink = new SplunkViaTcpSink(host, port, formatProvider, renderTemplate);
+            var sink = new TcpSink(host, port, formatProvider, renderTemplate);
 
             return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
         }
diff --git a/src/Serilog.Sinks.Splunk.FullNetFx/Serilog.Sinks.Splunk.FullNetFx.csproj b/src/Serilog.Sinks.Splunk.FullNetFx/Serilog.Sinks.Splunk.FullNetFx.csproj
@@ -65,22 +65,22 @@
     <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\EventCollectorExtensions.cs">
       <Link>Sinks\Splunk\EventCollectorExtensions.cs</Link>
     </Compile>
+    <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\EventCollectorSink.cs">
+      <Link>Sinks\Splunk\EventCollectorSink.cs</Link>
+    </Compile>
     <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\RepeatAction.cs">
       <Link>Sinks\Splunk\RepeatAction.cs</Link>
     </Compile>
     <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\SplunkJsonFormatter.cs">
       <Link>Sinks\Splunk\SplunkJsonFormatter.cs</Link>
     </Compile>
-    <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\SplunkViaEventCollectorSink.cs">
-      <Link>Sinks\Splunk\SplunkViaEventCollectorSink.cs</Link>
-    </Compile>
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="..\..\assets\CommonAssemblyInfo.cs">
       <Link>Properties\CommonAssemblyInfo.cs</Link>
     </Compile>
     <Compile Include="LoggerConfigurationSplunkExtensions.cs" />
-    <Compile Include="Sinks\Splunk\SplunkViaTcpSink.cs" />
-    <Compile Include="Sinks\Splunk\SplunkViaUdpSink.cs" />
+    <Compile Include="Sinks\Splunk\TcpSink.cs" />
+    <Compile Include="Sinks\Splunk\UdpSink.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />
diff --git a/src/Serilog.Sinks.Splunk.FullNetFx/Sinks/Splunk/TcpSink.cs b/src/Serilog.Sinks.Splunk.FullNetFx/Sinks/Splunk/TcpSink.cs
@@ -27,7 +27,7 @@ namespace Serilog.Sinks.Splunk
     /// <summary>
     /// A sink that logs to Splunk over TCP
     /// </summary>
-    public class SplunkViaTcpSink : ILogEventSink, IDisposable
+    public class TcpSink : ILogEventSink, IDisposable
     {
         readonly JsonFormatter _jsonFormatter;
         private TcpSocketWriter _writer;
@@ -40,7 +40,7 @@ public class SplunkViaTcpSink : ILogEventSink, IDisposable
         /// <param name="formatProvider">Optional format provider</param>
         /// <param name="renderTemplate">If true, the message template will be rendered</param>
 
-        public SplunkViaTcpSink(
+        public TcpSink(
             IPAddress hostAddress,
             int port,
             IFormatProvider formatProvider = null,
@@ -60,7 +60,7 @@ public SplunkViaTcpSink(
         /// <param name="port">The UDP port configured in Splunk</param>
         /// <param name="formatProvider">Optional format provider</param>
         /// <param name="renderTemplate">If true, the message template will be rendered</param>
-        public SplunkViaTcpSink(
+        public TcpSink(
             string host,
             int port,
             IFormatProvider formatProvider = null,
diff --git a/src/Serilog.Sinks.Splunk.FullNetFx/Sinks/Splunk/UdpSink.cs b/src/Serilog.Sinks.Splunk.FullNetFx/Sinks/Splunk/UdpSink.cs
@@ -26,7 +26,7 @@ namespace Serilog.Sinks.Splunk
     /// <summary>
     /// A sink that logs to Splunk over Udp
     /// </summary>
-    public class SplunkViaUdpSink : ILogEventSink, IDisposable
+    public class UdpSink : ILogEventSink, IDisposable
     {
         readonly Socket _socket;
         readonly JsonFormatter _jsonFormatter;
@@ -38,7 +38,7 @@ public class SplunkViaUdpSink : ILogEventSink, IDisposable
         /// <param name="port">The UDP port configured in Splunk</param>
         /// <param name="formatProvider">Optional format provider</param>
         /// <param name="renderTemplate">If true, the message template will be rendered</param>
-        public SplunkViaUdpSink(IPAddress hostAddress, int port, IFormatProvider formatProvider = null, bool renderTemplate = true)
+        public UdpSink(IPAddress hostAddress, int port, IFormatProvider formatProvider = null, bool renderTemplate = true)
         {
             _socket = new Socket(SocketType.Dgram, ProtocolType.Udp);
             _socket.Connect(hostAddress, port);
@@ -53,7 +53,7 @@ public SplunkViaUdpSink(IPAddress hostAddress, int port, IFormatProvider formatP
         /// <param name="port">The UDP port configured in Splunk</param>
         /// <param name="formatProvider">Optional format provider</param>
         /// <param name="renderTemplate">If true, the message template is rendered</param>
-        public SplunkViaUdpSink(string host, int port, IFormatProvider formatProvider = null,
+        public UdpSink(string host, int port, IFormatProvider formatProvider = null,
              bool renderTemplate = true)
         {
             _socket = new Socket(SocketType.Dgram, ProtocolType.Udp);
diff --git a/src/Serilog.Sinks.Splunk/LoggerConfigurationSplunkExtensions.cs b/src/Serilog.Sinks.Splunk/LoggerConfigurationSplunkExtensions.cs
@@ -51,7 +51,7 @@ public static LoggerConfiguration SplunkViaEventCollector(
             if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration));
             if (outputTemplate == null) throw new ArgumentNullException(nameof(outputTemplate));
             var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider);
-            return sinkConfiguration.Sink(new SplunkViaEventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);
+            return sinkConfiguration.Sink(new EventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);
         }
     }
 }
diff --git a/src/Serilog.Sinks.Splunk/Serilog.Sinks.Splunk.csproj b/src/Serilog.Sinks.Splunk/Serilog.Sinks.Splunk.csproj
@@ -57,7 +57,7 @@
     <Compile Include="Sinks\Splunk\RepeatAction.cs" />
     <Compile Include="Sinks\Splunk\SplunkJsonFormatter.cs" />
     <Compile Include="Sinks\Splunk\EventCollectorExtensions.cs" />
-    <Compile Include="Sinks\Splunk\SplunkViaEventCollectorSink.cs" />
+    <Compile Include="Sinks\Splunk\EventCollectorSink.cs" />
   </ItemGroup>
   <ItemGroup>
     <Reference Include="Serilog, Version=1.5.0.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
diff --git a/src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorExtensions.cs b/src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorExtensions.cs
@@ -1,4 +1,18 @@
-﻿using System.Net;
+﻿// Copyright 2014 Serilog 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.Net;
 
 namespace Serilog.Sinks.Splunk
 {
diff --git a/src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorSink.cs b/src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorSink.cs
@@ -1,3 +1,17 @@
+// Copyright 2014 Serilog 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;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
@@ -37,12 +51,10 @@ public EventCollectorRequest(string splunkHost, string logEvent)
         }
     }
 
-
-
     /// <summary>
     /// A sink to log to the Event Collector available in Splunk 6.3
     /// </summary>
-    public class SplunkViaEventCollectorSink : ILogEventSink
+    public class EventCollectorSink : ILogEventSink
     {
         private readonly string _splunkHost;
         private readonly string _eventCollectorToken;
@@ -51,8 +63,11 @@ public class SplunkViaEventCollectorSink : ILogEventSink
         private readonly ConcurrentQueue<LogEvent> _queue;
         private readonly TimeSpan _batchInterval;
 
+        /// <summary>
+        /// Taken from Splunk.Logging.Common
+        /// </summary>
         private static readonly HttpStatusCode[] HttpEventCollectorApplicationErrors =
-       {
+        {
             HttpStatusCode.Forbidden,
             HttpStatusCode.MethodNotAllowed,
             HttpStatusCode.BadRequest
@@ -61,13 +76,13 @@ public class SplunkViaEventCollectorSink : ILogEventSink
         /// <summary>
         /// Creates a new instance of the sink
         /// </summary>
-        /// <param name="splunkHost"></param>
-        /// <param name="eventCollectorToken"></param>
-        /// <param name="batchSizeLimit"></param>
-        /// <param name="formatProvider"></param>
-        /// <param name="renderTemplate"></param>
-        /// <param name="batchIntervalInSeconds"></param>
-        public SplunkViaEventCollectorSink(
+        /// <param name="splunkHost">The host of the Splunk instance with the Event collector configured</param>
+        /// <param name="eventCollectorToken">The token to use when authenticating with the event collector</param>
+        /// <param name="batchSizeLimit">The size of the batch when sending to the event collector</param>
+        /// <param name="formatProvider">The format provider used when rendering the message</param>
+        /// <param name="renderTemplate">Whether to render the message template</param>
+        /// <param name="batchIntervalInSeconds">The interval in seconds that batching should occur</param>
+        public EventCollectorSink(
             string splunkHost,
             string eventCollectorToken,
             int batchIntervalInSeconds = 10,
@@ -83,11 +98,12 @@ public SplunkViaEventCollectorSink(
             _batchSizeLimitLimit = batchSizeLimit;
             _batchInterval = TimeSpan.FromSeconds(batchIntervalInSeconds);
 
+            //TODO: Implement handling similar to the Seq HTTP sink
             RepeatAction.OnInterval(_batchInterval, () => ProcessQueue().Wait(), new CancellationToken());
         }
 
         /// <summary>
-        /// 
+        /// Emits the provided log event from a sink 
         /// </summary>
         /// <param name="logEvent"></param>
         public void Emit(LogEvent logEvent)
diff --git a/src/Serilog.Sinks.Splunk/Sinks/Splunk/RepeatAction.cs b/src/Serilog.Sinks.Splunk/Sinks/Splunk/RepeatAction.cs
@@ -1,3 +1,17 @@
+// Copyright 2014 Serilog 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;
 using System.Threading;
 using System.Threading.Tasks;
diff --git a/src/Serilog.Sinks.Splunk/Sinks/Splunk/SplunkJsonFormatter.cs b/src/Serilog.Sinks.Splunk/Sinks/Splunk/SplunkJsonFormatter.cs
@@ -51,7 +51,7 @@ public SplunkJsonFormatter(
 
 
         /// <summary>
-        /// 
+        /// Writes the message with or without the message template
         /// </summary>
         /// <param name="template"></param>
         /// <param name="delim"></param>

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ public void Configure()`
`32`	`32`	`{`
`33`	`33`	`ServicePointManager.ServerCertificateValidationCallback += (sender, cert, chain, sslPolicyErrors) => true;`
`34`	`34`
`35`		`-`
`36`	`35`	`Log.Logger = new LoggerConfiguration()`
`37`	`36`	`.WriteTo.LiterateConsole()`
`38`	`37`	`.WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", "685546AE-0278-4786-97C4-5971676D5D70")`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public static LoggerConfiguration SplunkViaEventCollector(`
`53`	`53`	`if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration));`
`54`	`54`	`if (outputTemplate == null) throw new ArgumentNullException(nameof(outputTemplate));`
`55`	`55`	`var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider);`
`56`		`- return sinkConfiguration.Sink(new SplunkViaEventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);`
	`56`	`+ return sinkConfiguration.Sink(new EventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);`
`57`	`57`	`}`
`58`	`58`
`59`	`59`
`@@ -76,7 +76,7 @@ public static LoggerConfiguration SplunkViaUdp(`
`76`	`76`	`IFormatProvider formatProvider = null,`
`77`	`77`	`bool renderTemplate = true)`
`78`	`78`	`{`
`79`		`- var sink = new SplunkViaUdpSink(host, port, formatProvider, renderTemplate);`
	`79`	`+ var sink = new UdpSink(host, port, formatProvider, renderTemplate);`
`80`	`80`
`81`	`81`	`return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);`
`82`	`82`	`}`
`@@ -101,7 +101,7 @@ public static LoggerConfiguration SplunkViaUdp(`
`101`	`101`	`IFormatProvider formatProvider = null,`
`102`	`102`	`bool renderTemplate = true)`
`103`	`103`	`{`
`104`		`- var sink = new SplunkViaUdpSink(hostAddresss, port, formatProvider, renderTemplate);`
	`104`	`+ var sink = new UdpSink(hostAddresss, port, formatProvider, renderTemplate);`
`105`	`105`
`106`	`106`	`return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);`
`107`	`107`	`}`
`@@ -125,7 +125,7 @@ public static LoggerConfiguration SplunkViaTcp(`
`125`	`125`	`IFormatProvider formatProvider = null,`
`126`	`126`	`bool renderTemplate = true)`
`127`	`127`	`{`
`128`		`- var sink = new SplunkViaTcpSink(hostAddresss, port, formatProvider, renderTemplate);`
	`128`	`+ var sink = new TcpSink(hostAddresss, port, formatProvider, renderTemplate);`
`129`	`129`
`130`	`130`	`return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);`
`131`	`131`	`}`
`@@ -149,7 +149,7 @@ public static LoggerConfiguration SplunkViaTcp(`
`149`	`149`	`IFormatProvider formatProvider = null,`
`150`	`150`	`bool renderTemplate = true)`
`151`	`151`	`{`
`152`		`- var sink = new SplunkViaTcpSink(host, port, formatProvider, renderTemplate);`
	`152`	`+ var sink = new TcpSink(host, port, formatProvider, renderTemplate);`
`153`	`153`
`154`	`154`	`return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);`
`155`	`155`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public static LoggerConfiguration SplunkViaEventCollector(`
`51`	`51`	`if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration));`
`52`	`52`	`if (outputTemplate == null) throw new ArgumentNullException(nameof(outputTemplate));`
`53`	`53`	`var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider);`
`54`		`- return sinkConfiguration.Sink(new SplunkViaEventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);`
	`54`	`+ return sinkConfiguration.Sink(new EventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`	`}`