YMJake.Serilog.Sinks.VictoriaLogs 1.0.4

Serilog.Sinks.VictoriaLogs

A Serilog sink that ships log events to VictoriaLogs using the JSON streaming API.

Inspired by serilog-sinks-grafana-loki, it adopts the same proven building blocks: bounded queue, portable timer, exponential backoff, pluggable batch formatter, native HttpClient stack, and an embedded sample API.

Features

• Direct integration with VictoriaLogs insert API via HttpClient.
• Bounded in-memory queue with periodic batching and exponential backoff scheduling.
• Gzip payload support, configurable send buffer, static fields, labels, and stream fields.
• Customisable batch formatter (IVictoriaLogsBatchFormatter) selectable via code or appsettings.
• Swappable HTTP client implementations (UseGzipHttpClient or HttpClientFactory).
• Sample WebAPI (sample/VictoriaLogs.SampleApi) demonstrating configuration and usage.

Getting Started

Add the sink package to your project and configure Serilog:

Log.Logger = new LoggerConfiguration()
    .ReadFrom.Configuration(builder.Configuration)
    .WriteTo.Console()
    .WriteTo.VictoriaLogs(
        endpoint: "http://localhost:9428",
        configure: options =>
        {
            options.StreamFields = new[] { "app" };
            options.Labels.Add(new VictoriaLogsLabel { Key = "app", Value = "victorialogs-demo" });
            options.UseGzipCompression = true;
        })
    .CreateLogger();

Configuration with appsettings.json

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.VictoriaLogs" ],
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "VictoriaLogs",
        "Args": {
          "options": {
            "Endpoint": "http://localhost:9428",
            "UseGzipCompression": true,
            "StreamFields": [ "app" ],
            "Labels": [
              { "Key": "app", "Value": "victorialogs-sample-api" }
            ],
            "BatchFormatterType": "MyNamespace.CustomFormatter, MyAssembly"
          }
        }
      }
    ]
  }
}

If BatchFormatterType is omitted the sink falls back to DefaultVictoriaLogsBatchFormatter. Custom formatters must implement IVictoriaLogsBatchFormatter.

HTTP client options

• UseGzipCompression compresses request bodies sent to VictoriaLogs.
• UseGzipHttpClient uses an HTTP client that automatically decompresses gzip/deflate responses.
• HttpClientFactory provides a custom IVictoriaLogsHttpClient; this takes precedence over other options:

.WriteTo.VictoriaLogs(endpoint: "...", configure: options =>
{
    options.HttpClientFactory = () => new MyCustomVictoriaLogsHttpClient();
});

Sample API

Run the sample WebAPI to see the sink in action:

cd sample/VictoriaLogs.SampleApi
dotnet run

The /logs/test endpoint emits a few log events you can inspect inside VictoriaLogs.

License

This project is licensed under the MIT License.