Merge pull request #42 from datalust/dev

6.0.0 Release

Author: nblumhardt

README.md

@@ -25,7 +25,7 @@ public class Startup
 {
     public void ConfigureServices(IServiceCollection services)
     {
-        // Added
+        // Added; requires `using Microsoft.Extensions.Logging;`
         services.AddLogging(builder => builder.AddSeq())
 
         // Other configuration follows...

src/Seq.Extensions.Logging/Microsoft/Extensions/Logging/SeqLoggerExtensions.cs

@@ -8,6 +8,7 @@
 using Serilog.Sinks.Seq;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging.Configuration;
+using Serilog.Sinks.PeriodicBatching;
 
 namespace Microsoft.Extensions.Logging
 {
@@ -180,10 +181,8 @@ static SerilogLoggerProvider CreateProvider(
             var sink = new SeqSink(
                 serverUrl,
                 apiKey,
-                1000,
-                TimeSpan.FromSeconds(2),
                 256 * 1024,
-                levelSwitch,
+                new ControlledLevelSwitch(levelSwitch),
                 null);
 
             LevelOverrideMap overrideMap = null;
@@ -198,7 +197,13 @@ static SerilogLoggerProvider CreateProvider(
                 overrideMap = new LevelOverrideMap(overrides, levelSwitch);
             }
 
-            var logger = new Logger(levelSwitch, sink, sink.Dispose, overrideMap);
+            var batchingSink = new PeriodicBatchingSink(sink, new PeriodicBatchingSinkOptions
+            {
+                BatchSizeLimit = 1000,
+                Period = TimeSpan.FromSeconds(2),
+            });
+            
+            var logger = new Logger(levelSwitch, batchingSink, batchingSink.Dispose, overrideMap);
             var provider = new SerilogLoggerProvider(logger);
             return provider;
         }

src/Seq.Extensions.Logging/Seq.Extensions.Logging.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Description>Add centralized structured log collection to ASP.NET Core apps with one line of code.</Description>
-    <VersionPrefix>5.0.0</VersionPrefix>
+    <VersionPrefix>6.0.0</VersionPrefix>
     <Authors>Datalust and Contributors</Authors>
     <TargetFrameworks>net462;netstandard2.0;net5.0</TargetFrameworks>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
@@ -14,7 +14,7 @@
     <PackageIcon>icon.png</PackageIcon>
     <PackageProjectUrl>https://github.com/datalust/seq-extensions-logging</PackageProjectUrl>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-    <RootNamespace/>
+    <RootNamespace />
   </PropertyGroup>
 
   <ItemGroup>
@@ -26,5 +26,4 @@
   <ItemGroup>
     <None Include="..\..\asset\icon.png" Pack="true" Visible="false" PackagePath="" />
   </ItemGroup>
-
 </Project>

src/Seq.Extensions.Logging/Serilog/Sinks/PeriodicBatching/BatchedConnectionStatus.cs

@@ -1,4 +1,4 @@
-// Copyright 2013-2016 Serilog Contributors
+// Copyright 2013-2020 Serilog Contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ namespace Serilog.Sinks.PeriodicBatching
     /// <summary>
     /// Manages reconnection period and transient fault response for <see cref="PeriodicBatchingSink"/>.
     /// During normal operation an object of this type will simply echo the configured batch transmission
-    /// period. When availabilty fluctuates, the class tracks the number of failed attempts, each time
+    /// period. When availability fluctuates, the class tracks the number of failed attempts, each time
     /// increasing the interval before reconnection is attempted (up to a set maximum) and at predefined
     /// points indicating that either the current batch, or entire waiting queue, should be dropped. This
     /// Serves two purposes - first, a loaded receiver may need a temporary reduction in traffic while coming

src/Seq.Extensions.Logging/Serilog/Sinks/PeriodicBatching/BoundedConcurrentQueue.cs

@@ -1,4 +1,4 @@
-// Copyright 2016 Serilog Contributors
+// Copyright 2013-2020 Serilog Contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -18,33 +18,28 @@
 
 namespace Serilog.Sinks.PeriodicBatching
 {
-    class BoundedConcurrentQueue<T> 
+    class BoundedConcurrentQueue<T>
     {
-        const int NON_BOUNDED = -1;
+        const int Unbounded = -1;
 
         readonly ConcurrentQueue<T> _queue = new ConcurrentQueue<T>();
         readonly int _queueLimit;
 
         int _counter;
 
-        public BoundedConcurrentQueue() 
+        public BoundedConcurrentQueue(int? queueLimit = null)
         {
-            _queueLimit = NON_BOUNDED;
-        }
-
-        public BoundedConcurrentQueue(int queueLimit)
-        {
-            if (queueLimit <= 0)
-                throw new ArgumentOutOfRangeException(nameof(queueLimit), "queue limit must be positive");
+            if (queueLimit.HasValue && queueLimit <= 0)
+                throw new ArgumentOutOfRangeException(nameof(queueLimit), "Queue limit must be positive, or `null` to indicate unbounded.");
 
-            _queueLimit = queueLimit;
+            _queueLimit = queueLimit ?? Unbounded;
         }
 
         public int Count => _queue.Count;
 
         public bool TryDequeue(out T item)
         {
-            if (_queueLimit == NON_BOUNDED)
+            if (_queueLimit == Unbounded)
                 return _queue.TryDequeue(out item);
 
             var result = false;
@@ -64,7 +59,7 @@ public bool TryDequeue(out T item)
 
         public bool TryEnqueue(T item)
         {
-            if (_queueLimit == NON_BOUNDED)
+            if (_queueLimit == Unbounded)
             {
                 _queue.Enqueue(item);
                 return true;

src/Seq.Extensions.Logging/Serilog/Sinks/PeriodicBatching/IBatchedLogEventSink.cs

@@ -0,0 +1,38 @@
+// Copyright 2013-2020 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.Collections.Generic;
+using System.Threading.Tasks;
+using Serilog.Events;
+
+namespace Serilog.Sinks.PeriodicBatching
+{
+    /// <summary>
+    /// Interface for targets that accept events in batches.
+    /// </summary>
+    interface IBatchedLogEventSink
+    {
+        /// <summary>
+        /// Emit a batch of log events, running asynchronously.
+        /// </summary>
+        /// <param name="batch">The batch of events to emit.</param>
+        Task EmitBatchAsync(IEnumerable<LogEvent> batch);
+
+        /// <summary>
+        /// Allows sinks to perform periodic work without requiring additional threads
+        /// or timers (thus avoiding additional flush/shut-down complexity).
+        /// </summary>
+        Task OnEmptyBatchAsync();
+    }
+}