SerilogTracing.Sinks.OpenTelemetry 1.0.0-dev-00077

Suggested Alternatives

Serilog.Sinks.OpenTelemetry

Additional Details

The functionality provided by this sink is now natively supported by Serilog.Sinks.OpenTelemetry.

This is a prerelease version of SerilogTracing.Sinks.OpenTelemetry.
There is a newer version of this package available.
See the version list below for details.
dotnet add package SerilogTracing.Sinks.OpenTelemetry --version 1.0.0-dev-00077
                    
NuGet\Install-Package SerilogTracing.Sinks.OpenTelemetry -Version 1.0.0-dev-00077
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SerilogTracing.Sinks.OpenTelemetry" Version="1.0.0-dev-00077" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SerilogTracing.Sinks.OpenTelemetry" Version="1.0.0-dev-00077" />
                    
Directory.Packages.props
<PackageReference Include="SerilogTracing.Sinks.OpenTelemetry" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SerilogTracing.Sinks.OpenTelemetry --version 1.0.0-dev-00077
                    
#r "nuget: SerilogTracing.Sinks.OpenTelemetry, 1.0.0-dev-00077"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package SerilogTracing.Sinks.OpenTelemetry@1.0.0-dev-00077
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SerilogTracing.Sinks.OpenTelemetry&version=1.0.0-dev-00077&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=SerilogTracing.Sinks.OpenTelemetry&version=1.0.0-dev-00077&prerelease
                    
Install as a Cake Tool

SerilogTracing

An experimental Serilog extension for producing and capturing hierarchical traces.

What is SerilogTracing?

SerilogTracing integrates Serilog with the System.Diagnostics.Activity* types provided by the .NET BCL. This makes it possible to:

  1. Record traces generated by .NET system libraries and packages through any Serilog sink,
  2. Generate rich traces using Serilog APIs and idioms, that can still be observed by other consumers of the .NET APIs,
  3. Introduce tracing gradually into applications already instrumented with Serilog.

Wt development time, routing trace information through Serilog means that all of the beautiful, developer-friendly Serilog outputs can be used for simple local feedback.

Here's what that looks like, routed through Serilog's console sink:

A screenshot of Windows Terminal showing output from the included Example application.

The example is using Serilog's ExpressionTemplate to annotate each span in the trace with timing information. The layout is fully configurable - check out Program.cs in the included example project - so let your ASCII artistry run wild!

In production, Serilog's existing configuration, enrichment, filtering, formatting, and output facilities can potentially provide a flexible mechanism for emitting trace data to a wide range of targets.

Notably, any system that accepts traces in text or JSON format should be an easy target for SerilogTracing and a Serilog sink; here's Seq showing traces delivered using the production Serilog.Sinks.Seq package and a custom ITextFormatter implemented with ExpressionTemplate:

A screenshot of Seq showing output from the included Example application.

How does it work?

And what do we mean by "tracing"?

A trace is just a collection of spans, and a span is just an event that carries a:

  • trace id,
  • span id,
  • parent span id (optional), and
  • start time.

SerilogTracing generates spans using extension methods on ILogger:

using var activity = logger.StartActivity("Compute {A} + {B}", a, b);
// ... on `Dispose()` the activity will be recorded as a span

The spans generated by SerilogTracing are converted into Serilog LogEvents and routed through the logger. There's nothing particularly special about these events, except that they add the ParentSpanId and SpanStartTimestamp properties.

SerilogTracing relies on the underlying .NET tracing infrastructure to propagate trace ids and record the parent-child relationships between spans.

The TracingConfiguration class from SerilogTracing is used for this:

Log.Logger = new LoggerConfiguration()
    ... // Other configuration as usual, then:
    .CreateLogger();

// Tracing will be enabled until the returned handle is disposed.
using var _ = new TracingConfiguration()
    .EnableTracing();

In addition to generating spans, SerilogTracing consumes spans generated elsewhere in an application via the System.Diagnostics.Activity APIs, such as those produced by ASP.NET Core or HttpClient. Activity sources can be enabled or disabled using the logger's MinimumLevel.Override settings.

Finally, SerilogTracing includes some examples showing how the resulting LogEvents can be formatted for various trace-aware outputs.

Starting, enriching, and completing activities

Activities are represented by LoggerActivity instances.

