Feature for Issue #82

Bson sink supports excluding the "MessageTemplate" as it can be redundant/unnecessary since the RenderedMessage exists.
ChangemakerStudios · Feb 18, 2024 · bb6e973 · bb6e973
1 parent 19dd834
commit bb6e973
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 14 deletions.
diff --git a/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/LogEntry.cs b/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/LogEntry.cs
@@ -33,6 +33,7 @@ public class LogEntry
 
     public DateTime UtcTimeStamp { get; set; }
 
+    [BsonIgnoreIfNull]
     public MessageTemplate? MessageTemplate { get; set; }
 
     public string? RenderedMessage { get; set; }
@@ -41,21 +42,27 @@ public class LogEntry
 
     public BsonDocument? Exception { get; set; }
 
-    public static LogEntry MapFrom(LogEvent logEvent)
+    public static LogEntry MapFrom(LogEvent logEvent, bool includeMessageTemplate)
     {
         if (logEvent == null) throw new ArgumentNullException(nameof(logEvent));
 
-        return new LogEntry
+        var logEntry = new LogEntry
+                       {
+                           RenderedMessage = logEvent.RenderMessage(),
+                           Level = logEvent.Level,
+                           UtcTimeStamp = logEvent.Timestamp.ToUniversalTime().UtcDateTime,
+                           Exception = logEvent.Exception?.ToBsonDocument().SanitizeDocumentRecursive(),
+                           Properties = BsonDocument.Create(
+                               logEvent.Properties.ToDictionary(
+                                   s => s.Key.SanitizedElementName(),
+                                   s => s.Value.ToBsonValue()))
+                       };
+
+        if (includeMessageTemplate)
         {
-            MessageTemplate = logEvent.MessageTemplate,
-            RenderedMessage = logEvent.RenderMessage(),
-            Level = logEvent.Level,
-            UtcTimeStamp = logEvent.Timestamp.ToUniversalTime().UtcDateTime,
-            Exception = logEvent.Exception?.ToBsonDocument().SanitizeDocumentRecursive(),
-            Properties = BsonDocument.Create(
-                logEvent.Properties.ToDictionary(
-                    s => s.Key.SanitizedElementName(),
-                    s => s.Value.ToBsonValue()))
-        };
+            logEntry.MessageTemplate = logEvent.MessageTemplate;
+        }
+
+        return logEntry;
     }
 }
diff --git a/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/MongoDBSink.cs b/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/MongoDBSink.cs
@@ -46,6 +46,6 @@ public MongoDBSink(MongoDBSinkConfiguration configuration)
 
     public override Task EmitBatchAsync(IEnumerable<LogEvent> events)
     {
-        return this.InsertMany(events.Select(LogEntry.MapFrom));
+        return this.InsertMany(events.Select(@event => LogEntry.MapFrom(@event, this.IncludeMessageTemplate)));
     }
 }
diff --git a/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/MongoDBSinkBase.cs b/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/MongoDBSinkBase.cs
@@ -39,7 +39,7 @@ public abstract class MongoDBSinkBase : IBatchedLogEventSink
     /// </summary>
     protected MongoDBSinkBase(MongoDBSinkConfiguration configuration)
     {
-        if (configuration == null) throw new ArgumentNullException(nameof(configuration));
+        if (configuration! == null) throw new ArgumentNullException(nameof(configuration));
 
         this._configuration = configuration;
 
@@ -51,6 +51,8 @@ protected MongoDBSinkBase(MongoDBSinkConfiguration configuration)
             LazyThreadSafetyMode.ExecutionAndPublication);
     }
 
+    protected bool IncludeMessageTemplate => !this._configuration.ExcludeMessageTemplate;
+
     protected string CollectionName => this._configuration.CollectionName;
 
     protected RollingInterval RollingInterval => this._configuration.RollingInterval;

diff --git a/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/MongoDBSinkConfiguration.cs b/src/Serilog.Sinks.MongoDB/Sinks/MongoDB/MongoDBSinkConfiguration.cs
@@ -38,6 +38,8 @@ public class MongoDBSinkConfiguration
 
     public bool Legacy { get; internal set; }
 
+    public bool ExcludeMessageTemplate { get; internal set; }
+
     public InsertManyOptions? InsertManyOptions { get; internal set; }
 
     public RollingInterval RollingInterval { get; private set; } = RollingInterval.Infinite;
@@ -58,6 +60,11 @@ public void Validate()
             throw new ArgumentNullException(
                 nameof(this.ExpireTTL),
                 "Expiration TTL is only supported on the MongoDBBson Sink");
+
+        if (this.ExcludeMessageTemplate && this.Legacy)
+            throw new ArgumentNullException(
+                nameof(this.ExcludeMessageTemplate),
+                "Exclude Message Template is only supported on the MongoDBBson Sink");
     }
 
     /// <summary>
@@ -88,6 +95,17 @@ public void SetExpireTTL(TimeSpan? timeToLive)
         this.ExpireTTL = timeToLive;
     }
 
+    /// <summary>
+    ///    Sets if the log should include the "MessageTemplate" field,
+    ///    as the RenderedMessage field is already included the "MessageTemplate"
+    ///    may be unnecessary/redundant.
+    /// </summary>
+    /// <param name="excludeMessageTemplate"></param>
+    public void SetExcludeMessageTemplate(bool excludeMessageTemplate)
+    {
+        this.ExcludeMessageTemplate = excludeMessageTemplate;
+    }
+
     /// <summary>
     ///     Allows configuring "InsertManyOptions" in MongoDb.
     /// </summary>