Serilog.UI 3.0.0-alpha.1

This is a prerelease version of Serilog.UI.
dotnet add package Serilog.UI --version 3.0.0-alpha.1
NuGet\Install-Package Serilog.UI -Version 3.0.0-alpha.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Serilog.UI" Version="3.0.0-alpha.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.UI --version 3.0.0-alpha.1
#r "nuget: Serilog.UI, 3.0.0-alpha.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.UI as a Cake Addin
#addin nuget:?package=Serilog.UI&version=3.0.0-alpha.1&prerelease

// Install Serilog.UI as a Cake Tool
#tool nuget:?package=Serilog.UI&version=3.0.0-alpha.1&prerelease

serilog-ui

A simple Serilog log viewer for the following sinks:

  • Serilog.Sinks.MSSqlServer (Nuget)
  • Serilog.Sinks.MySql (Nuget) and Serilog.Sinks.MariaDB Nuget
  • Serilog.Sinks.Postgresql (Nuget) and Serilog.Sinks.* *Postgresql.Alternative** (Nuget)
  • Serilog.Sinks.MongoDB (Nuget)
  • Serilog.Sinks.ElasticSearch (Nuget)
  • Serilog.Sinks.RavenDB (Nuget)

Read the Wiki 📘

Quick Start

Nuget packages installation

Install the Serilog.UI NuGet package:

# using dotnet cli
dotnet add package Serilog.UI

# using package manager:
Install-Package Serilog.UI

Install one or more of the available providers, based upon your sink(s):

Provider install: dotnet install: pkg manager
Serilog.UI.MsSqlServerProvider [NuGet] dotnet add package Serilog.UI.MsSqlServerProvider Install-Package Serilog.UI.MsSqlServerProvider
Serilog.UI.MySqlProvider [NuGet] dotnet add package Serilog.UI.MySqlProvider Install-Package Serilog.UI.MySqlProvider
Serilog.UI.PostgreSqlProvider [NuGet] dotnet add package Serilog.UI.PostgreSqlProvider Install-Package Serilog.UI.PostgreSqlProvider
Serilog.UI.MongoDbProvider [NuGet] dotnet add package Serilog.UI.MongoDbProvider Install-Package Serilog.UI.MongoDbProvider
Serilog.UI.ElasticSearchProvider [NuGet] dotnet add package Serilog.UI.ElasticSearchProvider Install-Package Serilog.UI.ElasticSearchProvider
Serilog.UI.RavenDbProvider [NuGet] dotnet add package Serilog.UI.RavenDbProvider Install-Package Serilog.UI.RavenDbProvider

DI registration

Add AddSerilogUi() to IServiceCollection in your Startup.ConfigureServices method:

public void ConfigureServices(IServiceCollection services)
{
  // Register the serilog UI services
  services.AddSerilogUi(options => options// each provider exposes extension methods to configure.
    // example with MSSqlServerProvider:
    .UseSqlServer(opts => opts
      .WithConnectionString("YOUR_CONNECTION_STRING")
      .WithTable("YOUR_TABLE")));
}

In the Startup.Configure method or on the WebApplication builder, enable the middleware to serve the log UI page.

NOTE: call to the UseSerilogUi middleware must be placed after any Authentication and Authorization middleware!

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    (...)

    app.UseRouting();
    app.UseAuthentication();
    app.UseAuthorization();

    // Enable middleware to serve log-ui (HTML, JS, CSS, etc.).
    app.UseSerilogUi(opts => [...]);

    (...)
}

For further configuration: :fast_forward:

Issues and Contribution

Everything is welcome! 🏆 See the contribution guidelines for details.

For details on running the project, start reading from Develop.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Serilog.UI:

Package Downloads
Pina.SharedApi

Package Description

WGM.Infrastructure.Core

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.0-alpha.1 52 5/10/2024
2.6.0 10,807 1/29/2024
2.5.1 6,880 11/8/2023
2.5.0 5,554 10/3/2023
2.4.0 24,983 3/16/2023
2.3.0 403 3/13/2023
2.2.3 10,746 11/25/2022
2.2.1 12,837 9/9/2022
2.2.0 1,592 8/25/2022
2.1.3 2,822 7/20/2022
2.1.2 2,452 5/28/2022
2.1.1 25,672 11/29/2021
2.1.0 12,824 4/20/2021
2.0.1 24,352 2/2/2021
2.0.0 3,152 1/15/2021
1.0.5 1,058 12/23/2020
1.0.4 3,031 10/25/2020
1.0.3 691 5/23/2020
1.0.2 1,300 4/11/2020