Merge branch 'dev' into main

BrammyS · Jul 24, 2021 · f5bfa1c · f5bfa1c
2 parents 2ec6d6e + b3a8129
commit f5bfa1c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -23,12 +23,29 @@ You will need to do the following to add Serilog.Sinks.Mongodb.TimeSeries as a s
 
 ```csharp
 var client = new MongoClient("mongodb://mongodb0.example.com:27017");
-var mongoDatabase = client.GetDatabase("logs");
+var mongoDatabase = client.GetDatabase("dbName");
 
 Log.Logger = new LoggerConfiguration()
                  .WriteTo.MongoDbTimeSeriesSink(mongoDatabase)
                  .CreateLogger();
 ```
+OR
+```csharp
+var client = new MongoClient("mongodb://mongodb0.example.com:27017");
+var mongoDatabase = client.GetDatabase("dbName");
+
+var batchingConfig = new PeriodicBatchingSinkOptions
+{
+    BatchSizeLimit = 250,
+    Period = TimeSpan.FromSeconds(20),
+    EagerlyEmitFirstEvent = true,
+    QueueLimit = 500
+};
+
+Log.Logger = new LoggerConfiguration()
+                 .WriteTo.MongoDbTimeSeriesSink(mongoDatabase, batchingConfig)
+                 .CreateLogger();
+```
 
 ## 3. Compiling
 You will need the following to compile Serilog.Sinks.Mongodb.TimeSeries:

diff --git a/src/Serilog.Sinks.Mongodb.TimeSeries/Extensions/LoggerSinkConfigurationExtensions.cs b/src/Serilog.Sinks.Mongodb.TimeSeries/Extensions/LoggerSinkConfigurationExtensions.cs
@@ -21,7 +21,7 @@ public static class LoggerSinkConfigurationExtensions
         ///     to batch the logs.
         /// </param>
         /// <returns>
-        ///     The new <see cref="LoggerSinkConfiguration" /> with new sink.
+        ///     The new <see cref="LoggerSinkConfiguration" /> with the new sink.
         /// </returns>
         public static LoggerConfiguration MongoDbTimeSeriesSink(this LoggerSinkConfiguration loggerConfiguration, MongoDbTimeSeriesSinkConfig sinkConfig, PeriodicBatchingSinkOptions batchingOptions)
         {
@@ -39,7 +39,7 @@ public static LoggerConfiguration MongoDbTimeSeriesSink(this LoggerSinkConfigura
         ///     to batch the logs.
         /// </param>
         /// <returns>
-        ///     The new <see cref="LoggerSinkConfiguration" /> with new sink.
+        ///     The new <see cref="LoggerSinkConfiguration" /> with the new sink.
         /// </returns>
         public static LoggerConfiguration MongoDbTimeSeriesSink(this LoggerSinkConfiguration loggerConfiguration, IMongoDatabase database, PeriodicBatchingSinkOptions batchingOptions)
         {
@@ -52,7 +52,7 @@ public static LoggerConfiguration MongoDbTimeSeriesSink(this LoggerSinkConfigura
         /// <param name="loggerConfiguration">The <see cref="LoggerSinkConfiguration" />.</param>
         /// <param name="database">The database of where the logs will be stored.</param>
         /// <returns>
-        ///     The new <see cref="LoggerSinkConfiguration" /> with new sink.
+        ///     The new <see cref="LoggerSinkConfiguration" /> with the new sink.
         /// </returns>
         public static LoggerConfiguration MongoDbTimeSeriesSink(this LoggerSinkConfiguration loggerConfiguration, IMongoDatabase database)
         {