Serilog.Sinks.File 7.0.0-dev-02301

Serilog.Sinks.File Build status NuGet Version Documentation

Writes Serilog events to one or more text files.

Getting started

Install the Serilog.Sinks.File package from NuGet:

dotnet add package Serilog.Sinks.File

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

var log = new LoggerConfiguration()
    .WriteTo.File("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: 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.

Limits

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.File("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.File("log.txt", rollingInterval: RollingInterval.Day, retainedFileCountLimit: null)

Rolling policies

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.File("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.

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:

<configuration>
  <appSettings>
    <add key="serilog:using:File" value="Serilog.Sinks.File" />
    <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.File() 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" />

JSON appsettings.json configuration

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.

Controlling event formatting

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.File("log.txt",
    outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}")
JSON event formatting

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.File(new CompactJsonFormatter(), "log.txt")

Shared log files

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

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

Auditing

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.

Performance

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.

Extensibility

FileLifecycleHooks provide an extensibility point that allows hooking into different parts of the life cycle of a log file.

You can create a hook by extending from FileLifecycleHooks and overriding the OnFileOpened and/or OnFileDeleting methods.

  • OnFileOpened provides access to the underlying stream that log events are written to, before Serilog begins writing events. You can use this to write your own data to the stream (for example, to write a header row), or to wrap the stream in another stream (for example, to add buffering, compression or encryption)

  • OnFileDeleting provides a means to work with obsolete rolling log files, before they are deleted by Serilog's retention mechanism - for example, to archive log files to another location

Available hooks:

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

Showing the top 20 packages that depend on Serilog.Sinks.File.

Packages Downloads
Serilog.Sinks.AmazonKinesis
Serilog event sink that writes to Amazon Kinesis.
162
Serilog.Sinks.RollingFile
The rolling file sink for Serilog - Simple .NET logging with fully-structured events
160
Serilog.Sinks.RollingFile
The rolling file sink for Serilog - Simple .NET logging with fully-structured events
73
Serilog.Sinks.Elasticsearch
Package Description
60
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
58
Serilog.Sinks.Elasticsearch
Package Description
57
Serilog.Sinks.Elasticsearch
Serilog sink for Elasticsearch
54
Serilog.Sinks.Elasticsearch
Package Description
52
Serilog.Sinks.Elasticsearch
Serilog sink for Elasticsearch
51
Serilog.Sinks.Elasticsearch
Package Description
51
Serilog.Sinks.Elasticsearch
Package Description
50
Serilog.Sinks.RollingFile
The rolling file sink for Serilog - Simple .NET logging with fully-structured events
49
Serilog.Sinks.Elasticsearch
Package Description
49
Serilog.Sinks.Elasticsearch
Serilog.Sinks.Elasticsearch
48
Nuke.Common
Cross-platform build automation system Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit '39132f3fb1fea9f889894dfe520cf4434d6eca4e' (see contained AppVeyorSettings.json file for build settings).
47
Serilog.Sinks.Elasticsearch
Package Description
46

.NET Framework 4.6.2

.NET Framework 4.7.1

.NET 6.0

.NET 8.0

.NET 9.0

.NET Standard 2.0

Version Downloads Last updated
7.0.0 9 05/01/2025
7.0.0-dev-02301 13 03/13/2025
6.0.0 24 06/25/2024
6.0.0-dev-00979 28 06/25/2024
5.0.1-dev-00976 16 06/25/2024
5.0.1-dev-00972 22 02/16/2024
5.0.1-dev-00968 17 07/03/2024
5.0.1-dev-00967 20 06/26/2024
5.0.1-dev-00966 17 06/26/2024
5.0.1-dev-00947 25 03/26/2023
5.0.0 22 03/29/2023
5.0.0-dev-00942 55 04/03/2023
5.0.0-dev-00940 56 04/02/2023
5.0.0-dev-00938 18 08/30/2023
5.0.0-dev-00935 21 08/29/2023
5.0.0-dev-00933 20 08/28/2023
5.0.0-dev-00930 41 08/29/2023
5.0.0-dev-00927 70 04/02/2023
5.0.0-dev-00920 34 08/24/2023
5.0.0-dev-00909 23 08/27/2023
5.0.0-dev-00905 21 08/30/2023
5.0.0-dev-00901 18 08/31/2023
5.0.0-dev-00887 18 07/25/2024
5.0.0-dev-00880 21 08/29/2023
5.0.0-dev-00876 61 04/02/2023
5.0.0-dev-00873 30 08/27/2023
5.0.0-dev-00870 40 08/28/2023
5.0.0-dev-00864 20 08/24/2023
5.0.0-dev-00862 42 04/04/2023
4.1.0 162 04/30/2021
4.1.0-dev-00860 23 08/30/2023
4.1.0-dev-00850 23 08/26/2023
4.1.0-dev-00847 50 03/26/2023
4.1.0-dev-00838 17 01/28/2024
4.1.0-dev-00833 17 08/26/2023
4.1.0-dev-00817 22 08/27/2023
4.1.0-dev-00806 15 08/25/2023
4.0.1-dev-00801 27 08/28/2023
4.0.1-dev-00798 60 04/03/2023
4.0.1-dev-00796 18 08/27/2023
4.0.1-dev-00795 35 03/28/2023
4.0.1-dev-00792 49 04/04/2023
4.0.1-dev-00790 18 08/25/2023
4.0.0 41 03/30/2022
4.0.0-dev-00788 23 08/30/2023
3.2.0 75 06/18/2020
3.2.0-dev-00766 66 04/05/2023
3.2.0-dev-00764 19 08/30/2023
3.2.0-dev-00762 38 09/10/2023
3.1.2-dev-00761 18 08/30/2023
3.1.1 27 10/27/2023
3.1.1-dev-00754 19 08/29/2023
3.1.0 46 11/25/2019
3.1.0-dev-00750 54 03/27/2023
3.1.0-dev-00747 25 08/26/2023
3.0.1 47 04/03/2023
3.0.1-dev-00741 31 04/06/2023
3.0.1-dev-00739 16 08/31/2023
3.0.0 29 02/12/2024
3.0.0-dev-00736 43 04/03/2023
3.0.0-dev-00735 27 08/25/2023
2.3.0-dev-00733 49 03/26/2023
2.3.0-dev-00729 55 04/01/2023
2.2.0 83 05/07/2021
2.2.0-dev-00725 31 04/01/2023
2.1.1-dev-00724 30 08/31/2023
2.1.0 20 01/21/2024
2.1.0-dev-714 43 04/04/2023
2.1.0-dev-713 32 08/31/2023
2.1.0-dev-00716 30 08/31/2023
2.0.0 49 03/28/2023
2.0.0-rc-706 38 08/29/2023
2.0.0-rc-704 35 04/27/2023
2.0.0-beta-700 19 08/29/2023
2.0.0-beta-519 56 06/09/2023
2.0.0-beta-516 17 05/13/2024
2.0.0-beta-513 23 08/27/2023
2.0.0-beta-511 18 06/17/2024
2.0.0-beta-509 27 08/27/2023
2.0.0-beta-507 37 03/29/2023
2.0.0-beta-505 27 03/28/2023
2.0.0-beta-502 19 08/26/2023
2.0.0-beta-499 50 04/03/2023
2.0.0-beta-495 27 08/29/2023
2.0.0-beta-494 33 08/29/2023
2.0.0-beta-493 19 08/25/2023
2.0.0-beta-487 22 08/30/2023
2.0.0-beta-486 75 03/28/2023
2.0.0-beta-479 46 04/16/2023
2.0.0-beta-478 44 06/05/2023
2.0.0-beta-465 24 12/05/2023