Serilog.Sinks.PeriodicBatching 4.0.0-dev-00821

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
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
32
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
28
Microsoft.Extensions.Logging.AzureAppServices
Diagnostics logger for Azure WebApps
27
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
25
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
22

.NET Framework 4.6.2

.NET 6.0

.NET Standard 2.0

Version Downloads Last updated
5.0.1-dev-00860 28 8/11/2024
5.0.0 28 8/20/2024
5.0.0-dev-00855 24 7/10/2024
4.1.2-dev-00851 25 8/19/2024
4.1.1 27 7/26/2024
4.1.1-dev-00845 25 8/11/2024
4.1.0 27 8/21/2024
4.1.0-dev-00840 25 7/21/2024
4.0.2-dev-00838 28 7/12/2024
4.0.1 32 4/23/2024
4.0.1-dev-00832 32 3/28/2024
4.0.0 26 3/8/2024
4.0.0-dev-00824 30 3/8/2024
4.0.0-dev-00821 28 3/8/2024
3.1.1-dev-00804 26 3/8/2024
3.1.1-dev-00801 29 3/8/2024
3.1.0 27 3/8/2024
3.1.0-dev-00796 28 3/8/2024
3.0.0 29 3/8/2024
3.0.0-dev-00792 28 3/8/2024
2.3.1 25 3/8/2024
2.3.1-dev-00785 28 3/8/2024
2.3.1-dev-00780 27 3/8/2024
2.3.1-dev-00776 29 3/8/2024
2.3.1-dev-00774 28 3/8/2024
2.3.0 26 3/8/2024
2.3.0-dev-00765 28 3/8/2024
2.3.0-dev-00762 28 3/8/2024
2.3.0-dev-00760 29 3/8/2024
2.2.1-dev-00758 29 3/8/2024
2.2.1-dev-00755 29 3/8/2024
2.2.0 27 3/8/2024
2.2.0-dev-00748 27 3/8/2024
2.2.0-dev-00740 29 3/8/2024
2.1.1 29 3/8/2024
2.1.1-dev-00732 25 3/8/2024
2.1.1-dev-00729 30 3/8/2024
2.1.1-dev-00725 28 3/8/2024
2.1.0 27 3/8/2024
2.1.0-dev-00720 30 3/8/2024
2.0.2-dev-00719 30 3/8/2024
2.0.1 34 3/8/2024
2.0.1-dev-00714 29 3/8/2024
2.0.0 32 3/8/2024
2.0.0-rc-707 30 3/8/2024
2.0.0-rc-705 32 3/8/2024
2.0.0-beta-702 27 3/8/2024
2.0.0-beta-700 25 3/8/2024
2.0.0-beta-519 28 3/8/2024
2.0.0-beta-516 31 3/8/2024
2.0.0-beta-513 25 3/8/2024
2.0.0-beta-511 31 3/8/2024
2.0.0-beta-509 28 3/8/2024
2.0.0-beta-507 31 3/8/2024
2.0.0-beta-505 27 3/8/2024
2.0.0-beta-502 27 3/8/2024
2.0.0-beta-499 26 3/8/2024
2.0.0-beta-495 29 3/8/2024
2.0.0-beta-494 30 3/8/2024
2.0.0-beta-493 31 3/8/2024
2.0.0-beta-487 32 3/8/2024
2.0.0-beta-486 29 3/8/2024
2.0.0-beta-479 30 3/8/2024
2.0.0-beta-478 30 3/8/2024
2.0.0-beta-465 28 3/8/2024