Muonroi.Logging.Abstractions 1.0.0-alpha.16

Muonroi.Logging.Abstractions

Contracts-only package that defines the IMLog<T>, IMLogContext, and log-property conventions used across the Muonroi ecosystem.

This package ships the logging interfaces and property-key constants that consumer libraries depend on at compile time — no runtime behavior is included. Services that want structured logging take IMLog<T> by constructor injection; middleware and request handlers push ambient properties through IMLogContext. The concrete implementation lives in Muonroi.Logging.

Installation

dotnet add package Muonroi.Logging.Abstractions --prerelease

Quick Start

This package defines contracts only. Implement or inject IMLog<T> in your service; for tests or AOT scenarios you can supply a no-op implementation without taking a dependency on any logging provider:

using Muonroi.Logging.Abstractions;
using Microsoft.Extensions.Logging;

// Minimal no-op implementation — useful in tests or AOT hosts.
internal sealed class NoOpLog<T> : IMLog<T>
{
    private sealed class NullScope : IMLogContextScope
    {
        public static readonly NullScope Instance = new();
        public void Dispose() { }
    }

    public IMLogContextScope BeginProperty(string key, object? value) => NullScope.Instance;
    public void Info(string messageTemplate, params object?[] args) { }
    public void Warn(string messageTemplate, params object?[] args) { }
    public void Error(Exception? ex, string messageTemplate, params object?[] args) { }
    public void Debug(string messageTemplate, params object?[] args) { }
    public void InfoTrace(string messageTemplate, params object?[] args) { }

    public IDisposable? BeginScope<TState>(TState state) where TState : notnull => NullScope.Instance;
    public bool IsEnabled(LogLevel logLevel) => false;
    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state,
        Exception? exception, Func<TState, Exception?, string> formatter) { }
}

// Register with open-generic DI so every IMLog<T> request is satisfied:
services.AddSingleton(typeof(IMLog<>), typeof(NoOpLog<>));

For full structured logging in an ASP.NET Core application, use AddMuonroiLogging() from Muonroi.Logging:

builder.Logging.AddMuonroiLogging();

Features

• IMLog / IMLog<T> — structured logging interface extending ILogger / ILogger<T> with shorthand methods (Info, Warn, Error, Debug, InfoTrace) and BeginProperty scoping.
• IMLogFactory — factory interface for creating IMLog instances by type or category name.
• IMLogContext — ambient property bag; push key-value pairs into the logging context with PushProperty / PushProperties.
• IMLogContextScope — disposable scope returned by BeginProperty / PushProperty; disposing it removes the property from the context.
• LogPropertyConventions — static constants for standard structured-log property keys: TenantId, UserId, CorrelationId, TraceSessionId, RuleCode, RequestName.

API Reference

Samples

• Quickstart.Logging — ASP.NET Core API that demonstrates AddMuonroiLogging(), IMLog<T> injection, and IMLogContext.PushProperty scopes.
• Muonroi.Pdf.AotSample — shows a no-op IMLog<T> open-generic registration for AOT / trimmed hosts that cannot use the full Serilog provider.

Compatibility

• Target framework: net8.0
• License: Apache-2.0 (OSS)

Related Packages

• Muonroi.Logging — concrete implementation; registers MLog<T>, MLogContext, MLogFactory, and ILogScopeFactory via builder.Logging.AddMuonroiLogging().

License

Apache-2.0. See LICENSE-APACHE for details.