Serilog.Sinks.OpenTelemetrySdk 1.0.0-dev-02305

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
This is a prerelease version of Serilog.Sinks.OpenTelemetrySdk. 
dotnet add package Serilog.Sinks.OpenTelemetrySdk --version 1.0.0-dev-02305
                    


                    

                
NuGet\Install-Package Serilog.Sinks.OpenTelemetrySdk -Version 1.0.0-dev-02305
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="Serilog.Sinks.OpenTelemetrySdk" Version="1.0.0-dev-02305" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Serilog.Sinks.OpenTelemetrySdk" Version="1.0.0-dev-02305" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Serilog.Sinks.OpenTelemetrySdk" />
                    


                            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 Serilog.Sinks.OpenTelemetrySdk --version 1.0.0-dev-02305
                    


                    

                
#r "nuget: Serilog.Sinks.OpenTelemetrySdk, 1.0.0-dev-02305"
#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. 
#addin nuget:?package=Serilog.Sinks.OpenTelemetrySdk&version=1.0.0-dev-02305&prerelease
                    


                            Install Serilog.Sinks.OpenTelemetrySdk as a Cake Addin
                        

                    

                
#tool nuget:?package=Serilog.Sinks.OpenTelemetrySdk&version=1.0.0-dev-02305&prerelease
                    


                            Install Serilog.Sinks.OpenTelemetrySdk as a Cake Tool

Serilog.Sinks.OpenTelemetrySdk Build status NuGet Version

This Serilog sink passes Serilog LogEvents to the OpenTelemetry SDK.

This package relies on experimental OpenTelemetry features. It will only work with pre-release builds of the .NET OpenTelemetry SDK. Because there's no guarantee that these experimental features will ever ship as stable APIs, there's also no guarantee that a stable version of this sink will ever be available.

Getting started

To use this sink, you should already have a pre-release (-beta or -rc) version of the OpenTeleme~~~~try SDK installed and configured.

Install the NuGet package:

dotnet add package Serilog.Sinks.OpenTelemetrySdk

Then enable the sink using WriteTo.OpenTelemetrySdk(), passing your application's IServiceProvider:

// var app = ...

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetrySdk(app.Services)
    .CreateLogger();

Logs written with Log.Information(...) and similar methods will be output by the configured OpenTelemetry exporters.

Serilog LogEvent to OpenTelemetry log record mapping

The following table provides the mapping between the Serilog log events and the OpenTelemetry log records.

Serilog LogEvent OpenTelemetry LogRecord Comments
Exception.GetType().ToString() Attributes["exception.type"]
Exception.Message Attributes["exception.message"] Ignored if empty
Exception.StackTrace Attributes[ "exception.stacktrace"] Value of ex.ToString()
Level LogRecordSeverity Serilog levels are mapped to corresponding OpenTelemetry severities
Level.ToString() SeverityText
Message Body Culture-specific formatting can be provided via sink configuration
MessageTemplate Attributes[ "message_template.text"] Requires IncludedData. MessageTemplateText (enabled by default)
MessageTemplate (MD5) Attributes[ "message_template.hash.md5"] Requires IncludedData. MessageTemplateMD5 HashAttribute
Properties Attributes Each property is mapped to an attribute keeping the name; the value's structure is maintained
SpanId (Activity.Current) SpanId Requires IncludedData.SpanIdField (enabled by default)
Timestamp TimeUnixNano .NET provides 100-nanosecond precision
TraceId (Activity.Current) TraceId Requires IncludedData.TraceIdField (enabled by default)

Serialized data is passed using the Dictionary<string, object?> type. Logged arrays are passed as List<object?>.

Configuring included data

This sink supports configuration of how common OpenTelemetry fields are populated from the Serilog LogEvent by passing includedData:

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetrySdk(app.Services, includedData: IncludedData.MessageTemplateTextAttribute)
    .CreateLogger();

Acknowledgements

This sink is a fork of Serilog.Sinks.OpenTelemetry, which sends log events using the OpenTelemetry wire protocol, and does not have a dependency on the OpenTelemetry SDK.

Copyright © Serilog Contributors - Provided under the Apache License, Version 2.0.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  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 is compatible.  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 is compatible.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
1.0.0-dev-02305 159 4/10/2025