Serilog.Extensions 10.0.0

Serilog Extensions for .NET

A lightweight library to simplify Serilog integration in .NET applications. It provides fluent extension methods for WebApplicationBuilder, IHostBuilder, and IServiceCollection, along with powerful conditional logging capabilities.

🚀 Features

• Zero-Config Setup: Get running with sensible defaults in one line.
• Fluent Integration: Supports all modern .NET hosting patterns.
• External JSON Config: Manage Serilog settings in separate files (e.g., appsettings.serilog.json).
• Conditional Logging: Log messages based on boolean conditions (Assert, When, WhenNot).
• Auto-Enrichment: Pre-configured with Process, Thread, and Environment enrichers.

📦 Installation

dotnet add package Serilog.Extensions

🛠️ Quick Start

WebApplicationBuilder (.NET 6/7/8/9/10+)

using Serilog.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Setup Serilog using appsettings.json
builder.UseSerilog(); 

var app = builder.Build();
app.UseSerilogRequestLogging(); // Optional: Add request logging middleware
app.Run();

Generic Host (Worker Services / Console)

using Serilog.Extensions;

Host.CreateDefaultBuilder(args)
    .UseSerilog() // Uses host configuration
    .Build()
    .Run();

⚙️ Advanced Configuration (External JSON)

If you prefer to keep your logging configuration separate from your main appsettings.json, use UseSerilogJson().

1. Update appsettings.json

Add the location of your logging config:

{
  "JsonFileSettingsOptions": [
    {
      "Filename": "serilog.config.json",
      "Optional": false,
      "ReloadOnChange": true
    }
  ]
}

2. Configure Builder

builder.UseSerilogJson();

3. Properties Table

🔍 Conditional Logging

Stop wrapping log calls in if statements. Use the built-in conditional extensions for cleaner code.

The Assert Pattern

Logs a message only if the condition is false (ideal for validation).

// Logs Error only if user is null
logger.AssertError(user != null, "User not found in database");

// Logs Warning if count is not greater than 0
logger.AssertWarning(items.Count > 0, "Processing an empty list");

The When Pattern

Explicitly log based on truthiness.

// Logs only when true
logger.InfoWhen(isNewUser, "Sending welcome email to {Email}", email);

// Logs only when false
logger.DebugWhenNot(isCacheHit, "Fetching data from remote API...");

Methods available for all levels: Trace, Debug, Info, Warn, Error, Critical.

🧪 Manual Initialization

If you are not using Dependency Injection, you can use the LoggerFactory directly:

using Serilog.Extensions.Services;

// Create a logger with default settings
var logger = LoggerFactory.New();

// Create a logger from a specific config file
var logger = LoggerFactory.New("path/to/config.json");

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.