QERP.Logger 1.0.2

Qerp.LoggingPkg

Standardized logging library for QERP microservices based on Serilog and OpenTelemetry. It provides a unified way to configure structured logging, HTTP request monitoring, and distributed tracing across the ecosystem.

Features

• Structured Logging: Automatic indexing of log properties for efficient searching in Grafana Loki.
• Observability: Built-in support for W3C Trace Context, automatically attaching TraceId and SpanId to all log events.
• Pluggable Sinks: Configure multiple destinations with a single bitwise flag:
  • Console: Formatted human-readable output.
  • File: Structured JSON logs with rolling retention.
  • Loki: Direct push to Grafana Loki.
• HTTP Request Monitoring: Automatic logging of request path, method, client IP, and performance metrics.
• Noise Reduction: pre-configured filters to silence verbose framework logs.

Installation

Add the package via the project properties or CLI:

dotnet add package QERP.Logger

Quick Start

1. Register Logging in Host

In your Program.cs, use the extension methods to register the logging services:

using Qerp.LoggingPkg;

var builder = WebApplication.CreateBuilder(args);

// Register QERP Logging
builder.AddQerpLogging(options => 
{
    options.ApplicationName = "MyMicroservice";
    options.Environment = "Development";
    options.SinkType = LogSinkType.Console | LogSinkType.Loki;
    options.LokiUrl = "http://loki:3100";
});

var app = builder.Build();

// Enable HTTP Request Logging
app.UseQerpRequestLogging();

app.Run();

2. Using the Logger

Inject ILogger<T> into your services:

public class MyService(ILogger<MyService> logger)
{
    public void DoWork()
    {
        // Use structured logging (message templates)
        logger.LogInformation("Processing item {ItemId}", 123);
    }
}

Best Practices

• Avoid String Interpolation: Always use message templates (e.g., logger.LogInformation("User {UserId} logged in", userId)) to preserve structured data for Loki.
• Log Exceptions correctly: Pass the Exception object as the first parameter to LogError to ensure stack traces are captured.
• Trace Context: The package automatically handles distributed tracing. No manual TraceId attachment is required.

Documentation

For more detailed information, see:

• Architecture Overview
• How to Create Logs
• How to Publish to NuGet

License & Proprietary Notice

PROPRIETARY SOFTWARE: This library is a proprietary asset of QFL. Unauthorized redistribution, modification, or use outside of QFL-authorized projects is strictly prohibited.

For detailed licensing terms, see LICENSE.

Metadata

• Authors: Jewel Hossain
• License: QFL Proprietary