Skip to content

Microsoft Extension Logging implementation for Blazor

License

Notifications You must be signed in to change notification settings

MiniTurtle/Logging

 
 

Repository files navigation

Build status Package Version NuGet Downloads License

Blazor Extensions

Blazor Extensions is a set of packages with the goal of adding useful features to Blazor.

Blazor Extensions Logging

This package is an implementation for the Microsoft Extensions Logging abstraction to support using the ILogger interface in your Blazor code.

When the component is configured, all the log statements will appear in the browser's developer tools console.

Features

Content to log

The logger supports the same string formatting that MEL provides, together with named parameter replacement in the message.

Additionaly, you're able to log an object in the browser console. You can expand members and hierachies to see what's contained within.

If you want to log an enumerable list of objects, then the browser side component will display it by calling console.table.

Filtering

The implementation supports the ILoggerFactory-based filtering configuration that is supplied by the Microsoft Extension Logging abstraction.

To keep it lightweight, Microsoft Extensions Configuration based configuration is not supported; the logger can be only configured in code.

Log levels

The logger supports the LogLevels defined in MEL.

Some of the log levels are not available as distinct methods in the browser's developer tool, so the browser side component does some mapping.

Sample configuration

Setup

The following snippet shows how to setup the browser console logger by registering it for dependency injection in the Startup.cs of the application.

public void ConfigureServices(IServiceCollection services)
{
    services.AddLogging(builder => builder
        .AddBrowserConsole() // Add Blazor.Extensions.Logging.BrowserConsoleLogger
        .SetMinimumLevel(LogLevel.Trace)
    );
}

Usage

The following snippet shows how to consume the logger in a Blazor component.

@inject ILogger<Index> logger

@functions {
  protected override async Task OnInitAsync()
  {
      logger.LogDebug("MyComponent init");
  }
}

If you want to consume it outside of a cshtml based component, then you can use the Inject attribute to inject it into the class.

[Inject]
protected ILogger<MyClass> Logger {get;set;}

public void LogSomething()
{
  Logger.LogDebug("Inside LogSomething");
}

Contributions and feedback

Please feel free to use the component, open issues, fix bugs or provide feedback.

Contributors

The following people are the maintainers of the Blazor Extensions projects:

About

Microsoft Extension Logging implementation for Blazor

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 79.8%
  • TypeScript 10.2%
  • HTML 8.0%
  • JavaScript 2.0%