umairsyed613 / serilog.sinks.winforms

Print Serilog logs from anywhere in you application into textbox or datagridview. windows forms

Build Status

Serilog.Sinks.WinForms (.net framework >= 4.6)

Serilog.Sinks.WinForms.Core (.net 5-6)

Writes Serilog events to Windows Froms Application TextBox or Datagridview control from anywhere in your application.

Getting started

Install the Serilog.Sinks.WinForms package from NuGet:

Install-Package Serilog.Sinks.WinForms

Install the Serilog.Sinks.WinForms.Core package from NuGet:

Install-Package Serilog.Sinks.WinForms.Core

To configure the sink in C# code, call WriteToSimpleAndRichTextBox() or WriteToJsonTextBox() or WriteToGridView() during logger configuration:

Simple Text Formatted Log And Rich TextBox Log Control

SimpleLogTextBox or RichTextBoxLogControl can be used from visual studio toolbox once the package is added to the project.

Log.Logger = new LoggerConfiguration()
                        .WriteToSimpleAndRichTextBox()
                        .CreateLogger();

SimpleLogTextBox or RichTextBoxLogControl with custom Configuration. SimpleLogTextBox accepts ITextFormatter

Log.Logger = new LoggerConfiguration()
                        .WriteToSimpleAndRichTextBox(new MessageTemplateTextFormatter("{Timestamp} [{Level}] {Message} {Exception}"))
                        .CreateLogger();

Json Formatted Log

JsonLogTextBox can be used from visual studio toolbox once the package is added to the project.

Log.Logger = new LoggerConfiguration()
                        .WriteToJsonTextBox()
                        .CreateLogger();

JsonLogTextBox with custom Configuration. JsonLogTextBox accepts ITextFormatter

Log.Logger = new LoggerConfiguration()
                        .WriteToJsonTextBox(new JsonFormatter())
                        .CreateLogger();

Datagridview Log

GridLog can be used from visual studio toolbox once the package is added to the project.

Log.Logger = new LoggerConfiguration()
                        .WriteToGridView()
                        .CreateLogger();

Log For Context

SimpleLogTextBox, RichTextBoxLogControl or JsonLogTextBox can be configured to display log for specific Context. All of the controls have property For Context which can be configured with namespace.classname for example TestApplication.Form2 you can find the sample here >> Sample

Note: Remember to configure Logger instance with Enrich.FromLogContext()

Save and Clear Logs

SimpleLogTextBox, RichTextBoxLogControl or JsonLogTextBox have two method available for saving log to file or clear the log from the log control. ClearLogs() AND SaveLogToFile()

Check the usage in sample application here Sample

Sample Code

Find the sample running application here