Exposed Batch size and interval

Author: merbla

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

@@ -34,7 +34,7 @@ public void Configure()
 
             Log.Logger = new LoggerConfiguration()
                  .WriteTo.LiterateConsole()
-                 .WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", "685546AE-0278-4786-97C4-5971676D5D70")
+                 .WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", "685546AE-0278-4786-97C4-5971676D5D70",renderTemplate:false)
                  .Enrich.WithThreadId()
                  .Enrich.WithProperty("SplunkSample", "ViaEventCollector")
                  .MinimumLevel.Debug()

src/Serilog.Sinks.Splunk.FullNetFx/LoggerConfigurationSplunkExtensions.cs

@@ -22,43 +22,12 @@
 namespace Serilog
 {
     /// <summary>
-    /// Adds the WriteTo.SplunkViaHttp() extension method to <see cref="LoggerConfiguration"/>.
+    /// Adds the WriteTo.SplunkViaEventCollector() extension method to <see cref="LoggerConfiguration"/>.
     /// </summary>
     public static class LoggerConfigurationSplunkExtensions
     {
-
-
-        internal const string DefaultOutputTemplate =
-            "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}";
-
-        /// <summary>
-        /// 
-        /// </summary>
-        /// <param name="sinkConfiguration"></param>
-        /// <param name="splunkHost"></param>
-        /// <param name="eventCollectorToken"></param>
-        /// <param name="restrictedToMinimumLevel"></param>
-        /// <param name="outputTemplate"></param>
-        /// <param name="formatProvider"></param>
-        /// <param name="renderTemplate"></param>
-        /// <returns></returns>
-        public static LoggerConfiguration SplunkViaEventCollector(
-            this LoggerSinkConfiguration sinkConfiguration,
-            string splunkHost,
-            string eventCollectorToken,
-            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
-            string outputTemplate = DefaultOutputTemplate,
-            IFormatProvider formatProvider = null, bool renderTemplate = true)
-        {
-            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 EventCollectorSink(splunkHost, eventCollectorToken), restrictedToMinimumLevel);
-        }
-
-
         /// <summary>
-        /// Adds a sink that writes log events as to a Splunk instance via http.
+        /// Adds a sink that writes log events as to a Splunk instance via UDP.
         /// </summary>
         /// <param name="loggerConfiguration">The logger config</param>
         /// <param name="host">The Splunk host that is configured for UDP logging</param>

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

@@ -62,6 +62,9 @@
     <Reference Include="System.Net.Http" />
   </ItemGroup>
   <ItemGroup>
+    <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>

src/Serilog.Sinks.Splunk/LoggerConfigurationSplunkExtensions.cs

@@ -0,0 +1,72 @@
+// 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 Serilog.Configuration;
+using Serilog.Events;
+using Serilog.Formatting.Display;
+using Serilog.Sinks.Splunk;
+
+namespace Serilog
+{
+    /// <summary>
+    /// Fluent extenstions for the Serilog configuration
+    /// </summary>
+    public static class LoggerConfigurationSplunkPCLExtensions
+    {
+
+        internal const string DefaultOutputTemplate =
+            "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}";
+
+        /// <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>
+        /// <returns></returns>
+        public static LoggerConfiguration SplunkViaEventCollector(
+            this LoggerSinkConfiguration configuration,
+            string splunkHost,
+            string eventCollectorToken,
+            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,
+                batchIntervalInSeconds,
+                batchSizeLimit,
+                formatProvider,
+                renderTemplate);
+
+            return configuration.Sink(eventCollectorSink, restrictedToMinimumLevel);
+        }
+
+        
+    }
+}

src/Serilog.Sinks.Splunk/LoggerConfigurationSplunkPCLExtensions.cs

@@ -49,7 +49,7 @@
     <None Include="Serilog.Sinks.Splunk.nuspec" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="LoggerConfigurationSplunkExtensions.cs" />
+    <Compile Include="LoggerConfigurationSplunkPCLExtensions.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="..\..\assets\CommonAssemblyInfo.cs">
       <Link>Properties\CommonAssemblyInfo.cs</Link>

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

@@ -85,7 +85,7 @@ public class EventCollectorSink : ILogEventSink
         public EventCollectorSink(
             string splunkHost,
             string eventCollectorToken,
-            int batchIntervalInSeconds = 10,
+            int batchIntervalInSeconds = 2,
             int batchSizeLimit = 10,
             IFormatProvider formatProvider = null,
             bool renderTemplate = true