👁 Image
Serilog.Sinks.Grafana.Loki 9.0.0

Serilog.Sinks.Grafana.Loki

👁 Made in Ukraine
👁 Build status
👁 NuGet version
👁 Latest release
👁 Documentation

Terms of use

By using this project or its source code, for any purpose and in any shape or form, you grant your **implicit agreement ** to all the following statements:

• You condemn Russia and its military aggression against Ukraine
• You recognize that Russia is an occupant that unlawfully invaded a sovereign state
• You support Ukraine's territorial integrity, including its claims over temporarily occupied territories of Crimea and Donbas
• You reject false narratives perpetuated by Russian state propaganda

Glory to Ukraine! 🇺🇦

Table of contents

• What is this sink and Loki?
• What's new in V9
• Requirements
• Features
• Quickstart
• Configuration reference
• Labels
• Authentication and multi-tenancy
• Custom HttpClient
• Trace and span context
• Structured metadata
• JSON formatting and custom formatters
• Batching and delivery
• Migrating from V8
• Samples
• Inspiration and Credits

<a id="what-is-this"></a>What is this sink and Loki?

The Serilog Grafana Loki sink project is a sink (basically a writer) for the Serilog logging framework. Structured log events are written to sinks and each sink is responsible for writing it to its own backend, database, store etc. This sink delivers the data to Grafana Loki, a horizontally-scalable, highly-available, multi-tenant log aggregation system. It allows you to use Grafana for visualizing your logs.

You can find more information about what Loki is over on Grafana's website here.

<a id="whats-new-in-v9"></a>What's new in V9

V9 is a ground-up rewrite of the sink in F#, keeping a public API that remains idiomatic to call from C#. The rewrite fixes a class of long-standing structural bugs and modernizes the delivery pipeline:

• Built on Serilog 4.x native batching. The custom queue/timer/backoff stack is gone. Delivery now uses Serilog's IBatchedLogEventSink, giving a bounded queue by default (50 000 events), async emission, and retry with exponential backoff — no more dropped batches on failure and no dispose-time deadlocks.
• Immutable log-event pipeline. Labels are derived from a read-only view of the event. Properties promoted to labels now also remain in the log body, and the message template is never corrupted on retry.
• Streaming serialization. Payloads are written in a single forward pass with Utf8JsonWriter over pooled buffers — no intermediate object graph and no intermediate strings.
• Bring-your-own HttpClient / HttpMessageHandler. The old ILokiHttpClient/LokiGzipHttpClient hierarchy is replaced by direct injection; gzip, retries, mTLS and bearer auth are now standard DelegatingHandler concerns.
• New features: pluggable exception formatter (ILokiExceptionFormatter), TraceId/SpanId routing to the body or Loki structured metadata, startup URI validation, and the log level exposed as a label using Grafana's vocabulary.

See Migrating from V8 for the full list of breaking changes.

<a id="requirements"></a>Requirements

• .NET: net8.0, net9.0, or net10.0 (earlier target frameworks are EOL and no longer supported).
• Serilog: 4.3.1 or later.
• Transitive dependency: FSharp.Core is pulled in automatically. No other sink packages are required.

<a id="features"></a>Features

• Batches and ships structured log events to Loki over its HTTP push API
• Serilog 4.x native batching: bounded in-memory queue, retry with exponential backoff, fully async emission
• Streaming System.Text.Json serialization with pooled buffers (no intermediate object graph or strings)
• Global and property-derived labels with deterministic stream grouping and key sanitisation
• Log level exposed as a label using Grafana's level vocabulary (optional)
• Basic authentication and multi-tenancy (X-Scope-OrgID) support
• Bring-your-own HttpClient / HttpMessageHandler — gzip, retries, mTLS and bearer auth via DelegatingHandler
• TraceId / SpanId from the ambient Activity (OpenTelemetry) — written to the log body or as structured metadata
• Loki structured metadata: per-line, non-indexed key/value pairs, queryable without a parser and without label cardinality cost (Loki 3.0+)
• Pluggable exception formatter and text formatter
• First-class Serilog.Settings.Configuration (appsettings.json) support
• No dependency on any other Serilog sink

