DevElf.Logging 0.4.3-alpha.0

DevElf.Logging

Advanced logging utilities that extend Microsoft.Extensions.Logging with disposable message scopes, property accumulation, and strict LIFO enforcement.

Features

• Disposable log message scopes - Create scopes that log messages when disposed
• Property accumulation - Build structured log data across nested scopes
• Strict LIFO enforcement - Safety warnings for out-of-order scope disposal
• Exception handling - Attach exceptions and modify messages before logging
• Dynamic log levels - Change log level and message content before disposal

Installation

dotnet add package DevElf.Logging

Quick Start

Setup Dependency Injection

using DevElf.Logging;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

var services = new ServiceCollection()
    .AddLogging(builder => builder.AddConsole())
    .AddLogMessageScopes(); // Register log message scope services

var provider = services.BuildServiceProvider();
var logger = provider.GetRequiredService<ILogger<MyService>>();

Basic Usage

using var scope = logger.BeginMessageScope(LogLevel.Information, "Processing user request");
scope.SetProperty("UserId", userId);
scope.SetProperty("RequestId", requestId);

// Do work...

// Message is logged on dispose with all accumulated properties

Advanced Usage with Exception Handling

using var scope = logger.BeginMessageScope(LogLevel.Information, new EventId(1001, "DataImport"), "Starting data import");
scope.SetProperty("FileName", fileName);
scope.SetProperty("CorrelationId", correlationId);

try
{
    // Perform import operation
    var recordCount = await ImportDataAsync(fileName);
    scope.SetProperty("RecordCount", recordCount);
}
catch (Exception ex)
{
    scope.SetException(ex, setProperty: true); // Adds exception as property and sets Exception
    scope.ChangeLogLevel(LogLevel.Error);      // Change from Information to Error
    scope.ChangeMessage("Data import failed"); // Update the message
    throw;
}
// Logs either success or failure message with all properties

Nested Scopes

using var outerScope = logger.BeginMessageScope(LogLevel.Information, "Processing batch");
outerScope.SetProperty("BatchId", batchId);
outerScope.SetProperty("Environment", "Production");

foreach (var item in batch)
{
    using var innerScope = logger.BeginMessageScope(LogLevel.Debug, "Processing item");
    innerScope.SetProperty("ItemId", item.Id);
    innerScope.SetProperty("Environment", "Staging"); // Overrides parent value
    
    // Process item...
    
    // Inner scope logs with: BatchId, ItemId, Environment="Staging"
}

// Outer scope logs with: BatchId, Environment="Production"

API Reference

ILogMessageScope

Logger Extensions

Important Notes

Requirements

• .NET 10.0+
• Microsoft.Extensions.Logging.Abstractions

Dependencies

• DevElf - Core argument validation utilities

License

This project is licensed under the MIT License.