PayrollEngine.Serilog 0.10.0-beta.1

Payroll Engine Serilog

Part of the Payroll Engine open-source payroll automation framework. Full documentation at payrollengine.org.

Serilog logging extension for the Payroll Engine. This library provides a bridge between the Payroll Engine ILogger interface and Serilog, enabling structured logging through Serilog's rich ecosystem of sinks and enrichers.

Features

• Adapter implementation of PayrollEngine.ILogger using Serilog
• Configuration-based setup via IConfiguration (appsettings.json)
• Support for all log levels: Trace, Debug, Information, Warning, Error, Critical
• Structured logging with message templates and property values

NuGet Package

Available on NuGet.org:

dotnet add package PayrollEngine.Serilog

Usage

Setup

Register Serilog in your application startup using the SetupSerilog extension method:

using PayrollEngine.Serilog;

var builder = WebApplication.CreateBuilder(args);
builder.Configuration.SetupSerilog();   // configures Serilog and registers PayrollLog as ILogger

var app = builder.Build();

// ensure logs are flushed on shutdown
app.Lifetime.ApplicationStopped.Register(global::Serilog.Log.CloseAndFlush);

app.Run();

SetupSerilog() does two things:

1. Initialises Serilog.Log.Logger from the IConfiguration (reads the Serilog section of appsettings.json).
2. Registers a PayrollLog instance as the active PayrollEngine.Log logger so that all PE log calls are routed through Serilog.

Configuration

Configure Serilog in your appsettings.json:

{
  "Serilog": {
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "File",
        "Args": {
          "path": "logs/payroll-.log",
          "rollingInterval": "Day",
          "retainedFileCountLimit": 7
        }
      }
    ]
  }
}

Logging

Use the Payroll Engine Log class anywhere in your application:

using PayrollEngine;

Log.Information("Processing payroll for {TenantId}", tenantId);
Log.Warning("Retro payrun triggered for {EmployeeId}", employeeId);
Log.Error(exception, "Payroll calculation failed for {EmployeeId}", employeeId);

Shutdown

To ensure all buffered log events are written to sinks, call CloseAndFlush when the application shuts down:

global::Serilog.Log.CloseAndFlush();

Log Level Mapping

PayrollLog maps each PayrollEngine.ILogger method to the corresponding Serilog level:

The generic Write(LogLevel level, ...) overload casts the PE LogLevel enum value directly to Serilog.Events.LogEventLevel, so numeric values must match when using Write with an explicit level.

Architecture

The library consists of two components:

• PayrollLog — Implements PayrollEngine.ILogger and delegates all logging calls to the static Serilog.Log.Logger.
• ConfigurationExtensions — Provides the SetupSerilog() extension method on IConfiguration that initialises Serilog from configuration and registers PayrollLog as the active PayrollEngine.Log logger via Log.SetLogger().

Build

dotnet build -c Release
dotnet pack -c Release

Environment variable used during build:

Third Party Components

• Logging with Serilog — license Apache 2.0

See Also

• Payroll Engine Backend — uses this library
• Payroll Engine WebApp — uses this library
• Payroll Engine Console — uses this library
• Serilog documentation — sinks, enrichers, configuration