<a id="quickstart"></a>Quickstart

The Serilog.Sinks.Grafana.Loki NuGet package can be found here. Install it via one of the following commands:

NuGet command:

Install-Package Serilog.Sinks.Grafana.Loki

.NET CLI:

dotnet add package Serilog.Sinks.Grafana.Loki

In the following example, the sink will send log events to Loki available on http://localhost:3100:

using Serilog;
using Serilog.Sinks.Grafana.Loki;

Log.Logger = new LoggerConfiguration()
 .WriteTo.GrafanaLoki(
 "http://localhost:3100",
 [new LokiLabel { Key = "app", Value = "web_app" }])
 .CreateLogger();

Log.Information("The god of the day is {@God}", odin);

The sink posts to <uri>/loki/api/v1/push. The push path is appended automatically — pass only the base address (a path prefix such as http://gateway/loki is supported and preserved).

Used together with Serilog.Settings.Configuration, the same sink can be configured from appsettings.json:

{
 "Serilog": {
 "Using": [
 "Serilog.Sinks.Grafana.Loki"
 ],
 "MinimumLevel": {
 "Default": "Debug"
 },
 "WriteTo": [
 {
 "Name": "GrafanaLoki",
 "Args": {
 "uri": "http://localhost:3100",
 "labels": [
 {
 "key": "app",
 "value": "web_app"
 }
 ],
 "propertiesAsLabels": [
 "app"
 ]
 }
 }
 ]
 }
}

<a id="configuration-reference"></a>Configuration reference

All options are passed as named arguments to WriteTo.GrafanaLoki(...). Only uri is required.

Note on period / retryTimeLimit: in C# these are TimeSpan? (e.g. period: TimeSpan.FromSeconds(5)); leave them unset to use the defaults. In appsettings.json they are written as "hh:mm:ss" strings (e.g. "00:00:05"), which Serilog.Settings.Configuration converts to TimeSpan.

A more complete C# example:

Log.Logger = new LoggerConfiguration()
 .WriteTo.GrafanaLoki(
 "http://localhost:3100",
 labels: [new LokiLabel { Key = "app", Value = "my-service" }],
 propertiesAsLabels: ["RequestPath"],
 credentials: new LokiCredentials { Login = "user", Password = "pass" },
 tenant: "my-tenant",
 traceIdMode: LokiFieldDestination.StructuredMetadata,
 queueLimit: 100_000,
 period: TimeSpan.FromSeconds(2))
 .CreateLogger();

Configuration details for appsettings.json are also documented in the wiki.

<a id="labels"></a>Labels

Each log event is mapped to a Loki stream identified by its label set. Events that resolve to the same label set are grouped into one stream and ordered by timestamp.

Labels come from three sources, in descending priority:

1. Global labels — from the labels option, attached to every stream.
2. The level label — added when handleLogLevelAsLabel is true (the default).
3. Property-derived labels — from propertiesAsLabels.

When keys collide, a higher-priority source wins; a property is silently skipped if its key matches a global label or the reserved level key. Unlike V8, properties promoted to labels are kept in the log body as well — promotion no longer removes them from the event.

Other rules:

• Key sanitisation: label keys must begin with a letter or underscore. Keys that start with a digit (for example positional template tokens like {0}) are prefixed with param, becoming param0.
• Level vocabulary: Serilog levels map to Grafana's level names — Verbose → trace, Debug → debug, Information → info, Warning → warning, Error → error, Fatal → fatal (previously critical).

<a id="authentication-and-multi-tenancy"></a>Authentication and multi-tenancy

Basic authentication is configured with a credentials object:

.WriteTo.GrafanaLoki(
 "http://localhost:3100",
 credentials: new LokiCredentials { Login = "user", Password = "pass" })

Basic auth is applied only to a client the sink creates. If you inject your own httpClient, configure its Authorization header yourself — the sink never mutates an injected client.

Multi-tenancy is configured with tenant, which sets the X-Scope-OrgID header:

.WriteTo.GrafanaLoki("http://localhost:3100", tenant: "tenant-1")

The tenant ID is validated at configuration time against Loki's tenant ID rules — alphanumerics plus !-_.*'(), at most 150 bytes, and not . or .. — an invalid value throws ArgumentException instead of producing batches Loki would reject.

Bearer tokens / OAuth2 are not a first-class option — add them through the injected client, either by setting a default Authorization header on an HttpClient or via a DelegatingHandler (see below).

<a id="custom-http-client"></a>Custom HttpClient

V9 accepts a standard HttpClient or HttpMessageHandler directly. Inject your own to add gzip compression, retries, mTLS, bearer auth, or any other cross-cutting behaviour:

// GzipHandler.cs
using System.IO.Compression;
using System.Net.Http;
using System.Net.Http.Headers;

public class GzipHandler : DelegatingHandler
{
 public GzipHandler() : base(new HttpClientHandler()) { }

 protected override async Task<HttpResponseMessage> SendAsync(
 HttpRequestMessage request, CancellationToken ct)
 {
 if (request.Content is not null)
 {
 var bytes = await request.Content.ReadAsByteArrayAsync(ct);
 using var ms = new MemoryStream();
 using (var gz = new GZipStream(ms, CompressionLevel.Fastest, leaveOpen: true))
 await gz.WriteAsync(bytes, ct);
 request.Content = new ByteArrayContent(ms.ToArray());
 request.Content.Headers.ContentType =
 new MediaTypeHeaderValue("application/json") { CharSet = "utf-8" };
 request.Content.Headers.ContentEncoding.Add("gzip");
 }
 return await base.SendAsync(request, ct);
 }
}

// Inject via httpMessageHandler — the sink creates and owns the HttpClient
// (and still applies basic auth / tenant headers).
Log.Logger = new LoggerConfiguration()
 .WriteTo.GrafanaLoki(
 "http://localhost:3100",
 httpMessageHandler: new GzipHandler())
 .CreateLogger();

// Or inject a pre-built HttpClient (e.g. from IHttpClientFactory — the sink never disposes it).
var httpClient = httpClientFactory.CreateClient("loki");
Log.Logger = new LoggerConfiguration()
 .WriteTo.GrafanaLoki(
 "http://localhost:3100",
 httpClient: httpClient)
 .CreateLogger();

<a id="trace-and-span-enrichment"></a>Trace and span context

traceIdMode and spanIdMode control where the event's TraceId / SpanId (populated by Serilog 4.x from the ambient Activity) are written. Each takes a LokiFieldDestination:

.WriteTo.GrafanaLoki(
 "http://localhost:3100",
 traceIdMode: LokiFieldDestination.StructuredMetadata,
 spanIdMode: LokiFieldDestination.StructuredMetadata)

From appsettings.json the mode binds from its name: "traceIdMode": "StructuredMetadata".

Trace context is typically populated for you by Serilog.AspNetCore / Serilog.Extensions.Logging; outside those, an active Activity must be present for the IDs to be emitted.

<a id="structured-metadata"></a>Structured metadata

Structured metadata attaches per-line key/value pairs to a log entry without indexing them as labels. Unlike propertiesAsLabels it does not create new streams (no cardinality cost), and unlike a body field it is queryable without a parser stage:

{app="web_app"} | RequestId="abc-123" # structured metadata — no parser needed
{app="web_app"} | json | RequestId="abc-123" # the equivalent for a body field

That makes it the right home for high-cardinality identifiers such as request, user, or trace IDs. Two sources feed it:

• propertiesAsStructuredMetadata — property names to attach as metadata (the property is also kept in the body).
• traceIdMode / spanIdMode set to StructuredMetadata — routes TraceId / SpanId there instead of the body.

.WriteTo.GrafanaLoki(
 "http://localhost:3100",
 propertiesAsStructuredMetadata: ["RequestId", "UserId"],
 traceIdMode: LokiFieldDestination.StructuredMetadata)

It is emitted as the optional third element of each push entry:

"values": [
 [ "1700000000000000000", "{\"Message\":\"...\"}", { "RequestId": "abc-123", "TraceId": "..." } ]
]

Requires Loki 3.0+ (or 2.9 with allow_structured_metadata enabled on a TSDB v13 schema). Against an older Loki, or one with structured metadata disabled, such a push is rejected — leave these options unset (the default) to stay compatible.

For the full picture — the three-tier model (labels vs structured metadata vs body), querying, and Loki configuration — see Structured metadata in the wiki.

<a id="json-formatting"></a>JSON formatting and custom formatters

By default the sink uses LokiJsonTextFormatter, which renders each log entry's body as a JSON object. This makes logs easy to filter in Loki — see Grafana's write-up on querying JSON logs.

The resulting push payload looks like:

{
 "streams": [
 {
 "stream": { "app": "web_app", "level": "info" },
 "values": [
 [ "1700000000000000000", "{\"Message\":\"...\",\"MessageTemplate\":\"...\"}" ]
 ]
 }
 ]
}

Each body object contains Message, MessageTemplate, an optional Exception, the TraceId / SpanId fields (when their mode is Body), and every event property. Property names that collide with these reserved keys (Message, MessageTemplate, Exception, TraceId, SpanId) are prefixed with _.

Custom text formatter. Implement Serilog.Formatting.ITextFormatter, or subclass LokiJsonTextFormatter and override Format or SanitizePropertyName, then pass it via textFormatter:

{
 "Serilog": {
 "WriteTo": [
 {
 "Name": "GrafanaLoki",
 "Args": {
 "uri": "http://localhost:3100",
 "textFormatter": "My.Awesome.Namespace.MyTextFormatter, MyCoolAssembly"
 }
 }
 ]
 }
}

Custom exception formatter. Exception serialization is delegated to ILokiExceptionFormatter. The default (LokiExceptionFormatter) recursively writes Type, Message, Source, StackTrace and inner exceptions. Replace it to scrub PII, change the shape, or suppress stack traces:

using System.Text.Json;
using Serilog.Sinks.Grafana.Loki;

public class CompactExceptionFormatter : ILokiExceptionFormatter
{
 public void Format(Utf8JsonWriter writer, Exception exception)
 {
 writer.WriteStartObject();
 writer.WriteString("type", exception.GetType().Name);
 writer.WriteString("message", exception.Message);
 writer.WriteEndObject();
 }
}

.WriteTo.GrafanaLoki(
 "http://localhost:3100",
 exceptionFormatter: new CompactExceptionFormatter())

<a id="batching-and-delivery"></a>Batching and delivery

Delivery is handled by Serilog 4.x's native batching infrastructure:

• Events are buffered and flushed every period (default 1 s) or once batchSizeLimit (default 1000) is reached.
• The in-memory queue is bounded at queueLimit (default 50 000). When the queue is full, new events are dropped rather than growing memory without limit.
• On a failed POST, the batch is retried with exponential backoff up to retryTimeLimit (default 10 min), after which it is dropped so the pipeline can make progress.
• Emission is fully asynchronous, so disposing the logger (Log.CloseAndFlush()) flushes cleanly without deadlocks.

Delivery problems are reported through Serilog's SelfLog. Enable it during development to see HTTP errors and dropped batches:

Serilog.Debugging.SelfLog.Enable(Console.Error);

<a id="migrating-from-v8"></a>Migrating from V8

V9 is a major release with breaking changes. The highlights:

FSharp.Core becomes a transitive dependency of all consumers.

The full, maintained list of breaking changes lives in the wiki.

<a id="samples"></a>Samples

Runnable examples live in the folder:

• Serilog.Sinks.Grafana.Loki.Sample — a minimal console app.
• Serilog.Sinks.Grafana.Loki.SampleWebApp — an ASP.NET Core app configured from appsettings.json.

<a id="inspiration-and-credits"></a>Inspiration and Credits

• Serilog.Sinks.Loki — the original Serilog Loki sink, which this project was born from and inspired by.
• Serilog.Sinks.Loki.YetAnother — an allocation-conscious Loki sink whose performance findings inspired parts of the V9 optimization work; it also serves as the external yardstick in our .