LoggerActivity has a simple lifetime:

  • The activity is started using one of the ILogger.StartActivity() extensions,
  • Properties are added to the activity using LoggerActivity.AddProperty(), and
  • The activity is completed either implicitly, by IDisposable.Dispose(), or explicitly using LoggerActivity.Complete().

LoggerActivity.Complete() accepts optional LogEventLevel and Exception arguments.

Displaying output

Use the formatters provides by Serilog.Tracing.Formatting.DefaultFormatting to pretty-print spans as text, or serialize to JSON.

Configuring the activity listener

Activity sources can be enabled and disabled using the standard MinimumLevel.Override() mechanism.

SerilogTracing.Sinks.OpenTelemetry

SerilogTracing includes a fork of Serilog.Sinks.OpenTelemetry. This is necessary (for now) because Serilog.Sinks.OpenTelemetry only handles log signals. SerilogTrace.Sinks.OpenTelemetry also handles trace signals.

What about SerilogTimings?

SerilogTracing is the logical successor to SerilogTimings, which provides very similar functionality.

Like SerilogTimings, SerilogTracing can track the duration and status of an operation, and emit an event when the operation completes.

Unlike SerilogTimings, SerilogTracing:

  • can represent and capture hierarchical (parent/child) operations,
  • takes part in distributed traces, and
  • integrates with the tracing support provided by .NET itself and the rest of the package ecosystem.

Status

