Serilog.Sinks.File.GZip 1.0.2

Plugin for the Serilog File sink that compresses output using streaming GZIP.

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"
For F# scripts that support #r syntax, copy this into the source code to reference the package.

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.

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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.2 6,200 6/26/2020
1.0.1 2,612 10/25/2019
1.0.0-dev 300 4/23/2019