Serilog.Extensions.WhenRepeated 1.0.2

dotnet add package Serilog.Extensions.WhenRepeated --version 1.0.2
NuGet\Install-Package Serilog.Extensions.WhenRepeated -Version 1.0.2
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.Extensions.WhenRepeated" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Extensions.WhenRepeated --version 1.0.2
#r "nuget: Serilog.Extensions.WhenRepeated, 1.0.2"
#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.
// Install Serilog.Extensions.WhenRepeated as a Cake Addin
#addin nuget:?package=Serilog.Extensions.WhenRepeated&version=1.0.2

// Install Serilog.Extensions.WhenRepeated as a Cake Tool
#tool nuget:?package=Serilog.Extensions.WhenRepeated&version=1.0.2

Serilog.Extensions.WhenRepeated

tests Coverage Status

A wrapper for other Serilog sinks. Matches when message has already been logged. Useful if having an aggressive logger, and wants to throttle the output.

Getting started

Install from NuGet:
Install-Package Serilog.Extensions.WhenRepeated 

Minimal example

// At this example duplicated messages are written as as dot
...
private static readonly MessageTemplate RepeatedMessageTemplate = new MessageTemplate(new MessageTemplateParser().Parse(".").Tokens);

new LoggerConfiguration()
  .Enrich.WithRepeatedMessagesCount("repeatCount")
  .WriteTo
  .WhenRepeated(
    configureWrappedSink: x => x.Async(y => y.File("/path/to/log.txt")),
    options: new WhenRepeatedOptions(
      onRepeat: (current, previous) =>
      {
        return new LogEvent(
          timestamp: current.Timestamp,
          level: current.Level,
          exception: null,
          messageTemplate: RepeatedMessageTemplate,
          properties: Array.Empty<LogEventProperty>());
      })).CreateLogger();
...

Options

The WhenRepeatedOptions type constructor exposes the following members.

Name Description
onRepeat Action to be taken when filter matches.
compare Statement of that how to compare current log with previous log event.
timeout Duration after which message if duplicated will be logged.
firstStrategy Strategy that determines how to handle first (not duplicated) log event.

Enrichment

Enrich Serilog events with repeated messages count property.

...
new LoggerConfiguration()
  .Enrich.WithRepeatedMessagesCount("repeatCount") // Set name under which property will be available
  .WriteTo
  .WhenRepeated(
    configureWrappedSink: x => x.Async(y => y.File("/path/to/log.txt")),
    options: new WhenRepeatedOptions() // Default options, needed to enable counting. By default increment repeated messages count when same message occurs in 10 seconds time interval.
  ).CreateLogger();
...
logger.Information(messageTemplate: "{repeatCount}");
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 is compatible.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 160 1/16/2024
1.0.1 342 12/4/2022
1.0.0 331 7/18/2022