Serilog.Sinks.OpenTelemetry 2.0.0-dev-00270

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Serilog.Sinks.OpenTelemetry.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Serilog.Sinks.OpenTelemetry --version 2.0.0-dev-00270
NuGet\Install-Package Serilog.Sinks.OpenTelemetry -Version 2.0.0-dev-00270
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.OpenTelemetry" Version="2.0.0-dev-00270" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.OpenTelemetry --version 2.0.0-dev-00270
#r "nuget: Serilog.Sinks.OpenTelemetry, 2.0.0-dev-00270"
#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.
// Install Serilog.Sinks.OpenTelemetry as a Cake Addin
#addin nuget:?package=Serilog.Sinks.OpenTelemetry&version=2.0.0-dev-00270&prerelease

// Install Serilog.Sinks.OpenTelemetry as a Cake Tool
#tool nuget:?package=Serilog.Sinks.OpenTelemetry&version=2.0.0-dev-00270&prerelease

Serilog.Sinks.OpenTelemetry Build status NuGet Version

This Serilog sink transforms Serilog events into OpenTelemetry LogRecords and sends them to an OTLP (gRPC or HTTP) endpoint.

The sink aims for full compliance with the OpenTelemetry Logs protocol. It does not depend on the OpenTelemetry SDK or .NET API.

OpenTelemetry supports attributes with scalar values, arrays, and maps. Serilog does as well. Consequently, the sink does a one-to-one mapping between Serilog properties and OpenTelemetry attributes. There is no flattening, renaming, or other modifications done to the properties by default.

Getting started

To use the OpenTelemetry sink, first install the NuGet package:

dotnet add package Serilog.Sinks.OpenTelemetry

Then enable the sink using WriteTo.OpenTelemetry():

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetry()
    .CreateLogger();

Generate logs using the Log.Information(...) and similar methods to send transformed logs to a local OpenTelemetry OTLP endpoint.

A more complete configuration would specify Endpoint, Protocol, and other parameters, such asResourceAttributes, as shown in the examples below.

Configuration

This sink supports two configuration styles: inline and options. The inline configuration looks like:

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetry(
        endpoint: "http://127.0.0.1:4318/v1/logs",
        protocol: OtlpProtocol.HttpProtobuf)
    .CreateLogger();

This configuration is appropriate only for simple, local logging setups.

More complicated use cases will need to use the options configuration, which looks like:

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetry(options =>
    {
        options.Endpoint = "http://127.0.0.1:4318/v1/logs";
        options.Protocol = OtlpProtocol.HttpProtobuf;
    })
    .CreateLogger();

This supports the sink's full set of configuration options. See the OpenTelemetrySinkOptions.cs file for the full set of options. Some of the more imporant parameters are discussed in the following sections.

Endpoint and protocol

The default endpoint is http://localhost:4317, which will send logs to an OpenTelemetry collector running on the same machine over the gRPC protocol. This is appropriate for testing or for using a local OpenTelemetry collector as a proxy for a downstream logging service.

In most production scenarios, you will want to set an endpoint. To do so, add the endpoint argument to the WriteTo.OpenTelemetry() call.

You may also want to set the protocol explicitly. The supported values are:

  • OtlpProtocol.Grpc: Sends a protobuf representation of the OpenTelemetry Logs over a gRPC connection (the default).
  • OtlpProtocol.HttpProtobuf: Sends a protobuf representation of the OpenTelemetry Logs over an HTTP connection.

When the OtlpProtocol.HttpProtobuf option is specified, the endpoint URL must include the full path, for example http://localhost:4318/v1/logs.

Resource attributes

OpenTelemetry logs may contain a "resource" that provides metadata concerning the entity associated with the logs, typically a service or library. These may contain "resource attributes" and are emitted for all logs flowing through the configured logger.

These resource attributes may be provided as a Dictionary<string, Object> when configuring a logger. OpenTelemetry allows resource attributes with rich values; however, this implementation only supports resource attributes with primitive values.

⚠️ Resource attributes with non-primitive values will be silently ignored.

This example shows how the resource attributes can be specified when the logger is configured.

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetry(options =>
    {
        options.Endpoint = "http://127.0.0.1:4317";
        options.ResourceAttributes = new Dictionary<string, object>
        {
            ["service.name"] = "test-logging-service",
            ["index"] = 10,
            ["flag"] = true,
            ["value"] = 3.14
        };
    })
    .CreateLogger();

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 SeverityNumber 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.SpanId (enabled by default)
Timestamp TimeUnixNano .NET provides 100-nanosecond precision
TraceId (Activity.Current) TraceId Requires IncludedData.TraceId (enabled by default)

