Merge branch 'dev' of https://github.com/datalust/serilog-sinks-seq into default-unnest

Author: nblumhardt

README.md

@@ -5,7 +5,7 @@ A Serilog sink that writes events to the [Seq](https://datalust.co/seq) structur
 [<img alt="Package Logo" src="https://datalust.co/images/seq-nuget.png" width="128px">](https://nuget.org/packages/serilog.sinks.seq)
 
 > [!TIP]
-> If you would like to see timing and dependency information in Seq, [SerilogTracing](https://github.com/serilog-tracing/serilog-tracing) is a Serilog extension that supports both logs and traces.
+> If you would like to see timing and dependency information in Seq, [SerilogTracing](https://github.com/serilog-tracing/serilog-tracing) is a Serilog extension that can send both logs and traces through this sink.
 
 
 ### Getting started

src/Serilog.Sinks.Seq/Sinks/Seq/Durable/BookmarkFile.cs

@@ -24,6 +24,12 @@ sealed class BookmarkFile : IDisposable
 
     public BookmarkFile(string bookmarkFilename)
     {
+        var directory = Path.GetDirectoryName(bookmarkFilename);
+        if (!string.IsNullOrWhiteSpace(directory) && !Directory.Exists(directory))
+        {
+            Directory.CreateDirectory(directory);
+        }
+        
         _bookmark = System.IO.File.Open(bookmarkFilename, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.Read);
     }
 

src/Serilog.Sinks.Seq/Sinks/Seq/Formatting/CleanMessageTemplateFormatter.cs

@@ -22,8 +22,6 @@
 using Serilog.Formatting.Json;
 using Serilog.Parsing;
 using Serilog.Sinks.Seq.Conventions;
-using Serilog.Sinks.Seq.Formatting;
-
 // ReSharper disable MemberCanBePrivate.Global
 // ReSharper disable PossibleMultipleEnumeration
 
@@ -36,82 +34,43 @@ namespace Serilog.Sinks.Seq;
 /// implicit SerilogTracing span support.</remarks>
 public sealed class SeqCompactJsonFormatter: ITextFormatter
 {
-    static readonly IDottedPropertyNameConvention DefaultDottedPropertyNameConvention =
-        new UnflattenDottedPropertyNames();
-    
-    readonly JsonValueFormatter _valueFormatter = new("$type");
+    readonly JsonValueFormatter _valueFormatter;
     readonly IFormatProvider _formatProvider;
     readonly IDottedPropertyNameConvention _dottedPropertyNameConvention;
 
     /// <summary>
-    /// Create a <see cref="SeqCompactJsonFormatter"/>.
-    /// </summary>
-    /// <param name="formatProvider">An <see cref="IFormatProvider"/> that will be used to render log event tokens.</param>
-    public SeqCompactJsonFormatter(IFormatProvider? formatProvider = null)
-        : this(formatProvider, false)
-    {
-    }
-
-    /// <summary>
-    /// Create a <see cref="SeqCompactJsonFormatter"/>.
+    /// Construct a <see cref="SeqCompactJsonFormatter"/>.
     /// </summary>
+    /// <param name="valueFormatter">A value formatter for <see cref="LogEventPropertyValue"/>s on the event.</param>
     /// <param name="formatProvider">An <see cref="IFormatProvider"/> that will be used to render log event tokens.</param>
     /// <param name="preserveDottedPropertyNames">If <c langword="true"/>, log event property names that
     /// contain <c>.</c> will be sent to Seq as-is. Otherwise, properties with dotted names will be converted
     /// into nested objects.</param>
-    public SeqCompactJsonFormatter(IFormatProvider? formatProvider, bool preserveDottedPropertyNames)
+    public SeqCompactJsonFormatter(IFormatProvider? formatProvider = null, JsonValueFormatter? valueFormatter = null, bool preserveDottedPropertyNames = false)
     {
         _formatProvider = formatProvider ?? CultureInfo.InvariantCulture;
+        _valueFormatter = valueFormatter ?? new("$type");
         _dottedPropertyNameConvention = preserveDottedPropertyNames
             ? new PreserveDottedPropertyNames()
             : new UnflattenDottedPropertyNames();
     }
 
     /// <summary>
-    /// Format the log event into the output. Subsequent events will be newline-delimited.
+    /// Format the log event into the output. Successive events will be newline-delimited.
     /// </summary>
     /// <param name="logEvent">The event to format.</param>
     /// <param name="output">The output.</param>
     public void Format(LogEvent logEvent, TextWriter output)
-    {
-        FormatEvent(logEvent, output, _valueFormatter, _formatProvider, _dottedPropertyNameConvention);
-        output.WriteLine();
-    }
-
-    /// <summary>
-    /// Format the log event into the output.
-    /// </summary>
-    /// <param name="logEvent">The event to format.</param>
-    /// <param name="output">The output.</param>
-    /// <param name="valueFormatter">A value formatter for <see cref="LogEventPropertyValue"/>s on the event.</param>
-    /// <param name="formatProvider">An <see cref="IFormatProvider"/> that will be used to render log event tokens.</param>
-    public static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFormatter valueFormatter, IFormatProvider formatProvider)
-    {
-        FormatEvent(logEvent, output, valueFormatter, formatProvider, DefaultDottedPropertyNameConvention);
-    }
-
-    static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFormatter valueFormatter, IFormatProvider formatProvider, IDottedPropertyNameConvention dottedPropertyNameConvention)
     {
         if (logEvent == null) throw new ArgumentNullException(nameof(logEvent));
         if (output == null) throw new ArgumentNullException(nameof(output));
-        if (valueFormatter == null) throw new ArgumentNullException(nameof(valueFormatter));
 
         output.Write("{\"@t\":\"");
         output.Write(logEvent.Timestamp.UtcDateTime.ToString("O"));
 
         output.Write("\",\"@mt\":");
         JsonValueFormatter.WriteQuotedJsonString(logEvent.MessageTemplate.Text, output);
 
-        if (!formatProvider.Equals(CultureInfo.InvariantCulture))
-        {
-            // `@m` is normally created during ingestion, however, it must be sent from the client 
-            // to honour non-default IFormatProviders
-            output.Write(",\"@m\":");
-            JsonValueFormatter.WriteQuotedJsonString(
-                CleanMessageTemplateFormatter.Format(logEvent.MessageTemplate, logEvent.Properties, formatProvider),
-                output);
-        }
-
         var tokensWithFormat = logEvent.MessageTemplate.Tokens
             .OfType<PropertyToken>()
             .Where(pt => pt.Format != null);
@@ -127,9 +86,10 @@ static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFormatter
                 output.Write(delim);
                 delim = ",";
                 var space = new StringWriter();
-                r.Render(logEvent.Properties, space, formatProvider);
+                r.Render(logEvent.Properties, space, _formatProvider);
                 JsonValueFormatter.WriteQuotedJsonString(space.ToString(), output);
             }
+
             output.Write(']');
         }
 
@@ -189,7 +149,7 @@ static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFormatter
             }
         }
 
