https://github.com/cocowalla/serilog-sinks-file-gzip
Plugin for the Serilog File sink that compresses output using streaming GZIP
https://github.com/cocowalla/serilog-sinks-file-gzip
compression gzip logging serilog
Last synced: 4 months ago
JSON representation
Plugin for the Serilog File sink that compresses output using streaming GZIP
- Host: GitHub
- URL: https://github.com/cocowalla/serilog-sinks-file-gzip
- Owner: cocowalla
- License: apache-2.0
- Created: 2019-04-23T10:46:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-30T18:22:14.000Z (over 5 years ago)
- Last Synced: 2025-06-13T00:04:13.535Z (4 months ago)
- Topics: compression, gzip, logging, serilog
- Language: C#
- Size: 28.3 KB
- Stars: 13
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serilog.Sinks.File.GZip
[](https://www.nuget.org/packages/Serilog.Sinks.File.GZip)
[](https://ci.appveyor.com/project/cocowalla/serilog-sinks-file-gzip)
A `FileLifecycleHooks`-based plugin for the [Serilog File Sink](https://github.com/serilog/serilog-sinks-file) that compresses log files using streaming GZip compression.
### Getting started
To get started, install the latest [Serilog.Sinks.File.GZip](https://www.nuget.org/packages/Serilog.Sinks.File.GZip) package from NuGet:
```powershell
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`:
```csharp
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):
```csharp
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](https://github.com/serilog/serilog-settings-configuration/):
```json
{
"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](https://github.com/serilog/serilog/wiki/Lifecycle-of-Loggers#in-all-apps), 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](https://github.com/cocowalla/serilog-sinks-file-header): writes a header to the start of each log file
- [serilog-sinks-file-archive](https://github.com/cocowalla/serilog-sinks-file-archive): archives completed log files before they are deleted by Serilog's retention mechanism