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
Nuke.Common
Cross-platform build automation system Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit '06168636a6c3d86bc83645fe5ef519ee17bf7233' (see contained AppVeyorSettings.json file for build settings).
184
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
183
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
187
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
234
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
301
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
303
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
349
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
381
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
445
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
865
Serilog.AspNetCore.Plus
Serilog support for ASP.NET Core logging with some plus features
256
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
204
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
235
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
262
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
381
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
487
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
692
Serilog.Sinks.Http
A Serilog sink sending log events over HTTP.
702
Serilog.Sinks.RollingFile
The rolling file sink for Serilog
202
Serilog.Sinks.RollingFile
The rolling file sink for Serilog - Simple .NET logging with fully-structured events
189

.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
8.0.0-nblumhardt-02322 71 03/08/2026
8.0.0-dev-02334 38 07/16/2026
8.0.0-dev-02331 48 04/09/2026
8.0.0-dev-02323 54 03/09/2026
8.0.0-dev-02318 89 12/10/2025
7.0.1-dev-02315 113 11/05/2025
7.0.0 271 04/29/2025
7.0.0-dev-02301 140 03/31/2025
6.0.0 270 07/22/2024
6.0.0-dev-00979 158 07/22/2024
5.0.1-dev-00976 163 07/22/2024
5.0.1-dev-00972 163 07/22/2024
5.0.1-dev-00968 150 07/22/2024
5.0.1-dev-00967 155 07/22/2024
5.0.1-dev-00966 147 07/22/2024
5.0.1-dev-00947 176 07/22/2024
5.0.0 388 02/04/2024
5.0.0-dev-00942 161 07/22/2024
5.0.0-dev-00940 156 07/22/2024
5.0.0-dev-00938 171 07/21/2024
5.0.0-dev-00935 152 07/22/2024
5.0.0-dev-00933 149 07/22/2024
5.0.0-dev-00930 155 07/22/2024
5.0.0-dev-00927 162 07/22/2024
5.0.0-dev-00920 180 07/22/2024
5.0.0-dev-00909 160 07/22/2024
5.0.0-dev-00905 187 07/22/2024
5.0.0-dev-00901 157 07/22/2024
5.0.0-dev-00887 148 07/22/2024
5.0.0-dev-00880 157 07/22/2024
5.0.0-dev-00876 167 07/22/2024
5.0.0-dev-00873 162 07/22/2024
5.0.0-dev-00870 161 07/22/2024
5.0.0-dev-00864 143 07/22/2024
5.0.0-dev-00862 152 07/22/2024
4.1.0 197 02/04/2024
4.1.0-dev-00860 176 07/22/2024
4.1.0-dev-00850 161 07/22/2024
4.1.0-dev-00847 160 07/22/2024
4.1.0-dev-00838 169 07/22/2024
4.1.0-dev-00833 188 07/22/2024
4.1.0-dev-00817 163 07/22/2024
4.1.0-dev-00806 158 07/22/2024
4.0.1-dev-00801 169 07/22/2024
4.0.1-dev-00798 151 07/22/2024
4.0.1-dev-00796 171 07/22/2024
4.0.1-dev-00795 174 07/22/2024
4.0.1-dev-00792 153 07/22/2024
4.0.1-dev-00790 175 07/22/2024
4.0.0 162 07/22/2024
4.0.0-dev-00788 175 07/22/2024
3.2.0 172 07/22/2024
3.2.0-dev-00766 172 07/22/2024
3.2.0-dev-00764 169 07/22/2024
3.2.0-dev-00762 154 07/22/2024
3.1.2-dev-00761 168 07/22/2024
3.1.1 157 07/22/2024
3.1.1-dev-00754 167 07/22/2024
3.1.0 169 07/22/2024
3.1.0-dev-00750 173 07/22/2024
3.1.0-dev-00747 164 07/22/2024
3.0.1 183 07/22/2024
3.0.1-dev-00741 151 07/22/2024
3.0.1-dev-00739 149 07/22/2024
3.0.0 160 07/22/2024
3.0.0-dev-00736 163 07/22/2024
3.0.0-dev-00735 181 07/22/2024
2.3.0-dev-00733 163 07/22/2024
2.3.0-dev-00729 166 07/22/2024
2.2.0 158 07/22/2024
2.2.0-dev-00725 166 07/22/2024
2.1.1-dev-00724 169 07/22/2024
2.1.0 155 07/22/2024
2.1.0-dev-714 143 07/22/2024
2.1.0-dev-713 183 07/22/2024
2.1.0-dev-00716 159 07/22/2024
2.0.0 159 07/22/2024
2.0.0-rc-706 153 07/22/2024
2.0.0-rc-704 151 07/22/2024
2.0.0-beta-700 156 07/22/2024
2.0.0-beta-519 161 07/22/2024
2.0.0-beta-516 158 07/22/2024
2.0.0-beta-513 150 07/22/2024
2.0.0-beta-511 153 07/22/2024
2.0.0-beta-509 167 07/22/2024
2.0.0-beta-507 157 07/22/2024
2.0.0-beta-505 158 07/22/2024
2.0.0-beta-502 164 07/22/2024
2.0.0-beta-499 162 07/22/2024
2.0.0-beta-495 156 07/22/2024
2.0.0-beta-494 152 07/22/2024
2.0.0-beta-493 162 07/22/2024
2.0.0-beta-487 165 07/22/2024
2.0.0-beta-486 177 07/22/2024
2.0.0-beta-479 166 07/22/2024
2.0.0-beta-478 160 07/22/2024
2.0.0-beta-465 171 07/22/2024