Serilog.Sinks.PeriodicBatching 5.0.0

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Serilog.Sinks.PeriodicBatching --version 5.0.0
                    


                    

                
NuGet\Install-Package Serilog.Sinks.PeriodicBatching -Version 5.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Serilog.Sinks.PeriodicBatching" Version="5.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Serilog.Sinks.PeriodicBatching" Version="5.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Serilog.Sinks.PeriodicBatching" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Serilog.Sinks.PeriodicBatching --version 5.0.0
                    


                    

                
#r "nuget: Serilog.Sinks.PeriodicBatching, 5.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Serilog.Sinks.PeriodicBatching&version=5.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Serilog.Sinks.PeriodicBatching&version=5.0.0
                    


                            Install as a Cake Tool

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.

Serilog 4.x and later versions support batching natively. New projects should use Serilog's IBatchedLogEventSink and WriteTo.Sink(IBatchedLogEventSink), not this package which is now only maintained for compatibility reasons.

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);
    }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (268)

Showing the top 5 NuGet packages that depend on Serilog.Sinks.PeriodicBatching:

Package Downloads
Serilog.Sinks.Elasticsearch

Serilog sink for Elasticsearch
Serilog.Sinks.Datadog.Logs

Serilog Sink that sends log events to Datadog https://www.datadoghq.com/
Serilog.Sinks.AwsCloudWatch

A Serilog sink that logs to AWS CloudWatch
Serilog.Sinks.MongoDB

The MongoDB sink for Serilog
Serilog.Sinks.GoogleCloudLogging

Serilog sink that writes events to Google Cloud Platform (Stackdriver) Logging.

GitHub repositories (12)

Showing the top 12 popular GitHub repositories that depend on Serilog.Sinks.PeriodicBatching:

Repository Stars
TechnitiumSoftware/DnsServer
Technitium DNS Server
dotnetcore/DotnetSpider
DotnetSpider, a .NET standard web crawling library. It is lightweight, efficient and fast high-level web crawling & scraping framework
chocolatey/ChocolateyGUI
A delicious GUI for Chocolatey
smartstore/Smartstore
A modular, scalable and ultra-fast open-source all-in-one eCommerce platform built on ASP.NET Core 7
serilog-contrib/serilog-sinks-elasticsearch
A Serilog sink that writes events to Elasticsearch
trimble-oss/dba-dash
DBA Dash - SQL Server Monitoring Tool
babaktaremi/Clean-Architecture-Template
🧹 Ready to develop template based on clean architecture principles. Supports ASP NET Core Identity integrated with JWE tokens, OTP authentication, stand alone plugin development, CQRS pattern using MediatR library and dynamic permission management system out of the box
porrey/Virtual-ZPL-Printer
An ethernet based virtual Zebra Label Printer that can be used to test applications that produce bar code labels.
alaatm/Sejil
Capture, view and filter your ASP.net core log events right from your app
ubiety/xmpp
An XMPP library written for .Net in C#.
serilog-tracing/serilog-tracing
A minimal tracing system that integrates Serilog with System.Diagnostics.Activity.
johnstaveley/SecurityEssentials
Raise your baseline in security by using this as your template instead of default Mvc project. Keep your app secure by continuously applying Security rules
Version Downloads Last Updated
5.0.1-dev-00860 11,537 7/2/2024
5.0.0 4,755,090 6/5/2024
5.0.0-dev-00855 286 6/5/2024
4.1.2-dev-00851 324 5/30/2024
4.1.1 507,590 5/28/2024
4.1.1-dev-00845 473 5/22/2024
4.1.0 2,126,600 5/3/2024
4.1.0-dev-00840 3,603 5/1/2024
4.0.2-dev-00838 306 5/1/2024
4.0.1 1,321,363 3/15/2024
4.0.1-dev-00832 413 3/14/2024
4.0.0 9,827,288 2/22/2024
4.0.0-dev-00824 2,601 2/2/2024
4.0.0-dev-00821 51,282 1/1/2024
3.1.1-dev-00804 9,775 4/15/2023
3.1.1-dev-00801 10,098 9/27/2022
3.1.0 60,709,407 9/27/2022
3.1.0-dev-00796 1,976 9/15/2022
3.0.0 10,843,700 9/13/2022
3.0.0-dev-00792 1,577 9/12/2022
2.3.1 12,665,339 1/7/2022
2.3.1-dev-00785 1,083 1/7/2022
2.3.1-dev-00780 30,373 1/6/2021
2.3.1-dev-00776 4,989 7/23/2020
2.3.1-dev-00774 2,055 6/1/2020
2.3.0 81,037,684 2/28/2020
2.3.0-dev-00765 1,754 2/17/2020
2.3.0-dev-00762 160,026 2/16/2020
2.3.0-dev-00760 35,287 2/14/2020
2.2.1-dev-00758 1,797 2/13/2020
2.2.1-dev-00755 22,581 7/10/2019
2.2.0 24,020,568 5/2/2019
2.2.0-dev-00748 1,766 5/2/2019
2.2.0-dev-00740 4,847 1/28/2019
2.1.1 120,929,380 6/20/2017
2.1.1-dev-00732 2,158 6/20/2017
2.1.1-dev-00729 4,893 3/13/2017
2.1.1-dev-00725 182,168 10/26/2016
2.1.0 14,219,538 10/25/2016
2.1.0-dev-00720 2,668 9/29/2016
2.0.2-dev-00719 2,262 9/28/2016
2.0.1 378,491 9/20/2016
2.0.1-dev-00714 2,515 9/12/2016
2.0.0 6,510,001 6/27/2016
2.0.0-rc-707 6,738 5/17/2016
2.0.0-rc-705 2,112 5/17/2016
2.0.0-beta-702 2,149 4/20/2016
2.0.0-beta-700 17,030 3/23/2016
2.0.0-beta-519 2,333 3/16/2016
2.0.0-beta-516 2,051 3/15/2016
2.0.0-beta-513 2,073 3/15/2016
2.0.0-beta-511 2,026 3/14/2016
2.0.0-beta-509 1,984 3/13/2016
2.0.0-beta-507 2,321 3/1/2016
2.0.0-beta-505 5,105 2/25/2016
2.0.0-beta-502 2,151 2/22/2016
2.0.0-beta-499 2,167 2/21/2016
2.0.0-beta-495 2,070 2/19/2016
2.0.0-beta-494 2,036 2/18/2016
2.0.0-beta-493 2,013 2/18/2016
2.0.0-beta-487 2,227 2/16/2016
2.0.0-beta-486 2,373 2/11/2016
2.0.0-beta-479 2,140 2/9/2016
2.0.0-beta-478 2,117 2/9/2016
2.0.0-beta-465 3,873 1/26/2016