Extensions for Event Collector overrides

New sink closes serilog/serilog#483

Author: merbla

sample/Serilog.Sinks.Splunk.Sample/Program.cs

@@ -13,8 +13,13 @@ static void Main(string[] args)
 ;
             var tcp = new ViaTcp();
             var udp = new ViaUdp();
-            var eventCollector = new ViaEventCollector();
-            eventCollector.Configure();
+            var ec = new ViaEventCollector();
+            var eco = new ViaEventCollectorWithExtendedOptions();
+
+            eco.Configure();
+
+            //ec.Configure();
+       
             //udp.Configure();
             //tcp.Configure();
 
@@ -26,7 +31,7 @@ static void Main(string[] args)
         }
     }
 
-     class ViaEventCollector : IConfigure
+    class ViaEventCollector : IConfigure
     {
          public void Configure()
          {
@@ -36,12 +41,35 @@ public void Configure()
                  .WriteTo.LiterateConsole()
                  .WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", "685546AE-0278-4786-97C4-5971676D5D70",renderTemplate:false)
                  .Enrich.WithThreadId()
-                 .Enrich.WithProperty("SplunkSample", "ViaEventCollector")
+                 .Enrich.WithProperty("Serilog.Sinks.Splunk.Sample", "ViaEventCollector")
                  .MinimumLevel.Debug()
                  .CreateLogger();
          }
     }
 
+    class ViaEventCollectorWithExtendedOptions : IConfigure
+    {
+        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",
+                    "Serilog",
+                    "",
+                   Environment.MachineName,
+                    "" ,
+                    renderTemplate: false)
+                 .Enrich.WithThreadId()
+                 .Enrich.WithProperty("Serilog.Sinks.Splunk.Sample", "ViaEventCollector")
+                 .MinimumLevel.Debug()
+                 .CreateLogger();
+        }
+    }
+
+
     class ViaTcp : IConfigure
     {
         public void Configure()
@@ -50,7 +78,7 @@ public void Configure()
             .WriteTo.LiterateConsole()
             .WriteTo.SplunkViaTcp("127.0.0.1", 10001, renderTemplate: false)
             .Enrich.WithThreadId()
-            .Enrich.WithProperty("SplunkSample", "ViaTCP")
+            .Enrich.WithProperty("Serilog.Sinks.Splunk.Sample", "ViaTCP")
             .MinimumLevel.Debug()
             .CreateLogger();
         }

src/Serilog.Sinks.Splunk.FullNetFx/Serilog.Sinks.Splunk.FullNetFx.csproj

@@ -65,8 +65,11 @@
     <Compile Include="..\Serilog.Sinks.Splunk\LoggerConfigurationSplunkPCLExtensions.cs">
       <Link>LoggerConfigurationSplunkPCLExtensions.cs</Link>
     </Compile>
-    <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\EventCollectorExtensions.cs">
-      <Link>Sinks\Splunk\EventCollectorExtensions.cs</Link>
+    <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\EventCollectorClient.cs">
+      <Link>Sinks\Splunk\EventCollectorClient.cs</Link>
+    </Compile>
+    <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\EventCollectorRequest.cs">
+      <Link>Sinks\Splunk\EventCollectorRequest.cs</Link>
     </Compile>
     <Compile Include="..\Serilog.Sinks.Splunk\Sinks\Splunk\EventCollectorSink.cs">
       <Link>Sinks\Splunk\EventCollectorSink.cs</Link>

src/Serilog.Sinks.Splunk/LoggerConfigurationSplunkPCLExtensions.cs

@@ -67,6 +67,54 @@ public static LoggerConfiguration SplunkViaEventCollector(
             return configuration.Sink(eventCollectorSink, restrictedToMinimumLevel);
         }
 
