Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cocowalla/serilog-sinks-file-header
Plugin for the Serilog File sink that writes a header at the start of each log file
https://github.com/cocowalla/serilog-sinks-file-header
headers logging serilog
Last synced: 2 months ago
JSON representation
Plugin for the Serilog File sink that writes a header at the start of each log file
- Host: GitHub
- URL: https://github.com/cocowalla/serilog-sinks-file-header
- Owner: cocowalla
- License: apache-2.0
- Created: 2019-04-23T14:49:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-09T15:36:36.000Z (over 4 years ago)
- Last Synced: 2024-12-06T20:15:35.110Z (2 months ago)
- Topics: headers, logging, serilog
- Language: C#
- Size: 28.3 KB
- Stars: 10
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serilog.Sinks.File.Header
[](https://www.nuget.org/packages/Serilog.Sinks.File.Header)
[](https://ci.appveyor.com/project/cocowalla/serilog-sinks-file-header)
A `FileLifecycleHooks`-based plugin for the [Serilog File Sink](https://github.com/serilog/serilog-sinks-file) that writes a configurable header at the start of each log file.
### Getting started
To get started, install the latest [Serilog.Sinks.File.Header](https://www.nuget.org/packages/Serilog.Sinks.File.Header) package from NuGet:
```powershell
Install-Package Serilog.Sinks.File.Header -Version 1.0.1
```
To enable writing a header, use one of the new `LoggerSinkConfiguration` extensions that has a `FileLifecycleHooks` argument, and create a new `HeaderWriter`:
```csharp
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:
```csharp
Func 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](https://github.com/serilog/serilog-settings-configuration/). To do this, you will first need to create a class with a public static member that can provide the configuration system with a configured instance of `HeaderWriter`:
```csharp
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:
```json
{
"Serilog": {
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "log.csv",
"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 class that provides your `HeaderWriter`, using `Serilog.Settings.Configuration`'s special `::` syntax to point to the `MyHeaderWriter` member.
### Sample applications
2 basic console apps are provided as samples:
- [Serilog.Sinks.File.Header.Sample](https://github.com/cocowalla/serilog-sinks-file-header/tree/master/sample/Serilog.Sinks.File.Header.Sample): demonstrates writing tab-delimited logs with a header row, configured programmatically
- [Serilog.Sinks.File.Header.ConfigSample](https://github.com/cocowalla/serilog-sinks-file-header/tree/master/sample/Serilog.Sinks.File.Header.ConfigSample): demonstrates writing CSV-formatted logs with a header row, configured from appsettings.json
In both projects, logs are written to files in `.\Logs`.
### About `FileLifecycleHooks`
`FileLifecycleHooks` is a Serilog File Sink mechanism that allows hooking into log file lifecycle events, enabling scenarios such as wrapping the Serilog output stream in another stream, or capturing files before they are deleted by Serilog's retention mechanism.
Other available hooks include:
- [serilog-sinks-file-gzip](https://github.com/cocowalla/serilog-sinks-file-gzip): compresses logs as they are written, using streaming GZIP compression
- [serilog-sinks-file-archive](https://github.com/cocowalla/serilog-sinks-file-archive): archives completed log files before they are deleted by Serilog's retention mechanism