👁 Image
Oakrey.Applications.CustomLogging 3.0.5

Oakrey.Applications.CustomLogging

A flexible and extensible .NET logging library. It decouples the logging API from concrete logging destinations, supports broadcasting to multiple receivers simultaneously, and provides a ready-to-use WPF ViewModel for in-memory log binding.

Main features

• Multiple logging engines � console (color-coded), debug output, file, and in-memory
• Broadcasting � CustomLoggerBroadcast fans out every log call to any number of ICustomLogConsumer receivers
• Structured log entries � LogMessage record carries level, message, caller source, indent depth, and timestamp
• Log lifecycle � explicit StartLog / StopLog / ClearLog control on every consumer
• Indentation � IncreaseIndent / DecreaseIndent for structured hierarchical output
• Contextual logging � attach an IName context item to all active consumers
• WPF ViewModel � CustomLoggerViewModel exposes ObservableCollection<LogMessage> and INotifyPropertyChanged for direct XAML binding
• File path customization � ICustomLoggerFilePathProvider abstracts file naming; DocumentsCustomFilePathProvider writes date-stamped .txt files to My Documents\CustomLogs

Architecture

classDiagram
 class ICustomLogger {
 +LogInfo()
 +LogWarning()
 +LogError()
 +StartLog()
 +StopLog()
 +ClearLog()
 +IncreaseIndent()
 +DecreaseIndent()
 +SetCurrentContextItem()
 }

 class ICustomLogConsumer {
 +Log(LogMessage)
 +StartLog()
 +StopLog()
 +ClearLog()
 +SetCurrentContextItem()
 }

 class CustomLoggerBroadcast {
 -IEnumerable~ICustomLogConsumer~ receivers
 }

 ICustomLogger <|.. CustomLoggerBroadcast
 CustomLoggerBroadcast --> ICustomLogConsumer : fans out to
 ICustomLogConsumer <|.. ConsoleCustomLogger
 ICustomLogConsumer <|.. FileCustomLogger
 ICustomLogConsumer <|.. DebugCustomLogger
 ICustomLogConsumer <|.. CustomLoggerViewModel

The key design split:

• ICustomLogger � the interface used by application code to emit log entries
• ICustomLogConsumer � the interface implemented by each logging engine
• CustomLoggerBroadcast � bridges the two, routing every ICustomLogger call to all registered consumers

Requirements

• .NET 10 or higher
• Windows (due to net10.0-windows target; WPF types in CustomLoggerViewModel)

Installation

NuGet Package Manager

Search for Oakrey.Applications.CustomLogging in Tools > NuGet Package Manager > Manage NuGet Packages for Solution.

.NET CLI

dotnet add package Oakrey.Applications.CustomLogging

Package Manager Console

Install-Package Oakrey.Applications.CustomLogging

Example usage

Basic broadcast setup

// Compose consumers
CustomLoggerViewModel viewModel = new();
FileCustomLogger fileLogger = new(new DocumentsCustomFilePathProvider());
ConsoleCustomLogger consoleLogger = new();

// Create broadcast
ICustomLogger logger = new CustomLoggerBroadcast([viewModel, fileLogger, consoleLogger]);

// Use
logger.StartLog("MySession");
logger.LogInfo("Application started");

logger.IncreaseIndent();
logger.LogWarning("Configuration value missing, using default");
logger.DecreaseIndent();

logger.LogError("Unhandled exception occurred");
logger.StopLog();

WPF binding

Bind the CustomLoggerViewModel directly in XAML:

<ListView ItemsSource="{Binding LogMessages}">
 <ListView.ItemTemplate>
 <DataTemplate>
 <TextBlock Text="{Binding Message}" />
 </DataTemplate>
 </ListView.ItemTemplate>
</ListView>

Custom file path provider

Implement ICustomLoggerFilePathProvider to control where and how log files are named:

public class AppFilePathProvider : ICustomLoggerFilePathProvider
{
 public DirectoryInfo GetDirectoryPath() => new(@"C:\Logs\MyApp");
 public FileInfo GetFileInfo() => new($@"C:\Logs\MyApp\log_{DateTime.Now:yyyyMMdd}.txt");
}

Custom consumer

Implement ICustomLogConsumer to add any new logging destination:

public class DatabaseLogConsumer : ICustomLogConsumer
{
 public void Log(LogMessage message) { /* insert to DB */ }
 public void StartLog(string name) { }
 public void StopLog() { }
 public void ClearLog() { }
 public void SetCurrentContextItem(IName item) { }
}

Configuration

Development notes

• FileCustomLogger is IDisposable. Dispose it (or call StopLog) to flush and close the underlying FileStream.
• CustomLoggerBroadcast tracks a single shared indent level and propagates it to every consumer via LogMessage.IndentLevel.
• [CallerMemberName] is used on source parameters so the calling method name is captured automatically without explicit argument passing.
• Dependencies: Oakrey.Collections (for IName and ForEach), Oakrey.Files (for FileNameSource / FileNamingPolicy).

Project information

• Author: Oakrey
• License: MIT
• Repository: ApplicationServices
• NuGet: Oakrey.Applications.CustomLogging

License

This project is licensed under the MIT License. See the LICENSE file for details.