WorkflowForge.Extensions.Logging.Serilog 2.0.0

WorkflowForge.Extensions.Logging.Serilog

<p align="center"> <img src="https://raw.githubusercontent.com/animatlabs/workflow-forge/main/icon.png" alt="WorkflowForge" width="120" height="120"> </p>

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.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

using (LogContext.PushProperty("WorkflowId", workflow.Id))
{
    foundry.Logger.LogInformation("Workflow started");
    // All logs in this scope include WorkflowId
}

Performance Metrics

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

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

Sinks

Console Sink

.WriteTo.Console(outputTemplate: 
    "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")

File Sink

.WriteTo.File(
    "logs/workflow-.txt",
    rollingInterval: RollingInterval.Day,
    retainedFileCountLimit: 7)

Seq Sink

.WriteTo.Seq("http://localhost:5341")

Elasticsearch Sink

.WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri("http://localhost:9200")))

Documentation

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