-        
+        /// <summary>
+        /// Adds a sink that writes log events as to a Splunk instance via UDP.
+        /// </summary>
+        /// <param name="configuration">The logger config</param>
+        /// <param name="splunkHost">The Splunk host that is configured with an Event Collector</param>
+        /// <param name="eventCollectorToken">The token provided to authenticate to the Splunk Event Collector</param>
+        /// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
+        /// <param name="outputTemplate">The output template to be used when logging</param>
+        /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
+        /// <param name="renderTemplate">If ture, the message template will be rendered</param>
+        /// <param name="batchIntervalInSeconds">The interval in seconds that the queue should be instpected for batching</param>
+        /// <param name="batchSizeLimit">The size of the batch</param>
+        /// <param name="index">The Splunk index to log to</param>
+        /// <param name="source">The source of the event</param>
+        /// <param name="sourceType">The source type of the event</param>
+        /// <param name="host">The host of the event</param>
+        /// <returns></returns>
+        public static LoggerConfiguration SplunkViaEventCollector(
+            this LoggerSinkConfiguration configuration,
+            string splunkHost,
+            string eventCollectorToken,
+            string source,
+            string sourceType,
+            string host,
+            string index,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            string outputTemplate = DefaultOutputTemplate,
+            IFormatProvider formatProvider = null,
+            bool renderTemplate = true,
+            int batchIntervalInSeconds = 2,
+            int batchSizeLimit = 10)
+        {
+            if (configuration == null) throw new ArgumentNullException(nameof(configuration));
+            if (outputTemplate == null) throw new ArgumentNullException(nameof(outputTemplate));
+
+            var eventCollectorSink = new EventCollectorSink(
+                splunkHost,
+                eventCollectorToken,
+                source,
+                sourceType,
+                host,
+                index,
+                batchIntervalInSeconds,
+                batchSizeLimit,
+                formatProvider,
+                renderTemplate);
+
+            return configuration.Sink(eventCollectorSink, restrictedToMinimumLevel);
+        }
     }
 }

src/Serilog.Sinks.Splunk/Serilog.Sinks.Splunk.csproj

@@ -54,9 +54,10 @@
     <Compile Include="..\..\assets\CommonAssemblyInfo.cs">
       <Link>Properties\CommonAssemblyInfo.cs</Link>
     </Compile>
+    <Compile Include="Sinks\Splunk\EventCollectorClient.cs" />
+    <Compile Include="Sinks\Splunk\EventCollectorRequest.cs" />
     <Compile Include="Sinks\Splunk\RepeatAction.cs" />
     <Compile Include="Sinks\Splunk\SplunkJsonFormatter.cs" />
-    <Compile Include="Sinks\Splunk\EventCollectorExtensions.cs" />
     <Compile Include="Sinks\Splunk\EventCollectorSink.cs" />
   </ItemGroup>
   <ItemGroup>

src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorClient.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Net.Http;
+using System.Net.Http.Headers;
+
+namespace Serilog.Sinks.Splunk
+{
+    internal class EventCollectorClient : HttpClient, IDisposable
+    {
+        public EventCollectorClient(string eventCollectorToken) : base()
+        {
+            DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Splunk", eventCollectorToken);
+        }
+    }
+}

src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorExtensions.cs

@@ -0,0 +1,46 @@
+using System;
+using System.Net.Http;
+using System.Text;
+
+namespace Serilog.Sinks.Splunk
+{
+    internal class EventCollectorRequest : HttpRequestMessage
+    {
+        public EventCollectorRequest(
+            string splunkHost, 
+            string logEvent, 
+            string source,
+            string sourceType, 
+            string host, 
+            string index)
+        {
+
+            var jsonPayLoad = @"{""event"":" + logEvent 
+              .Replace("\r\n", string.Empty);
+
+            if (!string.IsNullOrWhiteSpace(source))
+            {
+                jsonPayLoad = jsonPayLoad + @",""source"":""" + source + @"""";
+            }
+            if (!string.IsNullOrWhiteSpace(sourceType))
+            {
+                  jsonPayLoad = jsonPayLoad + @",""sourceType"":""" + sourceType + @"""";
+            }
+            if (!string.IsNullOrWhiteSpace(host))
+            {
+                jsonPayLoad = jsonPayLoad + @",""host"":""" + host + @"""";
+            }
+            if (!string.IsNullOrWhiteSpace(index))
+            {
+                jsonPayLoad = jsonPayLoad + @",""index"":""" + index + @"""";
+            }
+
+            jsonPayLoad = jsonPayLoad + "}"; 
+
+            var stringContent = new StringContent(jsonPayLoad, Encoding.UTF8, "application/json");
+            RequestUri = new Uri(splunkHost);
+            Content = stringContent;
+            Method = HttpMethod.Post;
+        }
+    }
+}