TCIS.Logging.Serilog 1.0.3

TCIS.Logging.Serilog

A provider that integrates Serilog into the TCIS logging system.

🌟 Overview

This module automatically configures Serilog as the primary logging provider for the entire application, replacing the default Microsoft logging. It allows you to easily route logs to storage systems such as Elasticsearch, Seq, or Files with flexible formats (e.g., JSON).

📦 Installation

Install the package via NuGet or .NET CLI:

dotnet add package TCIS.Logging.Serilog

⚙️ Configuration (appsettings.json)

Standard Serilog configuration (Sinks, Enrichers, etc.):

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.File" ],
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "WriteTo": [
      {
        "Name": "Console",
        "Args": {
          "formatter": "TCIS.Logging.Serilog.TCISEcsJsonFormatter, TCIS.Logging.Serilog"
        }
      },
      {
        "Name": "File",
        "Args": {
          "path": "Logs/log-.txt",
          "rollingInterval": "Day",
          "formatter": "TCIS.Logging.Serilog.TCISEcsJsonFormatter, TCIS.Logging.Serilog"
        }
      }
    ],
    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ]
  }
}

⚠️ formatter is mandatory on every sink, and it must be TCISEcsJsonFormatter.

MicrosoftLoggingSink emits log records as "{@TCISEcsDocument}", and AddTSerilog registers Destructure.AsScalar<TcisEcsDocument>() so the object reaches the formatter intact — TCISEcsJsonFormatter then calls the Elastic SDK's own Serialize().

Any sink without that formatter — including the plain console sink and CompactJsonFormatter, which this README previously showed — renders the scalar through ToString(). Every line comes out as the literal string TCIS.Logging.TcisEcsDocument: message, exception and stack trace are all gone. The lines are still there and the levels are still right, so it reads as working until someone needs a stack trace. Measured on a generated project, where it hid the real cause of a 500 for several runs.

🚀 Usage

In Program.cs, call the AddTSerilog() extension on WebApplicationBuilder (required for ASP.NET Core applications using WebApplicationBuilder):

using TCIS.Logging.Serilog.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to replace Microsoft Logging
builder.AddTSerilog();

var app = builder.Build();
app.Run();

💡 Basic Example

After adding AddTSerilog(), all logging calls from TCIS.Logging (via ILogWriter) will be automatically handled and enriched by Serilog. You simply continue to use ILogWriter as usual.