removed: deprecated extension DurableHttp (#183)

Closes #182
FantasticFiasco · Apr 5, 2021 · e5b38d7 · e5b38d7
1 parent cdca391
commit e5b38d7
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 133 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -44,7 +44,7 @@ log = new LoggerConfiguration()
       false,
       10,
       500,
-      TimeSpan.FromSeconds(10)
+      TimeSpan.FromSeconds(10))
   .CreateLogger();
 
 // After migration
@@ -57,7 +57,7 @@ log = new LoggerConfiguration()
       retainedBufferFileCountLimit: 10,
       batchPostingLimit: 500,
       // the new argument batchSizeLimitBytes is positioned here
-      period: TimeSpan.FromSeconds(10)
+      period: TimeSpan.FromSeconds(10))
   .CreateLogger();
 ```
 
@@ -73,7 +73,7 @@ log = new LoggerConfiguration()
       false,
       10,
       500,
-      TimeSpan.FromSeconds(10)
+      TimeSpan.FromSeconds(10))
   .CreateLogger();
 
 // After migration
@@ -86,7 +86,7 @@ log = new LoggerConfiguration()
       retainedBufferFileCountLimit: 10,
       batchPostingLimit: 500,
       // the new argument batchSizeLimitBytes is positioned here
-      period: TimeSpan.FromSeconds(10)
+      period: TimeSpan.FromSeconds(10))
   .CreateLogger();
 ```
 
@@ -133,6 +133,58 @@ public class MyHttpClient : IHttpClient
 }
 ```
 
+### :skull: Removed
+
+- [#182](https://github.com/FantasticFiasco/serilog-sinks-http/issues/182) Extension method `DurableHttp` which was marked as deprecated in v5.2.0
+
+**Migration guide**
+
+Given you are configuring the sink in code you should do the following changes.
+
+```csharp
+// Before migration
+log = new LoggerConfiguration()
+  .WriteTo.DurableHttp(requestUri: "http://www.mylogs.com")
+  .CreateLogger();
+
+// After migration
+log = new LoggerConfiguration()
+  .WriteTo.DurableHttpUsingTimeRolledBuffers(requestUri: "http://www.mylogs.com")
+  .CreateLogger();
+```
+
+Given you are configuring the sink in application configuration you should do the following changes.
+
+```json
+// Before migration
+{
+  "Serilog": {
+    "WriteTo": [
+      {
+        "Name": "DurableHttp",
+        "Args": {
+          "requestUri": "http://www.mylogs.com"
+        }
+      }
+    ]
+  }
+}
+
+// After migration
+{
+  "Serilog": {
+    "WriteTo": [
+      {
+        "Name": "DurableHttpUsingTimeRolledBuffers",
+        "Args": {
+          "requestUri": "http://www.mylogs.com"
+        }
+      }
+    ]
+  }
+}
+```
+
 ### :syringe: Fixed
 
 - Durable buffer files are no longer created with an initial [BOM](https://en.wikipedia.org/wiki/Byte_order_mark)

diff --git a/src/Serilog.Sinks.Http/LoggerSinkConfigurationExtensions.cs b/src/Serilog.Sinks.Http/LoggerSinkConfigurationExtensions.cs
@@ -13,7 +13,6 @@
 // limitations under the License.
 
 using System;
-using System.ComponentModel;
 using Microsoft.Extensions.Configuration;
 using Serilog.Configuration;
 using Serilog.Events;
@@ -127,39 +126,6 @@ public static LoggerConfiguration Http(
             return sinkConfiguration.Sink(sink, restrictedToMinimumLevel);
         }
 
-        [Obsolete("Use DurableHttpUsingTimeRolledBuffers instead of this sink provider")]
-        [EditorBrowsable(EditorBrowsableState.Never)]
-        public static LoggerConfiguration DurableHttp(
-            this LoggerSinkConfiguration sinkConfiguration,
-            string requestUri,
-            string bufferPathFormat = "Buffer-{Date}.json",
-            long? bufferFileSizeLimitBytes = null,
-            bool bufferFileShared = false,
-            int? retainedBufferFileCountLimit = 31,
-            int batchPostingLimit = 1000,
-            TimeSpan? period = null,
-            ITextFormatter? textFormatter = null,
-            IBatchFormatter? batchFormatter = null,
-            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
-            IHttpClient? httpClient = null,
-            IConfiguration? configuration = null)
-        {
-            return DurableHttpUsingTimeRolledBuffers(
-                sinkConfiguration: sinkConfiguration,
-                requestUri: requestUri,
-                bufferPathFormat: bufferPathFormat,
-                bufferFileSizeLimitBytes: bufferFileSizeLimitBytes,
-                bufferFileShared: bufferFileShared,
-                retainedBufferFileCountLimit: retainedBufferFileCountLimit,
-                batchPostingLimit: batchPostingLimit,
-                period: period,
-                textFormatter: textFormatter,
-                batchFormatter: batchFormatter,
-                restrictedToMinimumLevel: restrictedToMinimumLevel,
-                httpClient: httpClient,
-                configuration: configuration);
-        }
-
         /// <summary>
         /// Adds a durable sink that sends log events using HTTP POST over the network. A durable
         /// sink will persist log events on disk in buffer files before sending them over the

diff --git a/test/Serilog.Sinks.HttpTests/DurableHttpSinkGivenAppSettingsShould.cs b/test/Serilog.Sinks.HttpTests/DurableHttpSinkGivenAppSettingsShould.cs
diff --git a/test/Serilog.Sinks.HttpTests/DurableHttpSinkGivenCodeConfigurationShould.cs b/test/Serilog.Sinks.HttpTests/DurableHttpSinkGivenCodeConfigurationShould.cs
diff --git a/test/Serilog.Sinks.HttpTests/Serilog.Sinks.HttpTests.csproj b/test/Serilog.Sinks.HttpTests/Serilog.Sinks.HttpTests.csproj
@@ -30,9 +30,6 @@
     <None Update="appsettings_durable_http_using_time_rolled_buffers.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <None Update="appsettings_durable_http.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
     <None Update="appsettings_http.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

diff --git a/test/Serilog.Sinks.HttpTests/appsettings_durable_http.json b/test/Serilog.Sinks.HttpTests/appsettings_durable_http.json