日志

日志（logging）是程序运行中的“黑匣子”，在程出现问题以后，我们可以通过分析日志来查询问题。

.NET Core日子基本使用

.NET Core中的日志系统可以把日志记录到控制台、事件日志、调试窗口等地方，还可以使用第三方日志提供程序把日志记录到文件、日志服务器等地方。和配置系统一样，.NET Core中的日志提供了标准接口及官方的一些实现，同时允许开发人员编写第三方实现。
些简单的把日志输出到控制台的使用方式。
NuGet安装包
日志系统核心的开发包

1	Microsoft.Extensions.Logging

控制台输出日志包

1	Microsoft.Extensions.Logging.Console

声明一个类

class Recording
{
    private ILogger<Recording>logger;
    public Recording(ILogger<Recording> logger)
    {
        this.logger = logger;
    }
    public void Record()
    {
        logger.LogDebug("开始执行数据库同步");
        logger.LogDebug("连接数据库成功");
        logger.LogWarning("数据库连接超时，重试第一次");
        //······
        logger.LogWarning("数据库连接超时，重试第二次");
        logger.LogError("数据库连接超时，重试失败");
        try
        {
            File.ReadAllText("E:/temp/3.txt");
            logger.LogDebug("读取文件成功");
        }
        catch(Exception ex)
        {
            logger.LogError(ex, "数据库同步失败");
        }
    }
}

using LoggingDemo;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Console;
using NLog.Fluent;
//DI
ServiceCollection services = new ServiceCollection();
services.AddLogging(logBuilder => {
    logBuilder.AddConsole();
    //最低输出日志级别
    logBuilder.SetMinimumLevel(LogLevel.Trace);
});


services.AddScoped<Recording>();

using (var sp=services.BuildServiceProvider())
{
    var recording = sp.GetRequiredService<Recording>();
    recording.Record();
}

文本日志提供程序NLog

.NET没有内置文本日志提供者。第三方Log4Net、NLog、Serilog等。
NLog,NuGet安装：

1	NLog.Extensions.Logging

(using NLog.Extensions.Logging;)。项目根目录下建nlog.congig,注意文件大小写（考虑Linux）。
也可以是其他文件名，但是需要单独配置。
增加logBuilder.AddNLog()

using LoggingDemo;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Console;
using NLog.Extensions.Logging;
using NLog.Fluent;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using NLog.Web;
//DI
ServiceCollection services = new ServiceCollection();
services.AddLogging(logBuilder => {
    logBuilder.AddConsole();
    logBuilder.AddEventLog();
    logBuilder.AddNLog();
    //最低输出日志级别
    logBuilder.SetMinimumLevel(LogLevel.Trace);
});


services.AddScoped<Recording>();

using (var sp=services.BuildServiceProvider())
{
    var recording = sp.GetRequiredService<Recording>();
    recording.Record();
}

在项目内新建项找到文本文件命名为nlog.config
属性设为较新复值

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true"
      throwConfigExceptions="true"
      internalLogLevel="info"
      internalLogFile="E:\log\internal-nlog.txt">
	<!--autoReload：修改后自动加载，可能会有延迟-->
	<!--throwConfigExceptions：NLog日志系统抛出异常-->
	<!--internalLogLevel：内部日志的级别-->
	<!--internalLogFile：内部日志保存路径，日志的内容大概就是NLog的版本信息，配置文件的地址等等-->
	<!--输出日志的配置，用于rules读取-->
	<targets>
		<!--write logs to file-->
		<!--将日志写入文件中,fileName可以指定日志生成的路径-->
		<target xsi:type="File" name="allfile" fileName="D:\Log\nlog-all-${shortdate}.log"
				 layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!--同样是将文件写入日志中，写入的内容有所差别，差别在layout属性中体现。写入日志的数量有差别，差别在路由逻辑中体现-->
		<target xsi:type="File" name="ownFile-web" fileName="D:\Log\nlog-my-${shortdate}.log"
				 layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<target xsi:type="Null" name="blackhole" />
	</targets>
	<rules>
		<!--路由顺序会对日志打印产生影响。路由匹配逻辑为顺序匹配。-->
		<!--All logs, including from Microsoft-->
		<logger name="*" minlevel="Trace" writeTo="allfile" />

		<!--Skip Microsoft logs and so log only own logs-->
		<!--以Microsoft打头的日志将进入此路由，由于此路由没有writeTo属性，所有会被忽略-->
		<!--且此路由设置了final，所以当此路由被匹配到时。不会再匹配此路由下面的路由。未匹配到此路由时才会继续匹配下一个路由-->
		<logger name="Microsoft.*" minlevel="Trace"  final="true" />
		<!--上方已经过滤了所有Microsoft.*的日志，所以此处的日志只会打印除Microsoft.*外的日志-->
		<logger name="*" minlevel="Trace" writeTo="ownFile-web" />
	</rules>
