重庆熊猫 Loading

ASP.NET Core教程-Logging（日志）

更新记录
转载请注明出处：
2022年11月23日 发布。
2022年11月20日 从笔记迁移到博客。

日志（Logging）基础

日志说明

日志并不会为应用程序增加实质性的功能，常用于记录错误信息、跟踪程序的运行状态、调试程序。记录日志时也可以指定其重要级别，如调试、信息、警告和错误等。

日志包括两种类型：系统日志 和 用户记录日志。系统日志是系统在运行时向外输出的记录信息。用户记录日志是由开发人员在程序中适当的位置调用与日志功能相关 API 输出的日志。

为什么需要日志

因为在开发机器上，可以直接看到程序的异常信息。但在客户机器机上，就需要使用日志功能获得用户的异常信息。

介绍ASP.NET Core日志提供程序

说明

ASP.NET Core框架支持 内置日志记录提供程序 和 第三方日志记录提供程序。ASP.NET Core框架内部也集成了日志功能，支持向控制台、调试窗口和Windows事件日志等位置输出日志。然而并不支持输出日志文件，要输出日志到文件需要第三方日志组件，如NLog和log4net等。

ASP.NET Core框架内置日志记录提供程序

ASP.NET Core框架内置的日志提供程序：

Console
Debug
EventSource
EventLog
TranceSource
AzureAppServicesFile
AzureAppServicesBlob
ApplicationInsights

ASP.NET Core框架第三方日志记录提供程序

下列是开源或商业中比较流行的日志组件：

NLog
Log4net
Elmah
Serilog
Sentry
Gelf
JSNLog
KissLog.net
Loggr
Stackdriver

ASP.NET Core框架内部默认启用的日志记录提供程序

在ASP.NET Core框架中会默认启动以下日志提供程序：

Console
Debug
EventSource

引用日志提供程序的代码在Program.cs文件中的Program类中CreateHostBuilder方法中会执行配置日志记录，并且会引用appsettings.json文件中的日志配置。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

可以在Visual Studio中的输出窗口查看到日志输出信息。

使用ASP.NET Core内置日志提供程序

说明

ASP.NET Core框架内部集成了日志功能。所在命名空间：

using Microsoft.Extensions.Logging;

配置日志提供程序

在Program.cs文件中的Program类的Configure方法中进行配置。

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
    .ConfigureLogging((hostingCotext, logging) =>
    {
        //清除其他的日志提供器
        logging.ClearProviders();
        //增加日志提供程序
        logging.AddConsole();
        logging.AddDebug();
        logging.AddEventLog();
        logging.AddEventSourceLogger();
    })
    .ConfigureWebHostDefaults(webBuilder =>
    {
        webBuilder.UseStartup<Startup>();
    });

Ilogger接口

包括实际执行记录日志操作的方法。

namespace Microsoft.Extensions.Logging
{
    public interface ILogger
    {
        IDisposable BeginScope<TState>(TState state);
        bool IsEnabled(LogLevel logLevel);
        void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter);
    }
}

Log方法用于记录日志，它包括5个参数，使用方法如下：

logger.Log(LogLevel.Information, 0, typeof(object), null, (type,exception)=> "Helloworld");

Log方法的第一个参数指明了这条信息的级别，日志级别即其重要程度

ASP.NET Core日志系统级别

Trace：
级别最低，通常仅用于开发阶段调试问题
这些信息可能包含敏感的应用程序数据
因此不应该用于生产环境，默认情况应禁用，即不输出

Debug：
用于记录调试信息，这种类型的日志有助于开发人员调试应用程序

Information：
用于记录应用程序的执行流程信息
这些信息具有一定的意义

Warning：
用于记录应用程序出现的轻微错误或其他不会导致程序停止的警告信息

Error：
用于记录错误信息，这一类的错误将影响程序正常执行

Critical：
严重级别最高，用于记录引起应用程序崩溃、灾难性故障等信息
如数据丢失、磁盘空间不够等

除了指定日志级别以外，还需要指定EventId

一个返回值类型为字符串的委托，该委托的意义在于根据指定的状态以及异常返回要输出的日志信息

从上面的代码中可以看出，直接使用Log方法来记录日志会非常麻烦

为此ILogger接口提供了若干个扩展方法，用来更方便地记录指定级别的日志

比如：LogTrace、LogDebug、LogInformation、LogWarning、LogError和LogCritical

实例：

logger.LogInformation("Panda Test");

注入日志服务

当ASP.NET Core应用程序运行时，日志组件会被添加到其依赖注入容器中。因此只要在合适的位置将ILogger对象注入进来，即可使用它来记录日志，ILogger接口有一个派生接口ILogger<out TCategoryName>，其中泛型类型TCategoryName表示日志类别名称，它可以是任何类型，通常情况下，它的值应为当前所在类。

实例：

//引入命名空间
using Microsoft.Extensions.Logging;

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    //注入logger服务
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        //使用logger服务
        this._logger.LogInformation("HomeController Index");
        return View();
    }
}

配置日志输出位置

日志提供程序用于显示并存储日志，不同的日志提供程序提供不同的输出位置和形式。当为应用程序添加了多个日志提供程序后，日志会输出到多个不同的位置。ASP.NET Core默认提供了以下6种日志提供程序：

  • Console：向控制台窗口输出日志。
  • Debug：向开发环境（IDE）的调试窗口输出日志，会调用System.Diagnostics.Debug类的WriteLine方法向外输出。
  • EventSource：向事件跟踪器输出日志。
  • EventLog：向Window Event Log输出日志。仅支持Windows操作系统。
  • TraceSource：通过调用AddTraceSource方法添加Trace Listener Provider。向Trace Listener输出日志。仅支持Windows操作系统。
  • Azure App Service：仅在Azure中使用。当应用程序部署到Azure Web服务中后，Azure App Service日志提供程序自动会添加进来。

