CSharpEssentials.LoggerHelper.Sink.MSSqlServer 5.2.2.5

CSharpEssentials.LoggerHelper.Sink.MSSqlServer

SQL Server structured log storage with auto table creation and custom columns for CSharpEssentials.LoggerHelper.

Targets: net8.0 · net9.0 · net10.0 — Part of the CSharpEssentials.LoggerHelper ecosystem. Install only the sinks you need.

Install

dotnet add package CSharpEssentials.LoggerHelper
dotnet add package CSharpEssentials.LoggerHelper.Sink.MSSqlServer

Quick Setup — JSON

Add to appsettings.json:

{
  "LoggerHelper": {
    "ApplicationName": "MyApp",
    "Routes": [
      { "Sink": "MSSqlServer", "Levels": ["Warning", "Error", "Fatal"] }
    ],
    "Sinks": {
      "MSSqlServer": {
        "ConnectionString": "Server=.;Database=Logs;Trusted_Connection=true;TrustServerCertificate=true",
        "TableName": "AppLogs",
        "AutoCreateSqlTable": true,
        "BatchPostingLimit": 100,
        "Period": "0.00:00:10"
      }
    }
  }
}

// Program.cs
builder.Services.AddLoggerHelper(builder.Configuration);

var app = builder.Build();
app.UseLoggerHelper();   // ← required: activates sinks and registers middleware

AutoCreateSqlTable: true creates the table on first run if it does not already exist. Set to false if you manage schema migrations yourself.

Quick Setup — Fluent API

builder.Services.AddLoggerHelper(b => b
    .WithApplicationName("MyApp")
    .AddRoute("MSSqlServer", LogEventLevel.Warning, LogEventLevel.Error, LogEventLevel.Fatal)
    .ConfigureMSSqlServer(s => {
        s.ConnectionString  = "Server=.;Database=Logs;Trusted_Connection=true;TrustServerCertificate=true";
        s.TableName         = "AppLogs";
        s.AutoCreateSqlTable = true;
    })
);

var app = builder.Build();
app.UseLoggerHelper();   // ← required

What You'll See

Log events are batched and inserted as rows into the configured table. Default columns created by AutoCreateSqlTable:

Custom Columns — Map Log Properties to SQL Columns

Use AdditionalColumns to promote any log property into a dedicated, queryable column.

"Sinks": {
  "MSSqlServer": {
    "ConnectionString": "...",
    "TableName": "AppLogs",
    "AdditionalColumns": [
      { "ColumnName": "TenantId",   "DataType": "NVarChar", "DataLength": 100, "AllowNull": true },
      { "ColumnName": "RequestId",  "DataType": "NVarChar", "DataLength": 50,  "AllowNull": true },
      { "ColumnName": "UserId",     "DataType": "NVarChar", "DataLength": 50,  "AllowNull": true }
    ]
  }
}

Then populate those properties at runtime using BeginScope or LogContext.PushProperty:

// Option A — BeginScope (preferred for scoped operations)
using (_logger.BeginScope(new Dictionary<string, object?> {
    ["TenantId"]  = "acme",
    ["RequestId"] = HttpContext.TraceIdentifier
}))
{
    _logger.LogWarning("Payment failed for order {OrderId}", orderId);
}

// Option B — LogContext (Serilog-specific)
using (Serilog.Context.LogContext.PushProperty("UserId", userId))
{
    _logger.LogError("Unauthorized access attempt");
}

The ColumnName must exactly match the log property name (case-insensitive). The column is created automatically when AutoCreateSqlTable: true.

Configuration Options

AdditionalColumnConfig

Troubleshooting

Links

• Documentation
• CSharpEssentials.LoggerHelper (core)
• GitHub Repository
• MIT License