记录器提供程序：如何实现自定义格式化程序

Question

I implemented a custom logger provider. My custom logger has this signature:

public void Log<TState>(LogLevel logLevel, EventId eventId, 
    TState state, Exception exception, Func<TState, Exception, string> formatter)

How is formatter being passed?

And how can I implement a custom formatter ? Say, if I want it to be formatting everything in JSON

I'm new to Net Core and I don't fully understand how this works.

Answer 1

The Func<TState, Exception, string> formatter function that is being passed to your function is basically just a utility function to convert the state into a single string message. Inside your logger, you are basically just expected to call formatter(state, exception) to get the formatted message that should be logged.

Usually, you do not really need to care about the function, other than calling it to get the formatted message, so that's what all loggers usually do. For the purpose of a JSON logger, you could just ignore it completely, or at least also export the formatted message so it's there as a readable string.

A quick and dirty JSON logger's Log method could actually look like this:

public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
{
    var jsonLine = JsonConvert.SerializeObject(new {
        logLevel,
        eventId,
        parameters = (state as IEnumerable<KeyValuePair<string, object>>)?.ToDictionary(i => i.Key, i => i.Value),
        message = formatter(state, exception),
        exception = exception?.GetType().Name
    });

    // store the JSON log message somewhere
    Console.WriteLine(jsonLine);
}

As you can see, it's not that much magic to generate the JSON object here.

Answer 2

First, this doesn't really have anything to do with .NET Core. It looks like you're using Microsoft.Extensions.Logging , which is just a generic logging facade that you can use pretty much anywhere, .NET Core app or not. It just happens to be the default used by ASP.NET Core apps; that's all.

Second, if you don't know how to implement this method, it may not be a good idea to be creating your own logging provider. What is it that you're trying to do that there's not already an existing adapter for?

That said, the Func<TState, Exception, string> type means that it needs a function that accepts a parameter of type TState and one of type Exception and returns a string. Essentially:

public string MyFormatter<TState>(TState state, Exception exception)
{
    // create some string
    return someString;
}

Or, it could be implemented via a lambda:

(state, exception) => exception?.Message ?? state.ToString();