使用NLog

NLog介绍

NLog是.NET平台中比较强大且广泛使用的日志组件，能够将日志信息按指定格式输出到一个或多个输出目标中。如：控制台、文件、邮件、数据库和消息队列，甚至第三方平台。

官方地址： https://nlog-project.org/
Nuget包地址： https://www.nuget.org/packages/NLog/
适用于ASP.NET Core包： https://www.nuget.org/packages/NLog.Web.AspNetCore
Github地址： https://github.com/NLog/NLog

NLog日志级别

分为6个级别，由低到高排列如下：

logger.LogTrace()
logger.LogDebug()
logger.LogInformation()
logger.LogWarning()
logger.LogError()
logger.LogCritical()

NLog使用-NLog安装

安装NuGet包（适用于ASP.NET Core的包）

dotnet add package NLog.Web.AspNetCore

NLog使用-定义nlog.config配置文件

使用之前需要定义一个配置文件，NLog通过XML形式的文件来配置它的使用方式。为项目新添加一个XML文件，命名为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"
      internalLogLevel="Info"
      internalLogFile="c:\temp\internal-nlog-AspNetCore.txt">

  <!-- 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="allfile" fileName="c:\temp\nlog-AspNetCore-all-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId_Id:whenEmpty=0}|${uppercase:${level}}|${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="ownFile-web" fileName="c:\temp\nlog-AspNetCore-own-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId_Id:whenEmpty=0}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}|${callsite}| body: ${aspnet-request-posted-body}" />

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

  <!-- rules to map from logger name to target -->
  <rules>
    <!--All logs, including from Microsoft-->
    <logger name="*" minlevel="Trace" writeTo="allfile" />

    <!--Output hosting lifetime messages to console target for faster startup detection -->
    <logger name="Microsoft.Hosting.Lifetime" minlevel="Info" writeTo="lifetimeConsole, ownFile-web" final="true" />

    <!--Skip non-critical Microsoft logs and so log only own logs (BlackHole) -->
    <logger name="Microsoft.*" maxlevel="Info" final="true" />
    <logger name="System.Net.Http.*" maxlevel="Info" final="true" />
    
    <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
  </rules>
</nlog>

nlog.config的配置规则：

通过上面的配置文件可以看到，文件夹中输出的日志文件有3个，这是在nlog.config中配置的，通过文件名可以找到对应的配置。

internal-nlog 记录了NLog的启动及加载config的信息
nlog-all 记录了所有日志
nlog-own 记录了自定义的日志

XML文件节点说明：

<targets>节点用于定义输出目标，比如：输出到文件、控制台
type属性的可选项 File、Mail、Console等
layout属性用于设置输出信息的组成元素及格式

<rules>节点用于定义输出规则
节点中定义了两个规则
作用是将所有Microsoft开头的日志输出到控制台
除此之外的其他日志输出到文件

<variable>节点用于定义变量
常用的变量可以定义在这里
如果同一个信息在后续的配置中多次出现
将它提取为变量可以避免手工输入而引起的错误

NLog使用-配置Program.cs文件

//引入命名空间
using NLog;
using NLog.Web;
//配置Nlog
var logger = NLog.LogManager.Setup().LoadConfigurationFromAppSettings().GetCurrentClassLogger();
logger.Debug("init main");

try
{
    var builder = WebApplication.CreateBuilder(args);

    // Add services to the container.
    builder.Services.AddControllersWithViews();

    // NLog: 注册NLog服务到容器中
    //先清除所有日志服务
    builder.Logging.ClearProviders();
    //设置最小报告日志等级
    builder.Logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);
    //注册NLog
    builder.Host.UseNLog();
    var app = builder.Build();

    // Configure the HTTP request pipeline.
    if (!app.Environment.IsDevelopment())
    {
        app.UseExceptionHandler("/Home/Error");
        // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseStaticFiles();

    app.UseRouting();

    app.UseAuthorization();

    app.MapControllerRoute(
        name: "default",
        pattern: "{controller=Home}/{action=Index}/{id?}");

    app.Run();
}
catch (Exception exception)
{
    // NLog: catch setup errors
    logger.Error(exception, "Stopped program because of exception");
    throw;
}
finally
{
    // Ensure to flush and stop internal timers/threads before application-exit (Avoid segmentation fault on Linux)
    NLog.LogManager.Shutdown();
}

NLog使用-配置appsettings.json配置文件

{
  "Logging": {
    "LogLevel": {
      "Default": "Trace",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

NLog使用-在Controller中使用

using Microsoft.Extensions.Logging;

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;
	//注入日志服务
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
        //使用日志服务
        _logger.LogDebug(1, "NLog injected into HomeController");
    }

    public IActionResult Index()
    {
        //使用日志服务
        _logger.LogInformation("Hello, this is the index!");
        return View();
    }
}

使用Log4Net

Log4Net介绍

Log4Net安装

Log4Net使用

待整理

https://www.cnblogs.com/Jack-Blog/p/10117218.html

https://www.jianshu.com/p/0a3d850b1228

https://github.com/NLog/NLog/wiki/Tutorial

posted @ 2022-11-23 12:13  重庆熊猫  阅读(1933)  评论(0)  编辑  收藏  举报