Mazzlog 1.0.1

Mazzlog

.NET Core ILogger implementation with storage on your hands

How to use

• After your CreateDefaultBuilder call, include the ConfigureLogging extension method to add the Mazzlogger provider
• Create a configuration class that extends from IConfigureMazzLogger
• At D.I. container setup, on ConfigureServices, call ConfigureMazzlog with your configuration class
• Run your code

Show me the code

In your Program class:

Host.CreateDefaultBuilder(args)
    .ConfigureLogging(logging =>
    {
        logging.ClearProviders(); // Optionally
        logging.AddMazzlog(c =>
        {
            // Optionally settings
            c.DefaultPropertyScopes = new Dictionary<string, object>() 
            {
                { "app-name", "AppX" },
                { "app-instance", "Instance001" },
            };

            c.DeniedCategories = new List<string> { "Microsoft.Hosting.Lifetime" };
        });
    });
    

The configuration class:

public sealed class MyLoggerConfiguration : IConfigureMazzLogger
{
    public TimeSpan FlushInterval => TimeSpan.FromSeconds(5);
    public uint ItensPerFlush => 10;

    // What do you want to do with your logs? You code go here
    public async Task OnFlushAsync(IReadOnlyCollection<LogEntry> logs)
    {
        using var txt = File.Open("logs.txt", FileMode.Append, FileAccess.Write);
        using var writter = new StreamWriter(txt);
        var sb = new StringBuilder();

        foreach (var log in logs)
        {
            sb.Append(JsonSerializer.Serialize(log));
            sb.Append(Environment.NewLine);
        }
        
        // Save my logs in a txt file
        await writter.WriteAsync(sb.ToString());
    }
}

In your Startup class:

public void ConfigureServices(IServiceCollection services)
{
    services.ConfigureMazzlog<MyLoggerConfiguration>();
}

Log usage recommendation:

Mazzlog is asynchronous and use concurrency logic to work with your logs, this means that the logs ordering is not guaranteed, so, we encourage the use of scopes to get around this problem

public class HomeController : Controller
{
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }
    
    private readonly ILogger<HomeController> _logger;
    
    public IActionResult Index()
    {
        using (_logger.BeginScope("RequestId", Guid.NewGuid().ToString()))
        using (_logger.BeginScope(nameof(Index)))            
        {
            return Foo();
        }
    }
    
    private IActionResult Foo()
    {
        using (_logger.BeginScope(nameof(Foo)))
        {
            _logger.LogInformation("Hello World!");
            return Ok();
        }
    }
}

Enjoy =)