Serilog.Sinks.PeriodicBatching 4.1.1-dev-00845

Serilog.Sinks.PeriodicBatching Build status NuGet Version

A wrapper for Serilog sinks that asynchronously emits events in batches, useful when logging to a slow and/or remote target.

Getting started

Sinks that, for performance reasons, need to emit events in batches, can be implemented using PeriodicBatchingSink from this package.

First, install the package into your Sink project:

dotnet add package Serilog.Sinks.PeriodicBatching

Then, instead of implementing Serilog's ILogEventSink, implement IBatchedLogEventSink in your sink class:

class ExampleBatchedSink : IBatchedLogEventSink
{
    public async Task EmitBatchAsync(IEnumerable<LogEvent> batch)
    {
        foreach (var logEvent in batch)
            Console.WriteLine(logEvent);
    }
    
    public Task OnEmptyBatchAsync() { }
}

Finally, in your sink's configuration method, construct a PeriodicBatchingSink that wraps your batched sink:

public static class LoggerSinkExampleConfiguration
{
    public static LoggerConfiguration Example(this LoggerSinkConfiguration loggerSinkConfiguration)
    {
        var exampleSink = new ExampleBatchedSink();
        
        var batchingOptions = new PeriodicBatchingSinkOptions
        {
            BatchSizeLimit = 100,
            Period = TimeSpan.FromSeconds(2),
            EagerlyEmitFirstEvent = true,
            QueueLimit = 10000
        };
        
        var batchingSink = new PeriodicBatchingSink(exampleSink, batchingOptions);
        
        return loggerSinkConfiguration.Sink(batchingSink);
    }
}

Showing the top 20 packages that depend on Serilog.Sinks.PeriodicBatching.

Packages Downloads
Serilog.Sinks.Seq
Serilog sink that writes to the Seq log server over HTTP/HTTPS.
145
Serilog.Sinks.Seq
Serilog sink that writes to the Seq log server over HTTP/HTTPS.
102
Serilog.Sinks.Slack
Serilog sink for Slack
80
Serilog.Sinks.Slack
Serilog sink for Slack
60
Serilog.Sinks.Seq
Serilog sink that writes to the Seq log server over HTTP/HTTPS.
48
Serilog.Sinks.Slack
Serilog sink for Slack
24
Serilog.Sinks.Slack
Serilog sink for Slack
23
Serilog.Sinks.Slack
Serilog.Sinks.Slack
18
Serilog.Sinks.Seq
Serilog sink that writes to the Seq log server over HTTP/HTTPS.
16
Serilog.Sinks.Seq
A Serilog sink that writes events to Seq using newline-delimited JSON and HTTP/HTTPS.
16
Serilog.Sinks.Seq
Serilog sink that writes to the Seq log server over HTTP/S.
16
Serilog.Sinks.MSSqlServer
A Serilog sink that writes events to Microsoft SQL Server
16
Serilog.Sinks.MSSqlServer
A Serilog sink that writes events to Microsoft SQL Server and Azure SQL
16
Serilog.Sinks.Slack
Serilog sink for Slack
16
Serilog.Sinks.MSSqlServer
A Serilog sink that writes events to Microsoft SQL Server and Azure SQL
15
Serilog.Sinks.Seq
Serilog sink that writes to the Seq event server over HTTP/S.
15

.NET Framework 4.6.2

.NET 6.0

.NET Standard 2.0

Version Downloads Last updated
5.0.1-dev-00860 16 10/10/2024
5.0.0 16 10/10/2024
5.0.0-dev-00855 11 10/10/2024
4.1.2-dev-00851 18 10/10/2024
4.1.1 12 10/10/2024
4.1.1-dev-00845 15 10/10/2024
4.1.0 15 10/10/2024
4.1.0-dev-00840 16 10/10/2024
4.0.2-dev-00838 10 10/10/2024
4.0.1 15 10/10/2024
4.0.1-dev-00832 16 10/10/2024
4.0.0 15 06/17/2024
4.0.0-dev-00824 13 10/10/2024
4.0.0-dev-00821 16 10/10/2024
3.1.1-dev-00804 17 03/17/2024
3.1.1-dev-00801 15 10/10/2024
3.1.0 19 12/02/2022
3.1.0-dev-00796 13 10/10/2024
3.0.0 16 10/10/2024
3.0.0-dev-00792 14 10/10/2024
2.3.1 97 03/21/2022
2.3.1-dev-00785 13 10/10/2024
2.3.1-dev-00780 15 10/10/2024
2.3.1-dev-00776 15 10/10/2024
2.3.1-dev-00774 16 10/10/2024
2.3.0 223 12/07/2021
2.3.0-dev-00765 15 10/10/2024
2.3.0-dev-00762 13 10/10/2024
2.3.0-dev-00760 15 10/10/2024
2.2.1-dev-00758 15 10/10/2024
2.2.1-dev-00755 17 10/10/2024
2.2.0 15 10/10/2024
2.2.0-dev-00748 13 10/10/2024
2.2.0-dev-00740 10 10/10/2024
2.1.1 15 05/12/2022
2.1.1-dev-00732 11 10/10/2024
2.1.1-dev-00729 13 10/10/2024
2.1.1-dev-00725 15 10/10/2024
2.1.0 12 10/10/2024
2.1.0-dev-00720 12 10/10/2024
2.0.2-dev-00719 14 10/10/2024
2.0.1 12 10/10/2024
2.0.1-dev-00714 13 10/10/2024
2.0.0 14 10/10/2024
2.0.0-rc-707 12 10/10/2024
2.0.0-rc-705 11 10/10/2024
2.0.0-beta-702 12 10/10/2024
2.0.0-beta-700 12 10/10/2024
2.0.0-beta-519 17 10/10/2024
2.0.0-beta-516 18 10/10/2024
2.0.0-beta-513 16 10/06/2024
2.0.0-beta-511 14 10/10/2024
2.0.0-beta-509 15 10/10/2024
2.0.0-beta-507 15 10/10/2024
2.0.0-beta-505 12 10/10/2024
2.0.0-beta-502 15 10/10/2024
2.0.0-beta-499 17 10/10/2024
2.0.0-beta-495 15 10/10/2024
2.0.0-beta-494 14 10/10/2024
2.0.0-beta-493 17 10/10/2024
2.0.0-beta-487 15 10/10/2024
2.0.0-beta-486 12 10/10/2024
2.0.0-beta-479 17 10/10/2024
2.0.0-beta-478 12 10/10/2024
2.0.0-beta-465 17 10/10/2024