Serilog.Sinks.File.GZip
1.1.0
dotnet add package Serilog.Sinks.File.GZip --version 1.1.0
NuGet\Install-Package Serilog.Sinks.File.GZip -Version 1.1.0
<PackageReference Include="Serilog.Sinks.File.GZip" Version="1.1.0" />
<PackageVersion Include="Serilog.Sinks.File.GZip" Version="1.1.0" />
<PackageReference Include="Serilog.Sinks.File.GZip" />
paket add Serilog.Sinks.File.GZip --version 1.1.0
#r "nuget: Serilog.Sinks.File.GZip, 1.1.0"
#:package Serilog.Sinks.File.GZip@1.1.0
#addin nuget:?package=Serilog.Sinks.File.GZip&version=1.1.0
#tool nuget:?package=Serilog.Sinks.File.GZip&version=1.1.0
Serilog.Sinks.File.GZip
A FileLifecycleHooks-based plugin for the Serilog File Sink that compresses log files using streaming GZip compression.
Getting started
To get started, install the latest Serilog.Sinks.File.GZip package from NuGet:
Install-Package Serilog.Sinks.File.GZip -Version 1.1.0
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.
About FileLifecycleHooks
FileLifecycleHooks is a Serilog File Sink mechanism that allows hooking into log file lifecycle events, enabling scenarios such as wrapping the Serilog output stream in another stream, or capturing files before they are deleted by Serilog's retention mechanism.
Other available hooks include:
- serilog-sinks-file-header: writes a header to the start of each log file
- serilog-sinks-file-archive: archives completed log files before they are deleted by Serilog's retention mechanism
| Product | Versions 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 is compatible. 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. |
-
.NETFramework 4.6.2
- Serilog.Sinks.File (>= 4.1.0)
-
.NETFramework 4.7.1
- Serilog.Sinks.File (>= 4.1.0)
-
.NETStandard 2.0
- Serilog.Sinks.File (>= 4.1.0)
-
net6.0
- Serilog.Sinks.File (>= 4.1.0)
-
net8.0
- Serilog.Sinks.File (>= 4.1.0)
-
net9.0
- Serilog.Sinks.File (>= 4.1.0)
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.