HaemmerElectronics.SeppPenner.SerilogSinkForPostgreSQL 1.0.3

SerilogSinkForPostgreSQL

SerilogSinkForPostgreSQL is a library to save logging information from Serilog to PostgreSQL. The assembly was written and tested in .Net Framework 4.8 and .Net Standard 2.0.

Available for

• NetFramework 4.5
• NetFramework 4.6
• NetFramework 4.6.2
• NetFramework 4.7
• NetFramework 4.7.2
• NetFramework 4.8
• NetStandard 2.0

Basic usage:

string connectionString = "User ID=serilog;Password=serilog;Host=localhost;Port=5432;Database=Logs";

string tableName = "logs";

IDictionary<string, ColumnWriterBase> columnWriters = new Dictionary<string, ColumnWriterBase>
{
    { "message", new RenderedMessageColumnWriter(NpgsqlDbType.Text) },
    { "message_template", new MessageTemplateColumnWriter(NpgsqlDbType.Text) },
    { "level", new LevelColumnWriter(true, NpgsqlDbType.Varchar) },
    { "raise_date", new TimestampColumnWriter(NpgsqlDbType.TimestampTz) },
    { "exception", new ExceptionColumnWriter(NpgsqlDbType.Text) },
    { "properties", new LogEventSerializedColumnWriter(NpgsqlDbType.Jsonb) },
    { "props_test", new PropertiesColumnWriter(NpgsqlDbType.Jsonb) },
    { "machine_name", new SinglePropertyColumnWriter("MachineName", PropertyWriteMethod.ToString, NpgsqlDbType.Text, "l") }
};

var logger = new LoggerConfiguration()
	.WriteTo.PostgreSQL(connectionString, tableName, columnWriters)
	.CreateLogger();

The project can be found on nuget.

Configuration options:

|Parameter|Meaning|Example|Default value| |-|-|-|-| |connectionString|The connection string to connect to the PostgreSQL database.|"User ID=serilog;Password=serilog;Host=localhost;Port=5432;Database=Logs"|None, is mandatory.| |tableName|The table name to write the data to. Is case-sensitive!|"logs"|None, is mandatory.| |period|The time to wait between checking for event batches.|period: new TimeSpan(0, 0, 20)|00:00:05| |formatProvider|The IFormatProvider to use. Supplies culture-specific formatting information. Check https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider?view=netframework-4.8.|`new CultureInfo("de-DE")|null| |columnOptions|The column options to use.|See the examples under the [Full example](https://github.com/SeppPenner/SerilogSinkForPostgreSQL#full-example) section below.|null| |batchSizeLimit|The maximum number of events to include in a single batch.|batchSizeLimit: 40|30| |useCopy|Enables the copy command to allow batch inserting instead of multiple INSERT commands.|useCopy: true|true| |schemaName|The schema in which the table should be created.|schemaName: "Logs"|string.Emptywhich defaults to the PostgreSQLpublic schema.| |needAutoCreateTable|Specifies whether the table should be auto-created if it does not already exist or not.|needAutoCreateTable: true|false| |queueLimit|Maximum number of events in the queue.|queueLimit: 3000|int.MaxValueor2147483647`|

Full example

string connectionString = "User ID=serilog;Password=serilog;Host=localhost;Port=5432;Database=Logs";

string tableName = "logs";

IDictionary<string, ColumnWriterBase> columnOptions = new Dictionary<string, ColumnWriterBase>
{
    { "message", new RenderedMessageColumnWriter(NpgsqlDbType.Text) },
    { "message_template", new MessageTemplateColumnWriter(NpgsqlDbType.Text) },
    { "level", new LevelColumnWriter(true, NpgsqlDbType.Varchar) },
    { "raise_date", new TimestampColumnWriter(NpgsqlDbType.TimestampTz) },
    { "exception", new ExceptionColumnWriter(NpgsqlDbType.Text) },
    { "properties", new LogEventSerializedColumnWriter(NpgsqlDbType.Jsonb) },
    { "props_test", new PropertiesColumnWriter(NpgsqlDbType.Jsonb) },
    { "machine_name", new SinglePropertyColumnWriter("MachineName", PropertyWriteMethod.ToString, NpgsqlDbType.Text, "l") }
};

var logger = new LoggerConfiguration()
	.WriteTo.PostgreSQL(connectionString, tableName, columnOptions, needAutoCreateTable: true, schemaName: "LoggingSchema", useCopy: true, queueLimit: 3000, batchSizeLimit: 40, period: new TimeSpan(0, 0, 10), formatProvider: null)
	.CreateLogger();

Adjusting column sizes

You can change column sizes by setting the values in the TableCreator class:

// Sets size of all BIT and BIT VARYING columns to 20
TableCreator.DefaultBitColumnsLength = 20;

// Sets size of all CHAR columns to 30
TableCreator.DefaultCharColumnsLength = 30;

// Sets size of all VARCHAR columns to 50
TableCreator.DefaultVarcharColumnsLength = 50;

Upper or lower case table or column names

Table or column names are always case-sensitive!

Further information:

This project is a fork of https://github.com/b00ted/serilog-sinks-postgresql but is maintained. Do not hesitate to create issues or pull requests.

Change history

• Version 1.0.3.0 (2019-06-23) : Added icon to the nuget package.
• Version 1.0.2.0 (2019-05-13) : Updated documentation, fixed some tests.
• Version 1.0.1.0 (2019-05-08) : Updated documentation, added documentation to the nuget package and all classes, added option to allow upper case table and column names. Simplified building and packing scripts. Added support for NetFramework 4.6, NetFramework 4.6.2, NetFramework 4.7 and NetFramework 4.8.
• Version 1.0.0.0 (2019-02-22) : 1.0 release.