Serilog.Sinks.File 6.0.0

Prefix Reserved
dotnet add package Serilog.Sinks.File --version 6.0.0                
NuGet\Install-Package Serilog.Sinks.File -Version 6.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Serilog.Sinks.File" Version="6.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.File --version 6.0.0                
#r "nuget: Serilog.Sinks.File, 6.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.Sinks.File as a Cake Addin
#addin nuget:?package=Serilog.Sinks.File&version=6.0.0

// Install Serilog.Sinks.File as a Cake Tool
#tool nuget:?package=Serilog.Sinks.File&version=6.0.0                

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.

Product 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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1.1K)

Showing the top 5 NuGet packages that depend on Serilog.Sinks.File:

Package Downloads
Serilog.AspNetCore

Serilog support for ASP.NET Core logging

Serilog.Sinks.RollingFile

The rolling file sink for Serilog

Serilog.Sinks.Elasticsearch

Serilog sink for Elasticsearch

Serilog.Sinks.Seq

A Serilog sink that writes events to Seq using newline-delimited JSON and HTTP/HTTPS.

Serilog.Sinks.Http

A Serilog sink sending log events over HTTP.

GitHub repositories (337)

Showing the top 5 popular GitHub repositories that depend on Serilog.Sinks.File:

Repository Stars
jellyfin/jellyfin
The Free Software Media System
netchx/netch
A simple proxy client
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
IdentityServer/IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
Version Downloads Last updated
6.0.0 418,110 6/22/2024
6.0.0-dev-00979 1,839 6/19/2024
5.0.1-dev-00976 1,323 6/17/2024
5.0.1-dev-00972 117,980 12/26/2023
5.0.1-dev-00968 126,787 9/28/2023
5.0.1-dev-00967 653 9/28/2023
5.0.1-dev-00966 622 9/28/2023
5.0.1-dev-00947 961,079 9/20/2021
5.0.0 208,162,325 6/25/2021
5.0.0-dev-00942 3,099 6/22/2021
5.0.0-dev-00940 5,373 6/22/2021
5.0.0-dev-00938 1,074 6/22/2021
5.0.0-dev-00935 1,017 6/22/2021
5.0.0-dev-00933 1,243 6/22/2021
5.0.0-dev-00930 1,156 6/22/2021
5.0.0-dev-00927 1,118 6/22/2021
5.0.0-dev-00920 5,330 6/15/2021
5.0.0-dev-00909 3,227,277 1/4/2021
5.0.0-dev-00905 225,021 11/10/2020
5.0.0-dev-00901 2,869 11/9/2020
5.0.0-dev-00887 288,572 7/23/2020
5.0.0-dev-00880 118,682 5/15/2020
5.0.0-dev-00876 21,269 4/29/2020
5.0.0-dev-00873 10,602 4/20/2020
5.0.0-dev-00870 26,184 4/13/2020
5.0.0-dev-00864 121,882 2/4/2020
5.0.0-dev-00862 24,726 2/4/2020
4.1.0 147,601,012 10/17/2019
4.1.0-dev-00860 1,474 12/16/2019
4.1.0-dev-00850 127,760 8/25/2019
4.1.0-dev-00847 72,196 7/16/2019
4.1.0-dev-00838 90,928 5/2/2019
4.1.0-dev-00833 9,502 4/22/2019
4.1.0-dev-00817 33,884 3/13/2019
4.1.0-dev-00806 18,805 1/17/2019
4.0.1-dev-00801 102,033 11/15/2018
4.0.1-dev-00798 83,424 9/21/2018
4.0.1-dev-00796 183,817 5/9/2018
4.0.1-dev-00795 27,335 3/6/2018
4.0.1-dev-00792 3,737 2/21/2018
4.0.1-dev-00790 30,751 11/29/2017
4.0.0 131,824,406 10/30/2017
4.0.0-dev-00788 3,530 10/16/2017
3.2.0 50,360,090 1/3/2017
3.2.0-dev-00766 2,691 11/29/2016
3.2.0-dev-00764 1,956 11/29/2016
3.2.0-dev-00762 5,211 11/27/2016
3.1.2-dev-00761 2,629 11/27/2016
3.1.1 242,128 11/15/2016
3.1.1-dev-00754 1,894 11/14/2016
3.1.0 1,375,196 10/9/2016
3.1.0-dev-00750 1,838 10/9/2016
3.1.0-dev-00747 2,621 10/6/2016
3.0.1 714,498 8/31/2016
3.0.1-dev-00741 1,870 8/30/2016
3.0.1-dev-00739 1,911 8/26/2016
3.0.0 242,101 8/26/2016
3.0.0-dev-00736 1,869 8/26/2016
3.0.0-dev-00735 2,747 8/19/2016
2.3.0-dev-00733 1,842 8/19/2016
2.3.0-dev-00729 1,866 8/17/2016
2.2.0 2,069,391 7/28/2016
2.2.0-dev-00725 2,183 7/28/2016
2.1.1-dev-00724 2,282 7/28/2016
2.1.0 120,351 7/4/2016
2.1.0-dev-714 1,910 7/4/2016
2.1.0-dev-713 1,890 7/4/2016
2.1.0-dev-00716 1,862 7/4/2016
2.0.0 589,701 6/28/2016
2.0.0-rc-706 3,861 5/17/2016
2.0.0-rc-704 12,429 5/17/2016
2.0.0-beta-700 6,838 3/23/2016
2.0.0-beta-519 2,181 3/16/2016
2.0.0-beta-516 2,045 3/15/2016
2.0.0-beta-513 1,822 3/15/2016
2.0.0-beta-511 1,831 3/14/2016
2.0.0-beta-509 1,924 3/13/2016
2.0.0-beta-507 6,768 3/1/2016
2.0.0-beta-505 4,559 2/25/2016
2.0.0-beta-502 2,182 2/22/2016
2.0.0-beta-499 1,969 2/21/2016
2.0.0-beta-495 1,905 2/19/2016
2.0.0-beta-494 1,816 2/18/2016
2.0.0-beta-493 1,843 2/18/2016
2.0.0-beta-487 1,981 2/16/2016
2.0.0-beta-486 2,459 2/11/2016
2.0.0-beta-479 1,876 2/9/2016
2.0.0-beta-478 2,101 2/9/2016
2.0.0-beta-465 24,171 1/26/2016