Merge pull request #56 from serilog/sp-tr

Include Serilog 3.1 trace and span ids in output

Author: nblumhardt

src/Serilog.Formatting.Compact/serilog-extension-nuget.png renamed to assets/serilog-extension-nuget.png

@@ -19,6 +19,7 @@
 using Serilog.Events;
 using Serilog.Formatting.Json;
 using Serilog.Parsing;
+// ReSharper disable MemberCanBePrivate.Global
 
 namespace Serilog.Formatting.Compact
 {
@@ -101,6 +102,20 @@ public static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFo
                 JsonValueFormatter.WriteQuotedJsonString(logEvent.Exception.ToString(), output);
             }
 
+            if (logEvent.TraceId != null)
+            {
+                output.Write(",\"@tr\":\"");
+                output.Write(logEvent.TraceId.Value.ToHexString());
+                output.Write('\"');
+            }
+
+            if (logEvent.SpanId != null)
+            {
+                output.Write(",\"@sp\":\"");
+                output.Write(logEvent.SpanId.Value.ToHexString());
+                output.Write('\"');
+            }
+
             foreach (var property in logEvent.Properties)
             {
                 var name = property.Key;

src/Serilog.Formatting.Compact/Formatting/Compact/CompactJsonFormatter.cs

@@ -17,6 +17,7 @@
 using System.IO;
 using Serilog.Events;
 using Serilog.Formatting.Json;
+// ReSharper disable MemberCanBePrivate.Global
 
 namespace Serilog.Formatting.Compact
 {
@@ -83,7 +84,21 @@ public static void FormatEvent(LogEvent logEvent, TextWriter output, JsonValueFo
                 output.Write(",\"@x\":");
                 JsonValueFormatter.WriteQuotedJsonString(logEvent.Exception.ToString(), output);
             }
+            
+            if (logEvent.TraceId != null)
+            {
+                output.Write(",\"@tr\":\"");
+                output.Write(logEvent.TraceId.Value.ToHexString());
+                output.Write('\"');
+            }
 
+            if (logEvent.SpanId != null)
+            {
+                output.Write(",\"@sp\":\"");
+                output.Write(logEvent.SpanId.Value.ToHexString());
+                output.Write('\"');
+            }
+            
             foreach (var property in logEvent.Properties)
             {
                 var name = property.Key;

src/Serilog.Formatting.Compact/Formatting/Compact/RenderedCompactJsonFormatter.cs

@@ -19,15 +19,18 @@
         <RepositoryUrl>https://github.com/serilog/serilog-formatting-compact</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
         <AnalysisLevel>6.0-recommended</AnalysisLevel>
+        <RootNamespace>Serilog</RootNamespace>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
         <WarningLevel>5</WarningLevel>
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Serilog" Version="3.0.1" />
-        <None Include="serilog-extension-nuget.png" Pack="True" Visible="False" PackagePath="" />
+        <PackageReference Include="Serilog" Version="3.1.0-*" />
+        <None Include="../../assets/serilog-extension-nuget.png" Pack="True" Visible="False" PackagePath="" />
+        <None Include="../../README.md" Pack="True" Visible="False" PackagePath="" />
     </ItemGroup>
 
 </Project>

src/Serilog.Formatting.Compact/Serilog.Formatting.Compact.csproj

@@ -1,7 +1,11 @@
 using System;
+using System.Diagnostics;
+using System.Linq;
 using Newtonsoft.Json.Linq;
+using Serilog.Events;
 using Xunit;
 using Serilog.Formatting.Compact.Tests.Support;
+using Serilog.Parsing;
 
 
 namespace Serilog.Formatting.Compact.Tests
@@ -77,5 +81,18 @@ public void TimestampIsUtc()
             Assert.True(jobject.TryGetValue("@t", out val));
             Assert.EndsWith("Z", val.ToObject<string>());
         }
+
+        [Fact]
+        public void TraceAndSpanIdsGenerateValidJson()
+        {
+            var traceId = ActivityTraceId.CreateRandom();
+            var spanId = ActivitySpanId.CreateRandom();
+            var evt = new LogEvent(DateTimeOffset.Now, LogEventLevel.Information, null,
+                new MessageTemplate(Enumerable.Empty<MessageTemplateToken>()), Enumerable.Empty<LogEventProperty>(),
+                traceId, spanId);
+            var json = AssertValidJson(log => log.Write(evt));
+            Assert.Equal(traceId.ToHexString(), json["@tr"]);
+            Assert.Equal(spanId.ToHexString(), json["@sp"]);
+        }
     }
 }