Common.Logging.Lib 1.0.2

Here’s a README.md file for your Common.Logging .NET 8 project:

Common.Logging for .NET 8

This project provides a common logging configuration for .NET 8 applications, utilizing Serilog for structured logging.

Features

• Serilog Integration: Configures Serilog with JSON-formatted logs.
• Console Logging: Outputs logs to both stdout and stderr.
• Log Context Enrichment: Adds contextual information to logs.
• Configurable Log Levels: Allows dynamic configuration from appsettings.json.

Installation

1. Install required NuGet packages:

   dotnet add package Serilog.AspNetCore
   dotnet add package Serilog.Settings.Configuration
   dotnet add package Serilog.Sinks.Console
   

2. Add logging configuration to appsettings.json:

   {
     "Serilog": {
       "MinimumLevel": {
         "Default": "Information",
         "Override": {
           "Microsoft": "Information"
         }
       },
       "WriteTo": [
         {
           "Name": "Console",
           "Args": { "formatter": "Serilog.Formatting.Json.JsonFormatter" }
         }
       ],
       "Enrich": ["FromLogContext"]
     }
   }
   

Usage

Add the logging configuration to your Program.cs:

using Microsoft.Extensions.Hosting;
using Serilog;
using Serilog.Events;
using Serilog.Formatting.Json;

public static class LoggingExtensions
{
    public static IHostBuilder UseUniversalLogging(this IHostBuilder hostBuilder)
    {
        hostBuilder.UseSerilog((context, services, loggerConfiguration) =>
        {
            loggerConfiguration
                .ReadFrom.Configuration(context.Configuration)
                .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
                .Enrich.FromLogContext()
                .WriteTo.Console(new JsonFormatter()) // Writes logs to console
                .WriteTo.Console(new JsonFormatter(), standardErrorFromLevel: LogEventLevel.Verbose); // Writes logs to stdout
        });

        return hostBuilder;
    }
}

Then, apply it in Program.cs:

var builder = Host.CreateDefaultBuilder(args)
    .UseUniversalLogging();

Deployment Notes

• Ensure your logging configuration is correctly set in appsettings.json or environment variables.
• In Kubernetes environments, logs will be structured in JSON for better compatibility with log aggregators like Fluentd or Loki.

Contributing

1. Fork the repository.
2. Create a new branch: git checkout -b feature-branch
3. Commit changes: git commit -m "Added new feature"
4. Push and create a PR.

Let me know if you need any modifications! 🚀