CSharpEssentials.LoggerHelper.Sink.Postgresql 5.2.2

CSharpEssentials.LoggerHelper.Sink.Postgresql

PostgreSQL structured log storage with JSONB support and custom columns for CSharpEssentials.LoggerHelper.

Part of the CSharpEssentials.LoggerHelper ecosystem — install only the sinks you need.

Install

dotnet add package CSharpEssentials.LoggerHelper
dotnet add package CSharpEssentials.LoggerHelper.Sink.Postgresql

Quick Setup — JSON

{
 "LoggerHelper": {
 "ApplicationName": "MyApp",
 "Routes": [
 { "Sink": "Postgresql", "Levels": ["Warning", "Error", "Fatal"] }
 ],
 "Sinks": {
 "Postgresql": {
 "ConnectionString": "Host=localhost;Database=logs;Username=app;Password=secret",
 "TableName": "app_logs",
 "NeedAutoCreateTable": true
 }
 }
 }
}

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

Quick Setup — Fluent API

builder.Services.AddLoggerHelper(b => b
 .WithApplicationName("MyApp")
 .AddRoute("Postgresql", LogEventLevel.Warning, LogEventLevel.Error, LogEventLevel.Fatal)
 .ConfigurePostgreSql(p => {
 p.ConnectionString = "Host=localhost;Database=logs;Username=app;Password=secret";
 p.TableName = "app_logs";
 p.NeedAutoCreateTable = true;
 })
);

Configuration Options

Default Columns

When Columns is omitted the sink creates this table automatically:

Custom Columns — Replicate or Extend the Default Schema

Use Columns to define exactly which columns the sink writes. When Columns is present it replaces the default set entirely.

Example A — Replicating the default schema via JSON

"Sinks": {
 "Postgresql": {
 "ConnectionString": "Host=localhost;Database=logs;Username=app;Password=secret",
 "TableName": "app_logs",
 "NeedAutoCreateTable": true,
 "Columns": [
 { "Name": "ApplicationName", "Writer": "Single", "Type": "Text", "Property": "ApplicationName" },
 { "Name": "message", "Writer": "Rendered", "Type": "Text" },
 { "Name": "message_template","Writer": "Template", "Type": "Text" },
 { "Name": "level", "Writer": "Level", "Type": "Varchar" },
 { "Name": "raise_date", "Writer": "Timestamp", "Type": "Timestamp" },
 { "Name": "exception", "Writer": "Exception", "Type": "Text" },
 { "Name": "properties", "Writer": "Serialized","Type": "Jsonb" },
 { "Name": "MachineName", "Writer": "Single", "Type": "Text", "Property": "MachineName" },
 { "Name": "Action", "Writer": "Single", "Type": "Text", "Property": "Action" },
 { "Name": "IdTransaction", "Writer": "Single", "Type": "Text", "Property": "IdTransaction" }
 ]
 }
}

Example B — Custom schema with application-specific properties

Add only the columns you need, including custom properties pushed via BeginScope:

"Columns": [
 { "Name": "message", "Writer": "Rendered", "Type": "Text" },
 { "Name": "level", "Writer": "Level", "Type": "Varchar" },
 { "Name": "raise_date", "Writer": "Timestamp", "Type": "Timestamp" },
 { "Name": "exception", "Writer": "Exception", "Type": "Text" },
 { "Name": "properties", "Writer": "Serialized","Type": "Jsonb" },
 { "Name": "TenantId", "Writer": "Single", "Type": "Text", "Property": "TenantId" },
 { "Name": "UserId", "Writer": "Single", "Type": "Text", "Property": "UserId" },
 { "Name": "RequestId", "Writer": "Single", "Type": "Text", "Property": "RequestId" }
]

Populate the custom properties at runtime with BeginScope:

using (_logger.BeginScope(new Dictionary<string, object?> {
 ["TenantId"] = "acme",
 ["UserId"] = "usr_99",
 ["RequestId"] = HttpContext.TraceIdentifier
}))
{
 _logger.LogWarning("Payment failed for order {OrderId}", orderId);
}

Property is required only for Writer: "Single" when the column name differs from the Serilog property name. If Name and the property name match, you can omit Property.

PostgreSqlColumnConfig reference

Writer values:

Links

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