</nlog>

在设定的路径找到日志
“D:\Log\nlog-my-${shortdate}.log”
“D:\Log\nlog-all-${shortdate}.log”

日志分类、过滤

NLog官方网址：https://nlog-project.org/对使用NLog有详细的说明

配置nlog.config

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true"
      throwConfigExceptions="true"
	  internalLogFile="console-example-internal.log"
      internalLogLevel="off">


	<!-- enable asp.net core layout renderers -->
	<extensions>
		<add assembly="NLog.Web.AspNetCore"/>
	</extensions>

	<!-- the targets to write to -->
	<targets>
		<!-- File Target for all log messages with basic details -->
		<target xsi:type="File" name="LoggingDemo" fileName="logs/log-${shortdate}.log"
				layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}" />

		<!-- File Target for own log messages with extra web details using some ASP.NET core renderers -->
		<target xsi:type="File" name="SytemServices" fileName="logs/sysFile-${shortdate}.log" archiveAboveSize="1000" maxArchiveFiles="3"
				layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />

		<!--Console Target for hosting lifetime messages to improve Docker / Visual Studio startup detection -->
		<target xsi:type="Console" name="logconsole" layout="${MicrosoftConsoleLayout}" />
	</targets>

	<!-- rules to map from logger name to target -->
	<rules>
		<!-- All logs, including from Microsoft -->
		<logger name="*" minlevel="Warn" maxlevel="Fatal" writeTo="logconsole" />

		<!-- Suppress output from Microsoft framework when non-critical -->
		<logger name="SytemServices.*" minlevel="Trace" writeTo="SytemServices" final="true" />
		<!-- Keep output from Microsoft.Hosting.Lifetime to console for fast startup detection -->
		<logger name="*" minLevel="Trace" writeTo="LoggingDemo" />
	</rules>
</nlog>

输出十次

ServiceCollection services = new ServiceCollection();
services.AddLogging(logBuilder => {
    //logBuilder.AddConsole();
    //logBuilder.AddEventLog();
    logBuilder.AddNLog();
    //最低输出日志级别
    //logBuilder.SetMinimumLevel(LogLevel.Trace);
});

services.AddScoped<Recording>();
services.AddScoped<Test1>();

using (var sp=services.BuildServiceProvider())
{
    var recording = sp.GetRequiredService<Recording>();
    
    var test1 = sp.GetRequiredService<Test1>();
    
    for(int i = 0; i < 10; i++)
    {
        recording.Record();
        test1.Record();
    }

}

集中化日志

NLog也可以配置结构化日志，不过配置麻烦，推荐用Serilog。

NuGet安装：

1
2
3

using Serilog.Formatting.Json;
using Serilog;
Serilog.AspNetCore

配置

Serilog.Log.Logger = new LoggerConfiguration()
.MinimumLevel.Debug()
.Enrich.FromLogContext()
.WriteTo.Console(new JsonFormatter())
.CreateLogger();
logBuilder.AddSerilog();

要记录的结构化数据通过占位符来输出：

1	logger.LogWarning("新增用户{@person}",new {Id=3,Name="zack"});

同样可以输出到文件、数据库、MongoDB等。