How to Configure App.config to Remove Standard Columns in Serilog's MSSQL Logger

Описание: A comprehensive guide to configuring `App.config` for Serilog logging, focusing on how to remove specific standard columns from the MSSQL database. Learn about customization options for your logging system today!
---
This video is based on the question https://stackoverflow.com/q/71968866/ asked by the user 'mustafa00' ( https://stackoverflow.com/u/14676485/ ) and on the answer https://stackoverflow.com/a/72052560/ provided by the user 'Phil Bevan' ( https://stackoverflow.com/u/18501061/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How to configure App.config to remove Serilog.Sinks.MSSqlServer standard columns?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Configure App.config to Remove Standard Columns in Serilog's MSSQL Logger

Logging is an essential part of any software application, and when using Serilog with MSSQL as your logging sink, you may want to customize the structure of your log entries in the database. One common requirement is to remove standard columns like StandardColumn.Properties and StandardColumn.MessageTemplate from the Logs table. In this guide, we will walk you through the steps to configure your App.config file to achieve this.

The Problem

When integrating Serilog with MSSQL, the default logging structure includes certain standard columns that might not be necessary for your use case. Removing these columns helps in simplifying the data structure or focusing on specific log attributes that are more relevant to your application's monitoring needs.

The Solution: Configuring App.config

To customize your logging configuration in App.config, you will make use of MSSqlServerSettingsSection. This section allows you to modify settings specific to the MSSQL sink, including the ability to remove standard columns and add new ones. Here's how to do it step by step:

Step 1: Define the Configuration Section

First, ensure that you define the configuration section for MSSQL logging. Add the following code to your App.config:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Key Components Explained

MSSqlServerSettingsSection: This section contains specific settings for the MSSQL sink and is required for configuring how logs are stored in the database.

RemoveStandardColumns: Here, you specify which standard columns to remove from your Logs table. In this case, Properties is being removed.

Columns: In addition to removing columns, you can also add new columns, as shown with the addition of a RunId integer column.

Step 3: Logging with the New Configuration

With the configuration in place, you can now log messages that include RunId. When you call:

[[See Video to Reveal this Text or Code Snippet]]

The logs will be written to your configured sinks (File, Console, MSSqlServer).

If the Logs table does not exist, it will be created with the defined structure – including the removal of the specified standard columns.

Conclusion

Configuring Serilog to meet specific logging requirements in an MSSQL database is straightforward when you use the MSSqlServerSettingsSection in your App.config. By removing unnecessary standard columns and adding ones that suit your application, you can enhance the clarity and utility of your logs.

If you have any questions or further customization ideas, feel free to reach out! Happy logging!