To configure the sink in C# code, call WriteTo.ZipFile() during logger configuration:
var log = new LoggerConfiguration()
.WriteTo.ZipFile("log.txt", rollingInterval: RollingInterval.Day)
.CreateLogger();
This will append the time period to the filename, creating a file set like:
log20180631.txt
log20180701.txt
log20180702.txt
Important: Only one process may write to a log file at a given time.
Logging Files into the Zip
Supplemental log files are detected by pattern matching. If the logged type contains properties named 'filename' and 'filedata' (case insensative) with types string and byte[] respectively, the type is destructured into a format that ZipFileSink can parse, and the file is added to the zip. File names are prepended with the timestamp. By defauly, files are compressed with CompressionLevel.Fastest. If the logged object contains a property of type System.IO.Compression.CompressionLevel, that compression level will be used instead.
Example:
Serilog.Log.Logger.Information(
"{@file}",
new
{
filename = "somefile.txt",
filedata = System.Text.Encoding.UTF8.GetBytes("Some text in a file")
});
Rolling policies
To create a log file per day or other time period, specify a rollingInterval as shown in the examples above.
Specifying both rollingInterval will cause both policies to be applied, while specifying neither will result in all events being written to a single file.
Old files will be cleaned up as per retainedFileCountLimit - the default is 31.
XML <appSettings> configuration
To use the file sink with the Serilog.Settings.AppSettings package, first install that package if you haven't already done so:
Install-Package Serilog.Settings.AppSettings
Instead of configuring the logger in code, call ReadFrom.AppSettings():
var log = new LoggerConfiguration()
.ReadFrom.AppSettings()
.CreateLogger();
In your application's App.config or Web.config file, specify the file sink assembly and required path format under the <appSettings> node:
The parameters that can be set through the serilog:write-to:ZipFile keys are the method parameters accepted by the WriteTo.ZipFile() configuration method.
In XML and JSON configuration formats, environment variables can be used in setting values. This means, for instance, that the log file path can be based on TMP or APPDATA:
To use the file sink with Microsoft.Extensions.Configuration, for example with ASP.NET Core or .NET Core, use the Serilog.Settings.Configuration package. First install that package if you have not already done so:
Install-Package Serilog.Settings.Configuration
Instead of configuring the file directly in code, call ReadFrom.Configuration():
var configuration = new ConfigurationBuilder()
.AddJsonFile("appsettings.json")
.Build();
var logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
.CreateLogger();
In your appsettings.json file, under the Serilog node, :