Writes Serilog events to one or more text files and preserves main log file name. It's a fork of serilog-sinks-file, with a few modifications to keep same log file when rolling files. You can compile it by yoursef or get it on nuget.

Install the Serilog.Sinks.PersistentFile package from NuGet:

Install-Package Serilog.Sinks.PersistentFile

To configure the sink in C# code, call WriteTo.PersistentFile() during logger configuration:

var log = new LoggerConfiguration()
    .WriteTo.PersistentFile("log.txt", persistentFileRollingInterval: RollingInterval.Day)
    .CreateLogger();

This will append the time period to the filename, creating a file set like:

log20180631.txt
log20180701.txt
log20180702.txt

If you want to preserve filename when rolling the logs, so it's always the filename that gets written to. It's mostly useful for other tools like fail2ban to be able to continuously read the log. Set the parameter preserveLogFilename to true. log.txt will always have the latest logs, content will be copied to a new file and then flushed on file rolling.

log.txt
log20180631.txt
log20180701.txt
log20180702.txt

var log = new LoggerConfiguration()
    .WriteTo.PersistentFile("log.txt", persistentFileRollingInterval: RollingInterval.Day, preserveLogFilename: true)
    .CreateLogger();

Important: By default, only one process may write to a log file at a given time. See Shared log files below for information on multi-process sharing.

To avoid bringing down apps with runaway disk usage the file sink limits file size to 1GB by default. Once the limit is reached, no further events will be written until the next roll point (see also: Rolling policies below).

The limit can be changed or removed using the fileSizeLimitBytes parameter.

    .WriteTo.PersistentFile("log.txt", fileSizeLimitBytes: null)

For the same reason, only the most recent 31 files are retained by default (i.e. one long month). To change or remove this limit, pass the retainedFileCountLimit parameter.

    .WriteTo.PersistentFile("log.txt", rollingInterval: RollingInterval.Day, retainedFileCountLimit: null)

To create a log file per day or other time period, specify a rollingInterval as shown in the examples above.

To roll when the file reaches fileSizeLimitBytes, specify rollOnFileSizeLimit:

    .WriteTo.PersistentFile("log.txt", rollOnFileSizeLimit: true)

This will create a file set like:

log.txt
log_001.txt
log_002.txt

Specifying both rollingInterval and rollOnFileSizeLimit 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.

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:

<configuration>
  <appSettings>
    <add key="serilog:using:File" value="Serilog.Sinks.PersistentFile" />
    <add key="serilog:write-to:File.path" value="log.txt" />

The parameters that can be set through the serilog:write-to:File keys are the method parameters accepted by the WriteTo.PersistentFile() configuration method. This means, for example, that the fileSizeLimitBytes parameter can be set with:

    <add key="serilog:write-to:File.fileSizeLimitBytes" value="1234567" />

Omitting the value will set the parameter to null:

    <add key="serilog:write-to:File.fileSizeLimitBytes" />

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:

    <add key="serilog:write-to:File.path" value="%APPDATA%\MyApp\log.txt" />

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, :

{
  "Serilog": {
    "WriteTo": [
      { "Name": "File", "Args": { "path": "log.txt", "rollingInterval": "Day" } }
    ]
  }
}

See the XML <appSettings> example above for a discussion of available Args options.

The file sink creates events in a fixed text format by default:

2018-07-06 09:02:17.148 +10:00 [INF] HTTP GET / responded 200 in 1994 ms

The format is controlled using an output template, which the file configuration method accepts as an outputTemplate parameter.

The default format above corresponds to an output template like:

  .WriteTo.PersistentFile("log.txt",
    outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}")

To write events to the file in an alternative format such as JSON, pass an ITextFormatter as the first argument:

    // Install-Package Serilog.Formatting.Compact
    .WriteTo.PersistentFile(new CompactJsonFormatter(), "log.txt")

To enable multi-process shared log files, set shared to true:

    .WriteTo.PersistentFile("log.txt", shared: true)

The file sink can operate as an audit file through AuditTo:

    .AuditTo.File("audit.txt")

Only a limited subset of configuration options are currently available in this mode.

By default, the file sink will flush each event written through it to disk. To improve write performance, specifying buffered: true will permit the underlying stream to buffer writes.

The Serilog.Sinks.Async package can be used to wrap the file sink and perform all disk access on a background worker thread.

Copyright © 2016 Serilog Contributors - Provided under the Apache License, Version 2.0.