Serilog.UI 2.5.1

serilog-ui

A simple Serilog log viewer for the following sinks:

• Serilog.Sinks.MSSqlServer (Nuget)
• Serilog.Sinks.MySql (Nuget)
• Serilog.Sinks.Postgresql (Nuget)
• Serilog.Sinks.MongoDB (Nuget)
• Serilog.Sinks.ElasticSearch (Nuget)

<img src="https://raw.githubusercontent.com/mo-esmp/serilog-ui/master/assets/serilog-ui.jpg" width="100%" />

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 of the available providers, based upon your sink:

DI registration

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

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

In the Startup.Configure method, enable the middleware to serve the log UI page. Note: call to the UseSerilogUi middleware must be placed after any Authentication and Authorization middleware, otherwise the authentication may not work:

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();

    (...)

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
    });
}

Basic Authentication

If you need to add basic authentication to your serilog-ui instance, you can use the BasicAuthenticationFilter. Here's how to configure it in your Startup.Configure method:

app.UseSerilogUi(options =>
{
    options.Authorization.Filters = new IUiAuthorizationFilter[]
    {
        new BasicAuthenticationFilter { User = "User", Pass = "P@ss" }
    };
    options.Authorization.RunAuthorizationFilterOnAppRoutes = true;
});

For further configuration: :fast_forward:

Running the Tests: :test_tube:

License

See LICENSE.

Issues and Contribution

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