Easy.Logging

Easy.Logging is a high-performance, thread-safe, and asynchronous logging library for .NET applications.

It is designed to handle high-throughput scenarios by leveraging System.Threading.Channels for background processing (Fire-and-Forget), ensuring your application's main thread is never blocked by I/O operations.

Features

• ** High Performance:** Uses BufferedSink to offload logging to a background thread, preventing I/O bottlenecks.
• ** Thread-Safe:** Safe to use in multi-threaded environments and supports Singleton/Scoped DI lifetimes correctly.
• ** Multi-Sink:** Built-in support for Console, Rolling File, Redis, and Database (EF Core).
• ** Structured Logging:** Supports structured data (Properties) for advanced querying in log management systems.
• ** Colored Console:** Auto-colorized console output based on log severity for better readability.
• ** Cross-Platform:** Supports .NET 8+, .NET 6, .NET Standard 2.0/2.1, and .NET Framework 4.7.2+.

Installation

Install via NuGet Package Manager:

Install-Package Easy.Logging

Or via .NET CLI:

dotnet add package Easy.Logging

Quick Start

1. Registration (Program.cs)

Register the core services and the specific sinks you need. The library automatically wraps heavy sinks (like File/Redis) in a BufferedSink for performance.

using Easy.Logging.Extensions; var builder = WebApplication.CreateBuilder(args); // 1. Add Easy Logging Core builder.Services.AddEasyLogging(); // 2. Add Sinks (Destinations) builder.Services.AddConsoleLogger(); // Colored Console builder.Services.AddRollingFileLogger("Logs"); // Daily rolling files (e.g., log-2023-10-01.txt) builder.Services.AddRedisLogger("localhost:6379", "app-logs"); // Pushes to a Redis List // builder.Services.AddDatabaseLogger<AppDbContext>(); // Writes to SQL DB via EF Core var app = builder.Build();

2. Usage (Controller / Service)

Inject the Easy.Logging.Core.ILogger interface (not Microsoft's ILogger) into your classes.

using Easy.Logging.Core; using Microsoft.AspNetCore.Mvc; public class OrderController : ControllerBase { private readonly ILogger _logger; public OrderController(ILogger logger) { _logger = logger; } [HttpPost] public async Task<IActionResult> CreateOrder(OrderDto order) { // 1. Simple Info Log await _logger.InfoAsync("Processing new order...", context: "OrderController"); try { // Business Logic... throw new Exception("Payment gateway timeout."); } catch (Exception ex) { // 2. Error Log with Exception await _logger.ErrorAsync("Failed to process order.", exception: ex.ToString()); } // 3. Structured Log (Best for searching/filtering) await _logger.LogAsync(new LogEntry { Level = LogLevel.Warn, Message = "High value transaction detected", Properties = new Dictionary<string, object> { { "OrderId", order.Id }, { "Amount", order.Amount }, { "Currency", "USD" } } }); return Ok(); } }

Architecture

The library follows a modular Logger vs. Sink architecture:

Component	Description
ILogger (CompositeLogger)	The "Manager". It receives log entries from your code and broadcasts them to all registered sinks.
ILogSink (The Workers)	The actual destinations where logs are written (e.g., ConsoleSink, FileSink, RedisSink).
BufferedSink (The Buffer)	A decorator that wraps slow sinks (File/DB). It holds logs in a memory queue (Channel<T>) and writes them in the background, ensuring your app stays fast.
ILogFormatter	Converts the LogEntry object into a string format (Default is JSON).

Sinks

• ConsoleSink: Logs to the console
• RollingFileSink: Logs to daily rolling files
• RedisSink: Logs to Redis lists
• DatabaseSink: Logs to a database (Entity Framework/EF Core)
• BufferedSink: Buffers logs and writes asynchronously
• CompositeLogger: Dispatches logs to multiple sinks

Database Logging (EF Core)

To use the Database Sink, your DbContext must implement the ILogDbContext interface.

1. Implement Interface in DbContext:

   public class AppDbContext : DbContext, ILogDbContext { public DbSet<LogRecord> Logs { get; set; } // The table for logs }

2. Register in Program.cs:

   builder.Services.AddDatabaseLogger<AppDbContext>();

---

Contributing

Contributions and suggestions are welcome. Please open an issue or submit a pull request.

---

Contact

For questions, contact us via elmin.alirzayev@gmail.com or GitHub.

---

License

This project is licensed under the MIT License.

---

© 2025 Elmin Alirzayev / Easy Code Tools