Serilog.Sinks.File.GZip 1.0.2

.NET Standard 1.6 .NET Framework 4.5
Install-Package Serilog.Sinks.File.GZip -Version 1.0.2
dotnet add package Serilog.Sinks.File.GZip --version 1.0.2
<PackageReference Include="Serilog.Sinks.File.GZip" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.File.GZip --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Serilog.Sinks.File.GZip, 1.0.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.Sinks.File.GZip as a Cake Addin
#addin nuget:?package=Serilog.Sinks.File.GZip&version=1.0.2

// Install Serilog.Sinks.File.GZip as a Cake Tool
#tool nuget:?package=Serilog.Sinks.File.GZip&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Serilog.Sinks.File.GZip

A FileLifecycleHooks-based plugin for the Serilog File Sink that compresses log files using streaming GZip compression.

Getting started

FileLifecycleHooks is a new Serilog File Sink mechanism that allows hooking into log file lifecycle events, and allows scenarios such as wrapping the Serilog output stream in another stream.

To get started, install the latest Serilog.Sinks.File.GZip package from NuGet:

Install-Package Serilog.Sinks.File.GZip -Version 1.0.2

To enable GZip compression, use one of the new LoggerSinkConfiguration extensions that has a FileLifecycleHooks argument, and create a new GZipHooks:

Log.Logger = new LoggerConfiguration()
    .WriteTo.File("log.gz", hooks: new GZipHooks())
    .CreateLogger();

Note this also works if you enable rolling log files.

You can optionally tweak GZIP compression by changing the log level and buffer size (the default is 32KB):

Log.Logger = new LoggerConfiguration()
    .WriteTo.File("log.gz", hooks: new GZipHooks(CompressionLevel.Fastest, 1024 * 64))
    .CreateLogger();

It's also possible to enable GZIP compression when configuring Serilog from a configuration file using Serilog.Settings.Configuration:

{
  "Serilog": {
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "log.gz",
          "hooks": "Serilog.Sinks.File.GZip.GZipHooks, Serilog.Sinks.File.GZip"
        }
      }
    ]
  }
}

Larger buffer sizes potentially result in better compression ratios, but note that in the event of a crash that the contents of the buffer may be lost.

As is standard with Serilog, it's important to call Log.CloseAndFlush(); before your application ends.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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 125,520 6/26/2020
1.0.1 2,848 10/25/2019
1.0.0-dev 415 4/23/2019