Cleanup on dispose

Author: merbla

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

@@ -8,6 +8,8 @@ namespace Serilog.Sinks.Splunk.Sample
 {
     class Program
     {
+        public static string EventCollectorToken = "DC279305-1816-44D6-9D7A-6CBB70F0A049";
+
         static void Main(string[] args)
         {
             var stub = new Stub();
@@ -26,7 +28,7 @@ static void Main(string[] args)
 
             stub.Run();
 
-            var range = Enumerable.Range(0, 10000);
+            var range = Enumerable.Range(0, 100);
 
             foreach (var i in range)
             {
@@ -45,7 +47,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", Program.EventCollectorToken,
                     renderTemplate:false,
                     batchSizeLimit:150,
                     batchIntervalInSeconds:5)
@@ -65,7 +67,7 @@ public void Configure()
             Log.Logger = new LoggerConfiguration()
                  .WriteTo.LiterateConsole()
                  .WriteTo.SplunkViaEventCollector("https://mysplunk:8088/services/collector", 
-                    "685546AE-0278-4786-97C4-5971676D5D70",
+                    Program.EventCollectorToken,
                     "Serilog",
                     "",
                    Environment.MachineName,

src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorSink.cs

@@ -41,7 +41,7 @@ public class EventCollectorSink : ILogEventSink, IDisposable
         private readonly int _batchSizeLimitLimit;
         private readonly SplunkJsonFormatter _jsonFormatter;
         private readonly ConcurrentQueue<LogEvent> _queue;
-        private readonly EventCollectorClient _httpClient; 
+        private readonly EventCollectorClient _httpClient;
 
         /// <summary>
         /// Taken from Splunk.Logging.Common
@@ -69,21 +69,24 @@ public EventCollectorSink(
             int batchSizeLimit = 100,
             IFormatProvider formatProvider = null,
             bool renderTemplate = true
-            ) 
+            )
         {
             _splunkHost = splunkHost;
             _eventCollectorToken = eventCollectorToken;
             _queue = new ConcurrentQueue<LogEvent>();
             _jsonFormatter = new SplunkJsonFormatter(renderMessage: true, formatProvider: formatProvider, renderTemplate: renderTemplate);
             _batchSizeLimitLimit = batchSizeLimit;
+
             var batchInterval = TimeSpan.FromSeconds(batchIntervalInSeconds);
 
             _httpClient = new EventCollectorClient(_eventCollectorToken);
 
-            //TODO: Implement handling similar to the Seq HTTP sink, including dispose flush
-
-            RepeatAction.OnInterval(batchInterval, () => ProcessQueue().Wait(), new CancellationToken());
+            var cancellationToken = new CancellationToken();
 
+            RepeatAction.OnInterval(
+                batchInterval,
+                async () => await ProcessQueue(),
+                cancellationToken);
         }
 
         /// <summary>
@@ -153,56 +156,84 @@ private async Task ProcessQueue()
                     if (events.Count == 0)
                         return;
 
-                    string allEvents = string.Empty;
+                    await Send(events);
 
-                    foreach (var logEvent in events)
-                    {
-                        var sw = new StringWriter();
-                        _jsonFormatter.Format(logEvent, sw);
+                } while (true);
+            }
+            catch (Exception ex)
+            {
+                SelfLog.WriteLine("Exception while emitting batch from {0}: {1}", this, ex);
+            }
+        }
 
-                        var serialisedEvent = sw.ToString();
-                        
-                        var splunkEvent = new SplunkEvent(serialisedEvent, _source, _sourceType, _host, _index);
+        private async Task Send(IEnumerable<LogEvent> events)
+        {
+            string allEvents = string.Empty;
 
-                        allEvents = $"{allEvents}{splunkEvent.Payload}";
+            foreach (var logEvent in events)
+            {
+                var sw = new StringWriter();
+                _jsonFormatter.Format(logEvent, sw);
 
-                    }
-                    var request = new EventCollectorRequest(_splunkHost, allEvents);
-                    
-                    var response = await _httpClient.SendAsync(request);
+                var serialisedEvent = sw.ToString();
 
-                    if (response.IsSuccessStatusCode)
-                    {  //Do Nothing?
-                    }
-                    else
-                    {
-                        //Application Errors sent via HTTP Event Collector
-                        if (HttpEventCollectorApplicationErrors.Any(x => x == response.StatusCode))
-                        {
-                            SelfLog.WriteLine("A status code of {0} was received when attempting to send to {1}.  The event has been discarded and will not be placed back in the queue.", response.StatusCode.ToString(), _splunkHost);
-                        }
-                        else
-                        {
-                            //Put the item back in the queue & retry on next go
-                            SelfLog.WriteLine("A status code of {0} was received when attempting to send to {1}.  The event has been placed back in the queue", response.StatusCode.ToString(), _splunkHost);
-
-                            foreach (var logEvent in events)
-                            {
-                                _queue.Enqueue(logEvent);
-                            }
-                        }
-                    }
-                } while (true);
+                var splunkEvent = new SplunkEvent(serialisedEvent, _source, _sourceType, _host, _index);
+
+                allEvents = $"{allEvents}{splunkEvent.Payload}";
             }
-            catch (Exception ex)
+            var request = new EventCollectorRequest(_splunkHost, allEvents);
+
+            var response = await _httpClient.SendAsync(request);
+
+            if (response.IsSuccessStatusCode)
             {
-                SelfLog.WriteLine("Exception while emitting batch from {0}: {1}", this, ex);
+                //Do Nothing?
+            }
+            else
+            {
+                //Application Errors sent via HTTP Event Collector
+                if (HttpEventCollectorApplicationErrors.Any(x => x == response.StatusCode))
+                {
+                    SelfLog.WriteLine(
+                        "A status code of {0} was received when attempting to send to {1}.  The event has been discarded and will not be placed back in the queue.",
+                        response.StatusCode.ToString(), _splunkHost);
+                }
+                else
+                {
+                    //Put the item back in the queue & retry on next go
+                    SelfLog.WriteLine(
+                        "A status code of {0} was received when attempting to send to {1}.  The event has been placed back in the queue",
+                        response.StatusCode.ToString(), _splunkHost);
+
+                    foreach (var logEvent in events)
+                    {
+                        _queue.Enqueue(logEvent);
+                    }
+                }
             }
         }
 
         /// <inheritdoc/>
         public void Dispose()
         {
+            Dispose(true);
+        }
+
+        /// <inheritdoc/>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposing) return;
+
+            var remainingEvents = new List<LogEvent>();
+
+            while (!_queue.IsEmpty)
+            {
+                LogEvent next;
+                _queue.TryDequeue(out next);
+                remainingEvents.Add(next);
+            }
+
+            Send(remainingEvents).Wait();
             _httpClient.Dispose();
         }
     }