Merge pull request #62 from evilpilaf/nulls

Ignore properties with null values

Author: evilpilaf

.editorconfig

@@ -6,6 +6,7 @@
 [*]
 indent_style = space
 indent_size = 2
+end_of_line = lf
 
 # Code files
 [*.{cs,csx,vb,vbx}]

.gitattributes

@@ -1 +1 @@
-*   text=auto
+*   text  eol=lf

assets/icon124x124.png

@@ -53,8 +53,17 @@ public static void FormatContent(LogEvent logEvent, TextWriter output)
         private static void WriteProperties(IReadOnlyDictionary<string, LogEventPropertyValue> properties, TextWriter output)
         {
             const string precedingDelimiter = ",";
-            foreach (var property in properties)
+            foreach (var property in properties.Where(p => p.Value != null && !string.IsNullOrWhiteSpace(p.Value.ToString())))
             {
+                // Skip properties with empty values
+                if (property.Value is ScalarValue v)
+                {
+                    if (v.Value == null || v.Value.ToString().Equals(""))
+                    {
+                        continue;
+                    }
+                }
+
                 output.Write(precedingDelimiter);
 
                 JsonValueFormatter.WriteQuotedJsonString(property.Key, output);

src/Honeycomb.Serilog.Sink/Formatters/RawJsonFormatter.cs

@@ -57,7 +57,9 @@ public async Task EmitBatchAsync(IEnumerable<LogEvent> events)
             await SendBatchedEvents(writer!.ToString()).ConfigureAwait(false);
         }
 
+        // ReSharper disable UnusedMember.Local
         private async Task SendBatchedEvents(Stream events)
+            // ReSharper restore UnusedMember.Local
         {
             using var requestMessage = new HttpRequestMessage(HttpMethod.Post, string.Format(HoneycombBatchEndpointTemplate, _teamId))
             {

src/Honeycomb.Serilog.Sink/HoneycombSerilogSink.cs

@@ -13,7 +13,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.0.1">
+    <PackageReference Include="coverlet.collector" Version="3.0.2">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

test/Honeycomb.Serilog.Sink.Tests/Honeycomb.Serilog.Sink.Tests.csproj

@@ -12,7 +12,6 @@
 
 using Serilog.Events;
 using Serilog.Parsing;
-using Serilog.Sinks.PeriodicBatching;
 
 using Xunit;
 
@@ -186,6 +185,45 @@ public async Task Emit_GivenAMessageWithProperties_SendsThemAllAsync()
             }
         }
 
+        [Theory]
+        [InlineData("")]
+        [InlineData(null)]
+        public async Task Emit_GivenAMessageWithEmptyPropertyValue_SkipsSendingProperty(string property)
+        {
+            const string dataset = nameof(dataset);
+            const string apiKey = nameof(apiKey);
+
+            HttpClientStub clientStub = A.HttpClient();
+
+            var sut = CreateSut(dataset, apiKey, clientStub);
+
+            var level = LogEventLevel.Fatal;
+
+            var messageTemplateString = $"Testing message property {{{nameof(property)}}}";
+
+            var eventToSend = Some.LogEvent(level, messageTemplateString, property);
+
+            await sut.EmitTestable(eventToSend);
+
+            var requestContent = clientStub.RequestContent;
+            using (var document = JsonDocument.Parse(requestContent))
+            using (new AssertionScope())
+            {
+                document.RootElement.ValueKind.Should().Be(JsonValueKind.Array);
+                document.RootElement.GetArrayLength().Should().Be(1);
+                JsonElement sentEvent = document.RootElement.EnumerateArray().Single();
+
+                sentEvent.GetProperty("time").GetDateTimeOffset().Should().Be(eventToSend.Timestamp);
+                sentEvent.GetProperty("data").ValueKind.Should().Be(JsonValueKind.Object);
+
+                JsonElement data = sentEvent.GetProperty("data");
+
+                var exists = data.TryGetProperty(nameof(property), out _);
+
+                exists.Should().BeFalse();
+            }
+        }
+
         private HoneycombSerilogSinkStub CreateSut(string dataset, string apiKey, HttpClient client = null)
         {
             return new HoneycombSerilogSinkStub(client, dataset, apiKey);