ASP.NET Core框架学习之日志框架

我们平时的开发离不开记录日志，.net core框架也内置了强大的日志记录功能。

简单示例

　　创建一个控制台应用，在appsettings.json中加入如下配置

"Logging": {
    "LogLevel": {
      "Default": "Debug",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    },
    "Console": {
      "IncludeScopes": true,
      "LogLevel": {
        "Default": "Debug",
        "Microsoft": "Warning",
        "Microsoft.Hosting.Lifetime": "Information",
        "alog": "Debug"
      }
    }
}

　　引用包

Microsoft.Extensions.Logging
Microsoft.Extensions.Logging.Console

　　注入Logging到容器中

IConfigurationBuilder configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddJsonFile("appsettings.json", false, false);
var configuration = configurationBuilder.Build();
var services = new ServiceCollection();
services.AddLogging(builder =>
{             
        builder.AddConfiguration(iconfigurationRoot.GetSection("Logging"));
        builder.AddConsole();
});
var serviceProvider = services.BuildServiceProvider();

　　下面是AddLogging的源码，其中主要的部分就是将ILoggerFactory和ILogger<>注入到容器中。

public static IServiceCollection AddLogging(this IServiceCollection services, Action<ILoggingBuilder> configure)
{
    if (services == null)
    {
        throw new ArgumentNullException("services");
    }
    services.AddOptions();
    services.TryAdd(ServiceDescriptor.Singleton<ILoggerFactory, LoggerFactory>());
    services.TryAdd(ServiceDescriptor.Singleton(typeof(ILogger<>), typeof(Logger<>)));
    services.TryAddEnumerable(ServiceDescriptor.Singleton((IConfigureOptions<LoggerFilterOptions>)new DefaultLoggerLevelConfigureOptions(LogLevel.Information)));
    configure(new LoggingBuilder(services));
    return services;
}

　　我们可以通过两种方式创建ILogger对象

var logFactory = serviceProvider.GetService<ILoggerFactory>();
var logger = logFactory.CreateLogger("Default");
//或
var logger = serviceProvider.GetService<ILogger<Program>>();
logger.LogInformation("aa");
logger.LogError("bb");
logger.LogDebug("cc");

　　这样我们就完成了打印日志的简单示例。

日志级别

　　日志级别分为如下7种，从上往下日志级别由低到高。如在配置文件中设置日志级别为Error，那么Warning等低级别的日志都不会被打印。　

public enum LogLevel
{
    Trace,
    Debug,
    Information,
    Warning,
    Error,
    Critical,
    None
}

　　打印日志时推荐使用字符串模板的方式

logger.LogDebug("时间：{date}",DateTime.Now);

　　不推荐下面这种方式，因为我们调试时可能记录大量Debug级别日志，当项目投入生产后，我们往往会关闭Debug级别日志，字符串模板方式在记录日志时才会进行字符串拼接，所以字符串模板的方式可以防止Dubug级别日志的字符串拼接影响性能。

logger.LogDebug($"时间：{DateTime.Now}");

日志域

　　使用日志域方法，可以让同一作用域下的日志带上相同的scopeId，这样可以帮助我们更好的做日志追踪和排查问题。

　　在Console配置文件中添加如下配置

 "IncludeScopes": true

　　创建日志域并记录日志

using (logger.BeginScope("scopeId:{scopeId}", Guid.NewGuid()))
{
    logger.LogInformation($"时间：{DateTime.Now}");
    logger.LogError("bb");
    logger.LogDebug("cc");
}

　　它的执行结果如下图所示，可以看到每条日志都记录了scopeId

 通过Serilog框架记录结构化日志

　　结构化日志相比与文本日志易于检索，易于分析统计，可以用于日志告警，日志关联，以及与追踪系统的集成。下面演示Serilog的简单使用实例。

　　创建一个.net core web应用项目，并引用下面的nuget包

Serilog.AspNetCore

　　在appsettings.json中添加如下配置

"Serilog": {
    "MinimumLevel": {
      "Default": "Debug",
      "Override": {
        "Microsoft": "Warning",
        "Microsoft.Hosting.Lifetime": "Information"
      }
    }
}

　　在Program.cs中添加如下代码

public class Program
{
    public static void Main(string[] args)
    {
        var configuration = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true).Build();
        Log.Logger = new LoggerConfiguration().ReadFrom.Configuration(configuration)
            .WriteTo.Console(new RenderedCompactJsonFormatter())
            .Enrich.FromLogContext()
            .CreateLogger();

        Log.Logger.Information("程序启动 {date}",DateTime.Now);
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        }).UseSerilog(dispose:true);
}

　　在控制器中引用ILogger<>

public class WeatherForecastController : ControllerBase
{
    private readonly ILogger<WeatherForecastController> _logger;
    public WeatherForecastController(ILogger<WeatherForecastController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public string Get()
    {
        _logger.LogInformation("hello serilog ");
        return "OK";
    }
}

　　运行效果如下图，可以看到日志都是以Json结构记录的。

 　　上面的日志记录的较多，我们可以先将无用的日志关闭，在配置文件中将 Microsoft.Hosting.Lifetime的日志级别设置成 “Fatal”，这样我们的日志就清晰多了。

 　　Serilog日志框架还支持多种的Sinks接收器，可以通过引用 Serilog.Sinks.Http 或 Serilog.Sinks.Elasticsearch 将日志记录到 ELK中。