Serilog.Sinks.File.Header 1.0.0-dev

This is a prerelease version of Serilog.Sinks.File.Header.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Serilog.Sinks.File.Header --version 1.0.0-dev
NuGet\Install-Package Serilog.Sinks.File.Header -Version 1.0.0-dev
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.0-dev" />
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.0-dev
#r "nuget: Serilog.Sinks.File.Header, 1.0.0-dev"
#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.0-dev&prerelease

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

Serilog.Sinks.File.Header

NuGet Build status

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.

This new mechanism is so far only available in the the dev Serilog packages, so note that if you already have a production version of the Serilog.Sinks.File package installed, you will need to switch it out for the latest dev version.

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

Install-Package Serilog.Sinks.File.Header -Version 1.0.0-dev

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"))
    .CreateLogger();

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))
    .CreateLogger();

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  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)

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

Package Downloads
SerilogTester

This will help you to log messages inside temp folder

GitHub repositories (1)

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

Repository Stars
philosowaffle/peloton-to-garmin
Convert workout data from Peloton into JSON/TCX/FIT files and automatically upload to Garmin Connect
Version Downloads Last updated
1.0.2 516,060 4/17/2020
1.0.1 9,042 10/25/2019
1.0.0-dev 2,806 4/23/2019