-        var properties = dottedPropertyNameConvention.ProcessDottedPropertyNames(logEvent.Properties);
+        var properties = _dottedPropertyNameConvention.ProcessDottedPropertyNames(logEvent.Properties);
         foreach (var property in properties)
         {
             var name = property.Key;
@@ -206,9 +166,9 @@ static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFormatter
             output.Write(',');
             JsonValueFormatter.WriteQuotedJsonString(name, output);
             output.Write(':');
-            valueFormatter.Format(property.Value, output);
+            _valueFormatter.Format(property.Value, output);
         }
 
         output.Write('}');
     }
-}
+}

src/Serilog.Sinks.Seq/Sinks/Seq/Formatting/Padding.cs

@@ -0,0 +1,37 @@
+using System;
+using System.IO;
+using System.Net;
+using System.Threading;
+using System.Threading.Tasks;
+using Serilog.Sinks.Seq.Durable;
+using Serilog.Sinks.Seq.Http;
+using Serilog.Sinks.Seq.Tests.Support;
+using Xunit;
+
+namespace Serilog.Sinks.Seq.Tests.Durable;
+
+public class DurableSeqSinkTests
+{
+    [Fact]
+    public void SinkCanBeDisposedCleanlyWhenUnused()
+    {
+        var path = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("n"), "buffer");
+        var sink = new DurableSeqSink(
+            new TestIngestionApi(_ => Task.FromResult(new IngestionResult(true, HttpStatusCode.Accepted, null))),
+            new SeqCompactJsonFormatter(),
+            path,
+            100,
+            TimeSpan.FromSeconds(1),
+            null,
+            null,
+            new ControlledLevelSwitch(),
+            null);
+        
+        // No events written, so files/paths should not exist;
+        Assert.False(Directory.Exists(path));
+
+        using var collector = new SelfLogCollector();
+        sink.Dispose();
+        Assert.Empty(collector.Messages);
+    }
+}