Voyager.Serilog.Settings.Configuration 1.1.5

Voyager.Serilog.Settings.Configuration

Guide

This project provides helper methods for registering Serilog with custom identity providers in an ASP.NET Core application. It includes methods to clean existing logging providers and register Serilog with or without an identity provider.

• Serilog Configuration
• Registration Example
• Identity Provider Usage
• Console Outputs

Prerequisites

• .NET 8.0
• Visual Studio 2022

NuGet Packages

Ensure the following NuGet packages are installed in your project:

• Serilog.AspNetCore
• Serilog.Expressions
• Serilog.Enrichers.Environment
• Voyager.Serilog.Sinks.FastEMail
• Voyager.Serilog.Settings.Configuration

Serilog Configuration

This is a example serilog configuration using BackendSerilogFormatter to log formated messages to console

{
  "Serilog": {
    "Using": [
      "Serilog.Enrichers.Environment",
      "Serilog.Sinks.Console",
      "Serilog",
      "Serilog.Expressions"
    ],
    "Filter": [
      {
        "Name": "ByExcluding",
        "Args": {
          "expression": "@Message like'%Executed DbCommand %'"
        }
      }
    ],
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "WriteTo": [
      {
        "Name": "Console",
        "Args": {
          "formatter": "Voyager.Serilog.Settings.Configuration.Formatters.BackendSerilogFormatter, Voyager.Serilog.Settings.Configuration"
        }
      },
      {
        "Name": "FastEmail",
        "Args": {
          "ConnectionInfo": {
            "FromEmail": "{use application name here}@voyager.pl",
            "ToEmail": "{email adress of the person/group who will recive the email notification when an error occurs}",
            "EmailSubject": "[{Level}],<{MachineName}> {use application name here}",
            "IsBodyHtml": false,
            "mailServer": "mgw.voyager.pl"
          },
          "RestrictedToMinimumLevel": "Error",
          "OutputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level:u4}] Maszyna:{MachineName} ASPNETCORE_ENVIRONMENT:%ASPNETCORE_ENVIRONMENT% {NewLine:l}{Message}{NewLine:l}{Exception}{NewLine:l}{Properties}"
        }
      }
    ],
    "Enrich": [ "FromLogContext", "WithCaller" ],
    "Properties": {
      "Application": "{use application name here}"
    }
  }
}

• Back to top

Registration Example:

• .NET 8.0 registartion with WebApplicationBuilder:

public static WebApplicationBuilder RegisterSerilog(this WebApplicationBuilder builder)
{
	builder.Host.UseSerilog((context, services, configuration) =>
	{
		configuration
			.ReadFrom.Configuration(context.Configuration);
	}, true);

	return builder;
}

• Back to top

Identity Provider Usage

To add user claims into logged data you first have to add the fallowing NuGet packages:

• Voyager.RestAPI.Interface
• Voyager.Enricher.Identity

Also the registration will change to:

• For .NET 8.0 with Identity

public static WebApplicationBuilder RegisterSerilog(this WebApplicationBuilder builder)
{
	builder.Host.UseSerilog((context, services, configuration) =>
	{
		configuration
			.ReadFrom.Configuration(context.Configuration)
			.Enrich.WithIdentityEnricher(() => services.GetService<IdentityProvider>()!);
	}, true);

	return builder;
}

• Back to top

Console Outputs

• WorkerLogOutput which returns the log with data:

class WorkerLogOutput
{
	public string Timestamp { get; set; } = string.Empty;
	public string Level { get; set; } = string.Empty;
	public string Message { get; set; } = string.Empty;
	public string? Scope { get; set; } = string.Empty;

	public IReadOnlyDictionary<string, string> Properties { get; set; } = new Dictionary<string, string>();
	public SerializableException? Exception { get; set; } = new SerializableException();
}

• BackendLogOutput which extends the WorkerLogOutput class for caller informations

class BackendLogOutput : WorkerLogOutput
{
	public string? Caller { get; set; } = string.Empty;
}

To use either of thoes two console log options you have to change the formatter value in serilog options:

"formatter": "Voyager.Serilog.Settings.Configuration.Formatters.WorkerSerilogFormatter, Voyager.Serilog.Settings.Configuration"

or

"formatter": "Voyager.Serilog.Settings.Configuration.Formatters.BackendSerilogFormatter, Voyager.Serilog.Settings.Configuration"

• Back to top