Skip to content

README.md

Latest commit

 

History

History
61 lines (43 loc) · 1.3 KB

README.md

File metadata and controls

61 lines (43 loc) · 1.3 KB

TCSystem.Logging

NuGet

Wraps Serilog behind an abstract Logger class where debug logging is not compiled into your code when building in Release mode (using [Conditional("DEBUG")]).

Installation

dotnet add package TCSystem.Logging

Features

  • Abstract Logger class with conditional debug logging
  • Namespace-scoped logging via static Log.cs per namespace
  • Console, file, and debug output sinks
  • Async sink support for non-blocking log writes
  • Thread enrichment for log context

Dependencies

  • Serilog
  • Serilog.Enrichers.Thread
  • Serilog.Sinks.Async
  • Serilog.Sinks.Console
  • Serilog.Sinks.Debug
  • Serilog.Sinks.File

Targets

  • netstandard2.1
  • net8.0
  • net10.0

Usage

Initialize Logging

Factory.InitLogging(Factory.LoggingOptions.Console | Factory.LoggingOptions.File,
                    "Output.txt", 1, 10 * 1024);

Create a Log.cs in each namespace

namespace Hello.World;

internal static class Log
{
    public static Logger Instance { get; } = Factory.GetLogger(typeof(Log));
}

Log messages

Log.Instance.Info("Hello World");
Log.Instance.Debug("This is only compiled in Debug builds");