This project is experimental. It's not a part of Serilog, not maintained by the Serilog maintainers, and might not evolve in any particular way: there's currently no plan to integrate this functionality directly into Serilog. (Having said that, this project is a vehicle to explore those possibilities).

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.2.0 17,621 10/14/2024 2.2.0 is deprecated because it is no longer maintained.
2.2.0-dev-00353 135 10/10/2024 2.2.0-dev-00353 is deprecated because it is no longer maintained.
2.2.0-dev-00352 130 10/10/2024 2.2.0-dev-00352 is deprecated because it is no longer maintained.
2.1.3-dev-00351 128 10/10/2024 2.1.3-dev-00351 is deprecated because it is no longer maintained.
2.1.2 551 10/8/2024 2.1.2 is deprecated because it is no longer maintained.
2.1.2-dev-00345 144 10/8/2024 2.1.2-dev-00345 is deprecated because it is no longer maintained.
2.1.2-dev-00344 140 10/8/2024 2.1.2-dev-00344 is deprecated because it is no longer maintained.
2.1.2-dev-00342 136 10/8/2024 2.1.2-dev-00342 is deprecated because it is no longer maintained.
2.1.2-dev-00339 128 10/4/2024 2.1.2-dev-00339 is deprecated because it is no longer maintained.
2.1.2-dev-00336 148 10/2/2024 2.1.2-dev-00336 is deprecated because it is no longer maintained.
2.1.1 693 10/2/2024 2.1.1 is deprecated because it is no longer maintained.
2.1.1-dev-00332 139 10/2/2024 2.1.1-dev-00332 is deprecated because it is no longer maintained.
2.1.1-dev-00331 135 10/2/2024 2.1.1-dev-00331 is deprecated because it is no longer maintained.
2.1.1-dev-00324 148 7/29/2024 2.1.1-dev-00324 is deprecated because it is no longer maintained.
2.1.0 18,312 7/29/2024 2.1.0 is deprecated because it is no longer maintained.
2.1.0-dev-00322 133 7/29/2024 2.1.0-dev-00322 is deprecated because it is no longer maintained.
2.1.0-dev-00321 128 7/29/2024 2.1.0-dev-00321 is deprecated because it is no longer maintained.
2.1.0-dev-00320 128 7/29/2024 2.1.0-dev-00320 is deprecated because it is no longer maintained.
2.1.0-dev-00319 127 7/29/2024 2.1.0-dev-00319 is deprecated because it is no longer maintained.
2.1.0-dev-00317 141 7/24/2024 2.1.0-dev-00317 is deprecated because it is no longer maintained.
2.1.0-dev-00313 180 7/22/2024 2.1.0-dev-00313 is deprecated because it is no longer maintained.
2.0.1-dev-00312 137 7/22/2024 2.0.1-dev-00312 is deprecated because it is no longer maintained.
2.0.0 4,709 6/4/2024 2.0.0 is deprecated because it is no longer maintained.
2.0.0-dev-00306 152 6/3/2024 2.0.0-dev-00306 is deprecated because it is no longer maintained.
2.0.0-dev-00305 147 6/3/2024 2.0.0-dev-00305 is deprecated because it is no longer maintained.
2.0.0-dev-00304 149 6/1/2024 2.0.0-dev-00304 is deprecated because it is no longer maintained.
2.0.0-dev-00303 147 6/1/2024 2.0.0-dev-00303 is deprecated because it is no longer maintained.
1.1.0 1,467 5/2/2024 1.1.0 is deprecated because it is no longer maintained.
1.1.0-dev-00298 153 5/24/2024 1.1.0-dev-00298 is deprecated because it is no longer maintained.
1.1.0-dev-00297 151 5/24/2024 1.1.0-dev-00297 is deprecated because it is no longer maintained.
1.1.0-dev-00296 148 5/24/2024 1.1.0-dev-00296 is deprecated because it is no longer maintained.
1.1.0-dev-00295 148 5/16/2024 1.1.0-dev-00295 is deprecated because it is no longer maintained.
1.1.0-dev-00292 169 5/10/2024 1.1.0-dev-00292 is deprecated because it is no longer maintained.
1.1.0-dev-00287 150 5/1/2024 1.1.0-dev-00287 is deprecated because it is no longer maintained.
1.1.0-dev-00286 147 5/1/2024 1.1.0-dev-00286 is deprecated because it is no longer maintained.
1.1.0-dev-00283 163 4/30/2024 1.1.0-dev-00283 is deprecated because it is no longer maintained.
1.1.0-dev-00282 156 4/30/2024 1.1.0-dev-00282 is deprecated because it is no longer maintained.
1.0.1 3,968 4/18/2024 1.0.1 is deprecated because it is no longer maintained.
1.0.1-dev-00280 152 4/30/2024 1.0.1-dev-00280 is deprecated because it is no longer maintained.
1.0.1-dev-00276 152 4/18/2024 1.0.1-dev-00276 is deprecated because it is no longer maintained.
1.0.1-dev-00275 146 4/18/2024 1.0.1-dev-00275 is deprecated because it is no longer maintained.
1.0.1-dev-00273 15,328 3/26/2024 1.0.1-dev-00273 is deprecated because it is no longer maintained.
1.0.1-dev-00267 159 3/11/2024 1.0.1-dev-00267 is deprecated because it is no longer maintained.
1.0.1-dev-00266 157 3/11/2024 1.0.1-dev-00266 is deprecated because it is no longer maintained.
1.0.1-dev-00264 164 3/10/2024 1.0.1-dev-00264 is deprecated because it is no longer maintained.
1.0.1-dev-00261 152 3/5/2024 1.0.1-dev-00261 is deprecated because it is no longer maintained.
1.0.0 8,200 3/3/2024 1.0.0 is deprecated because it is no longer maintained.
1.0.0-dev-00257 165 2/29/2024 1.0.0-dev-00257 is deprecated because it is no longer maintained.
1.0.0-dev-00256 168 2/29/2024 1.0.0-dev-00256 is deprecated because it is no longer maintained.
1.0.0-dev-00251 205 2/27/2024 1.0.0-dev-00251 is deprecated because it is no longer maintained.
1.0.0-dev-00249 160 2/26/2024 1.0.0-dev-00249 is deprecated because it is no longer maintained.
1.0.0-dev-00247 141 2/26/2024 1.0.0-dev-00247 is deprecated because it is no longer maintained.
1.0.0-dev-00246 189 2/24/2024 1.0.0-dev-00246 is deprecated because it is no longer maintained.
1.0.0-dev-00242 156 2/22/2024 1.0.0-dev-00242 is deprecated because it is no longer maintained.
1.0.0-dev-00240 211 2/21/2024 1.0.0-dev-00240 is deprecated because it is no longer maintained.
1.0.0-dev-00236 171 2/21/2024 1.0.0-dev-00236 is deprecated because it is no longer maintained.
1.0.0-dev-00233 832 2/12/2024 1.0.0-dev-00233 is deprecated because it is no longer maintained.
1.0.0-dev-00231 165 2/12/2024 1.0.0-dev-00231 is deprecated because it is no longer maintained.
1.0.0-dev-00229 185 2/12/2024 1.0.0-dev-00229 is deprecated because it is no longer maintained.
1.0.0-dev-00228 161 2/12/2024 1.0.0-dev-00228 is deprecated because it is no longer maintained.
1.0.0-dev-00227 171 2/12/2024 1.0.0-dev-00227 is deprecated because it is no longer maintained.
1.0.0-dev-00225 154 2/12/2024 1.0.0-dev-00225 is deprecated because it is no longer maintained.
1.0.0-dev-00214 168 2/10/2024 1.0.0-dev-00214 is deprecated because it is no longer maintained.
1.0.0-dev-00179 172 2/9/2024 1.0.0-dev-00179 is deprecated because it is no longer maintained.
1.0.0-dev-00167 152 2/8/2024 1.0.0-dev-00167 is deprecated because it is no longer maintained.
1.0.0-dev-00164 169 2/8/2024 1.0.0-dev-00164 is deprecated because it is no longer maintained.
1.0.0-dev-00159 160 2/8/2024 1.0.0-dev-00159 is deprecated because it is no longer maintained.
1.0.0-dev-00155 161 2/7/2024 1.0.0-dev-00155 is deprecated because it is no longer maintained.
1.0.0-dev-00150 151 2/7/2024 1.0.0-dev-00150 is deprecated because it is no longer maintained.
1.0.0-dev-00142 164 2/6/2024 1.0.0-dev-00142 is deprecated because it is no longer maintained.
1.0.0-dev-00138 165 2/6/2024 1.0.0-dev-00138 is deprecated because it is no longer maintained.
1.0.0-dev-00135 155 2/6/2024 1.0.0-dev-00135 is deprecated because it is no longer maintained.
1.0.0-dev-00134 177 2/6/2024 1.0.0-dev-00134 is deprecated because it is no longer maintained.
1.0.0-dev-00132 154 2/5/2024 1.0.0-dev-00132 is deprecated because it is no longer maintained.
1.0.0-dev-00127 171 2/5/2024 1.0.0-dev-00127 is deprecated because it is no longer maintained.
1.0.0-dev-00121 164 2/1/2024 1.0.0-dev-00121 is deprecated because it is no longer maintained.
1.0.0-dev-00118 158 2/1/2024 1.0.0-dev-00118 is deprecated because it is no longer maintained.
1.0.0-dev-00115 136 2/1/2024 1.0.0-dev-00115 is deprecated because it is no longer maintained.
1.0.0-dev-00113 160 2/1/2024 1.0.0-dev-00113 is deprecated because it is no longer maintained.
1.0.0-dev-00107 156 1/31/2024 1.0.0-dev-00107 is deprecated because it is no longer maintained.
1.0.0-dev-00103 169 1/30/2024 1.0.0-dev-00103 is deprecated because it is no longer maintained.
1.0.0-dev-00102 916 1/25/2024 1.0.0-dev-00102 is deprecated because it is no longer maintained.
1.0.0-dev-00100 167 1/24/2024 1.0.0-dev-00100 is deprecated because it is no longer maintained.
1.0.0-dev-00097 171 1/24/2024 1.0.0-dev-00097 is deprecated because it is no longer maintained.
1.0.0-dev-00090 144 1/24/2024 1.0.0-dev-00090 is deprecated because it is no longer maintained.
1.0.0-dev-00088 215 1/22/2024 1.0.0-dev-00088 is deprecated because it is no longer maintained.
1.0.0-dev-00087 154 1/19/2024 1.0.0-dev-00087 is deprecated because it is no longer maintained.
1.0.0-dev-00086 154 1/18/2024 1.0.0-dev-00086 is deprecated because it is no longer maintained.
1.0.0-dev-00082 177 1/17/2024 1.0.0-dev-00082 is deprecated because it is no longer maintained.
1.0.0-dev-00080 143 1/17/2024 1.0.0-dev-00080 is deprecated because it is no longer maintained.
1.0.0-dev-00079 149 1/17/2024 1.0.0-dev-00079 is deprecated because it is no longer maintained.
1.0.0-dev-00077 161 1/17/2024 1.0.0-dev-00077 is deprecated because it is no longer maintained.
1.0.0-dev-00076 157 1/17/2024 1.0.0-dev-00076 is deprecated because it is no longer maintained.