Serilog.Sinks.File.Archive
1.0.6
dotnet add package Serilog.Sinks.File.Archive --version 1.0.6
NuGet\Install-Package Serilog.Sinks.File.Archive -Version 1.0.6
<PackageReference Include="Serilog.Sinks.File.Archive" Version="1.0.6" />
paket add Serilog.Sinks.File.Archive --version 1.0.6
#r "nuget: Serilog.Sinks.File.Archive, 1.0.6"
// Install Serilog.Sinks.File.Archive as a Cake Addin #addin nuget:?package=Serilog.Sinks.File.Archive&version=1.0.6 // Install Serilog.Sinks.File.Archive as a Cake Tool #tool nuget:?package=Serilog.Sinks.File.Archive&version=1.0.6
Serilog.Sinks.File.Archive
A FileLifecycleHooks
-based plugin for the Serilog File Sink that works with rolling log files, archiving completed log files before they are deleted by Serilog's retention mechanism.
The following archive methods are supported:
- Compress logs in the same directory (using GZip compression)
- Copying logs to another directory
- Compress logs (using GZip compression) and write them to another directory
Getting started
To get started, install the latest Serilog.Sinks.File.Archive package from NuGet:
Install-Package Serilog.Sinks.File.Archive
To enable archiving, use one of the new LoggerSinkConfiguration
extensions that has a FileLifecycleHooks
argument, and create a new ArchiveHooks
. For example, to write GZip compressed logs to another directory (the directory will be created if it doesn't already exist):
Log.Logger = new LoggerConfiguration()
.WriteTo.File("my-app.log", hooks: new ArchiveHooks(CompressionLevel.Fastest, "C:\\My\\Archive\\Path"))
.CreateLogger();
Or to copy logs as-is to another directory:
Log.Logger = new LoggerConfiguration()
.WriteTo.File("my-app.log", hooks: new ArchiveHooks(CompressionLevel.NoCompression, "C:\\My\\Archive\\Path"))
.CreateLogger();
Or to write GZip compressed logs to the same directory the logs are written to:
Log.Logger = new LoggerConfiguration()
.WriteTo.File("my-app.log", hooks: new ArchiveHooks(CompressionLevel.Fastest))
.CreateLogger();
Note that archival only works with rolling log files, as files are only deleted by Serilog's rolling file retention mechanism.
As is standard with Serilog, it's important to call Log.CloseAndFlush();
before your application ends.
Token Replacement
The targetDirectory
constructor parameter supports replacement of tokens at runtime.
Tokens take the form {Name:FormatString}
, where Name
is the name of a supported token, and FormatString
defines how the token value should be formatted.
At present, 2 tokens are supported, UtcDate
and Date
. These use standard .NET date format strings to insert components of the current date/time into the path. For example, you may wish to organise archived files into folders based on the current year and month:
new ArchiveHooks(CompressionLevel.Fastest, "C:\\Archive\\{UtcDate:yyyy}\\{UtcDate:MM}")
JSON appsettings.json configuration
It's also possible to enable archival when configuring Serilog from a configuration file using Serilog.Settings.Configuration. To do this, you will first need to create a public static class that can provide the configuration system with a configured instance of ArchiveHooks
:
using Serilog.Sinks.File.Archive;
namespace MyApp.Logging
{
public class SerilogHooks
{
public static ArchiveHooks MyArchiveHooks => new ArchiveHooks(CompressionLevel.Fastest, "C:\\My\\Archive\\Path");
}
}
The hooks
argument in Your appsettings.json
file should be configured as follows:
{
"Serilog": {
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "my-app.log",
"fileSizeLimitBytes": 10485760,
"rollOnFileSizeLimit": true,
"retainedFileCountLimit": 5,
"hooks": "MyApp.Logging.SerilogHooks::MyArchiveHooks, MyApp"
}
}
]
}
}
To break this down a bit, what you are doing is specifying the fully qualified type name of the static class that provides your ArchiveHooks
, using Serilog.Settings.Configuration
's special ::
syntax to point to the MyArchiveHooks
member.
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-gzip: compresses logs as they are written, using streaming GZIP compression
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. |
.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 was computed. |
.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. |
-
.NETFramework 4.5
- Serilog.Sinks.File (>= 4.1.0)
-
.NETStandard 1.6
- Serilog.Sinks.File (>= 4.1.0)
- System.IO.Compression (>= 4.3.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)
NuGet packages (5)
Showing the top 5 NuGet packages that depend on Serilog.Sinks.File.Archive:
Package | Downloads |
---|---|
Nefarius.Utilities.AspNetCore
My opinionated collection of utilities for ASP.NET Core applications. |
|
Shinya.Logging.Serilog.Sinks.File
Shinya.Framework |
|
Xfrogcn.AspNetCore.Extensions
AspNetCore extensions library,includes function as logging, HTTP requests, authentication token management, parallel queue processing, and more |
|
SerilogTester
This will help you to log messages inside temp folder |
|
Evsemo.Logging
Package Description |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Serilog.Sinks.File.Archive:
Repository | Stars |
---|---|
GZTimeWalker/GZCTF
The GZ::CTF project, an open source CTF platform.
|