TSLAppLogger 1.0.2

TSLAppLogger

TSLAppLogger is a high-performance, asynchronous logging library for
.NET Framework 4.8, designed for telecom, server, and high-throughput applications.

It provides non-blocking logging, file rotation, log retention, and structured logging with minimal runtime overhead.

✨ Key Features

• ⚡ Asynchronous background logging (non-blocking)
• 🗂 Automatic file rotation (date & size based)
• 🧹 Log retention cleanup
• 🧩 Structured logging (key-value pairs)
• 📄 Optional JSON log format
• 🧵 Thread-safe & GC-optimized (object pooling)
• 🖥 Optional console logging
• 🎯 Optimized for high-throughput & telecom systems
• 🧠 C# 7.3 compatible
• 🪵 .NET Framework 4.8 supported

📦 Installation

NuGet Package Manager

Install-Package TSLAppLogger

.NET CLI

dotnet add package TSLAppLogger

🚀 Quick Start

using TSLAppLogger;

var logger = new Logger("MyClass");
logger.Info("Application started");

Logger.Shutdown();

⚙️ Logger Configuration (IMPORTANT)

Logger.Configure defines global logging behavior and must be called once during application startup (before creating any Logger instances).

Logger.Configure(
    string logRootDirectory = null,
    LogLevel? minimumLogLevel = null,
    bool? enableConsoleLogging = null,
    int? retentionDays = null,
    int? maxFileSizeMB = null,
    int? flushTimeoutMs = null,
    int? bufferSizeKB = null,
    bool? enableJsonLogging = null
);

🔧 Configuration Parameters Explained

logRootDirectory

• Root directory where log files are written
• Default: <ApplicationBaseDirectory>/logs
• Recommended to set explicitly in production

logRootDirectory: @"D:\ApplicationLogs"

minimumLogLevel

• Minimum severity level that will be logged
• Default: LogLevel.INFO
• Messages below this level are ignored
• LogLevel.OFF disables logging completely

minimumLogLevel: LogLevel.DEBUG

enableConsoleLogging

• Enables writing logs to the console
• Default: Environment.UserInteractive
• Recommended:
  • true for console apps
  • false for Windows services

enableConsoleLogging: Environment.UserInteractive

retentionDays

• Number of days logs are retained
• Old logs are deleted automatically
• Default: 7

retentionDays: 10

maxFileSizeMB

• Maximum size of a single log file
• When exceeded, a new file is created
• Default: 10 MB

maxFileSizeMB: 12

flushTimeoutMs

• Maximum time (milliseconds) the background worker waits before flushing logs
• Default: 1000
• Lower value → faster flush, more I/O
• Higher value → better throughput, slightly delayed writes

flushTimeoutMs: 1000

bufferSizeKB

• File stream buffer size
• Default: 64 KB
• Increase for very high log volumes

bufferSizeKB: 64

enableJsonLogging

• Enables JSON-formatted log output
• Default: false
• Useful for centralized log ingestion systems

enableJsonLogging: true

✅ Recommended Production Configuration

using System;
using System.IO;
using TSLAppLogger;

bool isInteractive = Environment.UserInteractive;

Logger.Configure(
    logRootDirectory: Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Logs"),
    minimumLogLevel: LogLevel.INFO,
    enableConsoleLogging: isInteractive,
    retentionDays: 10,
    maxFileSizeMB: 12,
    flushTimeoutMs: 1000,
    bufferSizeKB: 64,
    enableJsonLogging: false
);

🧱 Logger Usage Pattern

One Logger per Class (Best Practice)

private static readonly Logger _log =
    new Logger(nameof(MyService));

📝 Basic Logging

_log.Trace("Trace message");
_log.Debug("Debug message");
_log.Info("Information message");
_log.Warn("Warning message");
_log.Error("Error message");

🧩 Structured Logging

_log.Info(
    "User logged in",
    ("UserId", 1024),
    ("Role", "Admin"),
    ("Source", "UI")
);

🏷 Custom Property Logging

_log.SetCustomProperty(CustomProperty.CallID);
_log.Info(987654, "Incoming call received");

Example output:

[CallID-987654] - Incoming call received

📄 JSON Logging Example

{
  "ts": "2026-01-09T10:22:14.1234567Z",
  "lvl": "INFO",
  "cls": "MyService",
  "m": "ProcessCall",
  "msg": "Call connected"
}

📁 Log File Structure

Logs/
 └── 2026_Jan/
     ├── applog_2026-01-09_10-15-22_12345.log
     ├── applog_2026-01-09_14-40-02_54321.log

• Rotation by date and file size
• Automatic cleanup based on retention policy

🔚 Shutdown (CRITICAL)

Always flush logs before application exit:

Logger.Shutdown();

Required for:

• Console applications
• Windows services
• Long-running background processes

⚠️ Best Practices

• ✔ Call Logger.Configure() once at startup
• ✔ Use one static logger per class
• ✔ Prefer structured logging over string concatenation
• ✔ Avoid TRACE in production
• ✔ Always call Logger.Shutdown()
• ❌ Do not log inside tight loops at high verbosity

🧠 Designed For

• Telecom systems (TAPI, SIP, call flows)
• Windows Services
• High-volume server applications
• Background workers
• Long-running console apps

📜 License

MIT License © Telesoft Labs Pvt Ltd

🔗 Links

• NuGet: https://www.nuget.org/packages/TSLAppLogger