Serilog.Sinks.OpenTelemetry 1.2.0-dev-00253

Serilog.Sinks.OpenTelemetry

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.

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.