Serilog.Sinks.File.Header 1.0.2

.NET Standard 1.6 .NET Framework 4.5
dotnet add package Serilog.Sinks.File.Header --version 1.0.2
NuGet\Install-Package Serilog.Sinks.File.Header -Version 1.0.2
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.Header" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.File.Header --version 1.0.2
#r "nuget: Serilog.Sinks.File.Header, 1.0.2"
#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.Header as a Cake Addin
#addin nuget:?package=Serilog.Sinks.File.Header&version=1.0.2

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


A FileLifecycleHooks-based plugin for the Serilog File Sink that writes a configurable header at the start of each log file.

Getting started

FileLifecycleHooks is a new Serilog File Sink mechanism that allows hooking into log file lifecycle events, and allows scenarios such as wrapping the Serilog output stream in another stream.

To get started, install the latest Serilog.Sinks.File.Header package from NuGet:

Install-Package Serilog.Sinks.File.Header -Version 1.0.2

To enable writing a header, use one of the new LoggerSinkConfiguration extensions that has a FileLifecycleHooks argument, and create a new HeaderWriter:

Log.Logger = new LoggerConfiguration()
    .WriteTo.File("log.txt", hooks: new HeaderWriter("Timestamp,Level,Message"))

Note this also works if you enable rolling log files.

Instead of writing a static string, you can instead provide a factory method that resolves the header at runtime:

Func<string> headerFactory = () => $"My dynamic header {DateTime.UtcNow}";

Log.Logger = new LoggerConfiguration()
    .WriteTo.File("log.txt", hooks: new HeaderWriter(headerFactory))

JSON appsettings.json configuration

It's also possible to enable log file headers when configuring Serilog from a configuration file using Serilog.Settings.Configuration. To do this, you will first need to create a public static class that can provide the configuration system with a configured instance of HeaderWriter:

using Serilog.Sinks.File.Header;

namespace MyApp.Logging
    public class SerilogHooks
        public static HeaderWriter MyHeaderWriter => new HeaderWriter("Timestamp,Level,Message");

The hooks argument in Your appsettings.json file should be configured as follows:

  "Serilog": {
    "WriteTo": [
        "Name": "File",
        "Args": {
          "path": "log.gz",
          "hooks": "MyApp.Logging.SerilogHooks::MyHeaderWriter, MyApp"

To break this down a bit, what you are doing is specifying the fully qualified type name of the static class that provides your HeaderWriter, using Serilog.Settings.Configuration's special :: syntax to point to the MyHeaderWriter member.

Sample application

A basic console app is provides as a sample.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 183,058 4/17/2020
1.0.1 5,720 10/25/2019
1.0.0-dev 2,737 4/23/2019