Configuring included data

This sink supports configuration of how common OpenTelemetry fields are populated from the Serilog LogEvent and .NET Activity context via the IncludedData flags enum:

Log.Logger = new LoggerConfiguration()
    .WriteTo.OpenTelemetry(options =>
    {
        options.Endpoint = "http://127.0.0.1:4317";
        options.IncludedData: IncludedData.MessageTemplate |
                              IncludedData.TraceId | IncludedData.SpanId;
    })
    .CreateLogger();

The example shows the default value; IncludedData.MessageTemplateMD5HashAttribute can also be used to add the MD5 hash of the message template.

Example

The example/Example subdirectory contains an example application that logs to a local OpenTelemetry collector. See the README in that directory for instructions on how to run the example.

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 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. 
.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 was computed.  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 (11)

Showing the top 5 NuGet packages that depend on Serilog.Sinks.OpenTelemetry:

Package Downloads
PegasusLoggingService

Package Description

Relativity.Transfer.SDK

Relativity Transfer SDK allows performing high-throughput transfers of files from and to Relativity environment.

Fluxera.Extensions.Hosting.Modules.Serilog The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

A module that enables Serilog logging.

Newguys.Telemetry

Package Description

Aevo.CommonLib

Biblioteca com utilitários comuns para uso na AEVO.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0-dev-00282 13,026 3/18/2024
2.0.0-dev-00270 10,967 1/4/2024
2.0.0-dev-00261 679 1/2/2024
2.0.0-dev-00259 1,457 12/7/2023
1.2.0 389,504 11/15/2023
1.2.0-dev-00255 342 11/15/2023
1.2.0-dev-00253 446 11/9/2023
1.2.0-dev-00247 5,891 10/11/2023
1.2.0-dev-00243 465 10/3/2023
1.1.0 204,184 9/28/2023
1.1.0-dev-00239 427 9/28/2023
1.1.0-dev-00236 718 9/18/2023
1.0.3-dev-00230 4,424 8/24/2023
1.0.2 217,206 7/11/2023
1.0.2-dev-00227 588 7/10/2023
1.0.1 38,319 7/7/2023
1.0.1-dev-00223 574 7/7/2023
1.0.1-dev-00222 578 7/7/2023
1.0.1-dev-00218 5,090 6/13/2023
1.0.0 137,141 6/1/2023
1.0.0-dev-00214 1,507 5/30/2023
1.0.0-dev-00212 916 5/29/2023
1.0.0-dev-00208 4,423 5/26/2023
1.0.0-dev-00204 5,988 5/18/2023
1.0.0-dev-00202 1,556 5/17/2023
1.0.0-dev-00200 588 5/17/2023
1.0.0-dev-00194 799 5/15/2023
1.0.0-dev-00192 577 5/15/2023
1.0.0-dev-00188 2,207 5/5/2023
1.0.0-dev-00182 74 5/5/2023
1.0.0-dev-00178 502 5/4/2023
1.0.0-dev-00175 1,161 5/3/2023
1.0.0-dev-00173 1,741 5/2/2023
1.0.0-dev-00166 2,121 5/1/2023
1.0.0-dev-00161 85 4/30/2023
1.0.0-dev-00152 127 4/29/2023
1.0.0-dev-00151 238 4/29/2023
1.0.0-dev-00148 85 4/29/2023
1.0.0-dev-00143 3,611 4/24/2023
1.0.0-dev-00142 84 4/24/2023
1.0.0-dev-00141 86 4/24/2023
1.0.0-dev-00129 524 4/19/2023
1.0.0-dev-00128 111 4/19/2023
1.0.0-dev-00121 611 4/14/2023
1.0.0-dev-00120 234 4/14/2023
1.0.0-dev-00117 211 4/12/2023
1.0.0-dev-00113 40,147 3/14/2023
1.0.0-dev-00098 26,346 2/12/2023
1.0.0-dev-00091 110 2/12/2023
1.0.0-dev-00080 100 2/10/2023
0.5.0-dev-00078 1,343 2/9/2023
0.4.0-dev-00073 22,208 2/3/2023
0.2.0-dev-00063 7,115 1/23/2023
0.2.0-dev-00059 205 1/10/2023
0.1.0-dev-00048 100 1/10/2023
0.0.4-dev-00039 15,110 1/9/2023
0.0.3-dev-00036 106 1/9/2023
0.0.2-dev-00027 111 1/7/2023
0.0.1-dev-00018 104 1/4/2023
0.0.1-dev-00015 102 1/3/2023
0.0.1-dev-00013 104 1/3/2023