如何在 ASP.NET Core MVC 的自定义记录器中正确实现 ILogger.IsEnabled()

Question

我（作为一个新手）正在实现我自己的自定义记录器，以便在 ASP.NET Core MVC 应用程序中使用。我有这个记录器在各个方面都功能工作。但是到目前为止我作弊了一点，即我实现了ILogger.IsEnabled方法如下：

public bool IsEnabled(LogLevel logLevel)
{
    return true;
}

从功能上讲，这很好用，因为框架确保只有在日志级别等于或高于指定级别时才调用Log() 方法。因此，正确的“事物”被记录下来，而较低级别的“事物”没有按预期记录。

但是，我还想在我的代码中支持以下类型的情况，其中_logger 输入为ILogger 并正确注入到我的控制器中：

if (_logger.IsEnabled(LogLevel.Debug))
{
    _logger.LogDebug("This is an expensive message to generate: " +
        JsonConvert.SerializeObject(request));
}

为了使其有效，我的IsEnabled() 方法应该能够知道使用我的LoggerProvider 创建的记录器实例的日志级别是什么，但我不知道如何直接获取该信息，或者如何正确地将其传递给我正在使用的记录器的注入实例。

我能够找到的复杂示例和教程似乎在每种情况下都是针对控制台应用程序类型而不是网络应用程序类型构建的，到目前为止，我未能通过模板化的Startup 弄清楚如何做到这一点ASP.NET MVC 中的类。

如果注入的实例中没有注册记录器正在处理Debug 日志，为了避免不必要的序列化（在我的示例中），停止在我的自定义 IsEnabled() 方法中作弊的最简单和最有效的方法是什么等级？或者您有没有最喜欢的 ASP.NET 核心设置示例或教程可以指点我？

Answer 1

您可以查看内置记录器 source code 并了解它们是如何实现的。

简而言之，他们只检查logLevel != LogLevel.None，但根据记录器逻辑，您可能还想检查一些其他配置。例如，DebugLogger logger 还检查 Debugger.IsAttached 属性，EventLogLogger 检查 EventLogSettings.Filter（通过构造函数提供）。

更新

为了使其有效，我的IsEnabled() 方法应该能够知道使用我的LoggerProvider 创建的记录器实例的日志级别是什么，但我不知道如何直接获取该信息，或者如何正确地将其传递给我正在使用的记录器的注入实例。

你可以创建一个ILoggerProvider 的实现，它反过来可以利用依赖注入来获得你想要的配置。如果你想使用选项模式来配置它，你必须按照以下方式做一些事情：

public class MyLoggerProvider : ILoggerProvider
{
    private readonly IOptions<MyLoggerOptions> _options;

    public MyLoggerProvider(IOptions<MyLoggerOptions> options)
    {
        _options = options;
    }

    public ILogger CreateLogger(string name)
    {
        return new MyLogger(name, _options.Value);
    }
}

并且可选地添加一个扩展方法以使注册更容易：

public static class MyLoggerExtensions
{
    public static ILoggingBuilder AddMyLogger(this ILoggingBuilder builder, Action<MyLoggerOptions> configure)
    {
        builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, MyLoggerProvider>());
        LoggerProviderOptions.RegisterProviderOptions<MyLoggerOptions, MyLoggerProvider>(builder.Services);
        builder.Services.Configure(configure);
    }
}