Serilog.Sinks.File.GZip 1.0.2

dotnet add package Serilog.Sinks.File.GZip --version 1.0.2                
NuGet\Install-Package Serilog.Sinks.File.GZip -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.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                
#r "nuget: Serilog.Sinks.File.GZip, 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.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                

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  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 tizen30 was computed.  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 (1)

Showing the top 1 NuGet packages that depend on Serilog.Sinks.File.GZip:

Package Downloads
Shinya.Logging.Serilog.Sinks.File

Shinya.Framework

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 439,793 6/26/2020
1.0.1 4,412 10/25/2019
1.0.0-dev 536 4/23/2019