WorkflowForge.Extensions.Logging.Serilog 2.1.1

WorkflowForge.Extensions.Logging.Serilog

Structured logging extension for WorkflowForge with Serilog integration for rich, queryable logs.

Dependency Isolation

This extension internalizes Serilog with ILRepack. This means:

• Reduced dependency conflicts for Serilog
• Public APIs stay WorkflowForge/BCL only
• Microsoft/System assemblies remain external

Installation

dotnet add package WorkflowForge.Extensions.Logging.Serilog

Requires: .NET Standard 2.0 or later

Quick Start

using WorkflowForge;
using WorkflowForge.Extensions.Logging.Serilog;

var logger = SerilogLoggerFactory.CreateLogger(new SerilogLoggerOptions
{
    MinimumLevel = "Information",
    EnableConsoleSink = true
});

using var foundry = WorkflowForge.CreateFoundry("MyWorkflow", logger);

Key Features

• Structured Logging: Rich, queryable log data
• Multiple Sinks: Console, File, Elasticsearch, Seq, etc.
• Contextual Properties: Automatic workflow/operation context
• Log Levels: Fine-grained control (Verbose, Debug, Information, Warning, Error, Fatal)
• Performance: Minimal overhead with async logging
• Full Serilog Ecosystem: Access all Serilog sinks and enrichers

Configuration

Programmatic

var logger = SerilogLoggerFactory.CreateLogger(new SerilogLoggerOptions
{
    MinimumLevel = "Information",
    EnableConsoleSink = true
});

using var foundry = WorkflowForge.CreateFoundry("MyWorkflow", logger);

From appsettings.json

{
  "Serilog": {
    "MinimumLevel": "Information",
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "File",
        "Args": {
          "path": "logs/workflow-.txt",
          "rollingInterval": "Day"
        }
      }
    ]
  }
}

See Configuration Guide for complete options.

Structured Logging Examples

With Context

foundry.Logger.LogInformation(
    "Processing order {OrderId} for customer {CustomerId}",
    orderId,
    customerId);

With Properties

foundry.Logger.LogInformation(
    new Dictionary<string, string> { ["WorkflowId"] = workflowId },
    "Workflow started");
// Or use foundry.Logger.BeginScope(state, properties) for scoped context

Performance Metrics

var sw = Stopwatch.StartNew();
// ... operation ...
sw.Stop();

foundry.Logger.LogInformation(
    "Operation {OperationName} completed in {Duration}ms",
    operation.Name,
    sw.Elapsed.TotalMilliseconds);

Sink Configuration

Built-in Console Sink

The extension includes a built-in console sink configured via SerilogLoggerOptions:

var logger = SerilogLoggerFactory.CreateLogger(new SerilogLoggerOptions
{
    EnableConsoleSink = true,
    MinimumLevel = "Debug"
});

Advanced Sinks (Host Integration)

For advanced sinks (File, Seq, Elasticsearch, etc.), use the CreateLogger(ILoggerFactory) overload with your host application's Serilog configuration:

// Configure Serilog in your host application (requires Serilog packages)
Log.Logger = new LoggerConfiguration()
    .WriteTo.File("logs/workflow.log")
    .WriteTo.Seq("http://localhost:5341")
    .CreateLogger();

var hostLoggerFactory = LoggerFactory.Create(builder => builder.AddSerilog());

// Create WorkflowForge logger from host configuration
var logger = SerilogLoggerFactory.CreateLogger(hostLoggerFactory);

This approach gives you access to the full Serilog sink ecosystem while keeping the extension dependency-free.

Documentation

• Getting Started
• Configuration Guide
• Extensions Overview
• Sample 13: Serilog Integration