ASP.NET Core 3.1系列（31）——日志组件NLog的基础使用方法

最新推荐文章于 2024-03-30 11:36:46 发布
最新推荐文章于 2024-03-30 11:36:46 发布
阅读量1.8k 收藏 6
点赞数 3
分类专栏： ASP.NET Core C# 文章标签： ASP.NET Core
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/HerryDong/article/details/128882554
版权
C# 同时被 2 个专栏收录
72 篇文章 16 订阅
订阅专栏
ASP.NET Core
32 篇文章 41 订阅
订阅专栏

1、前言

在生产环境中部署软件时，日志模块是必不可少的。在.NET Framework时代，Log4net是最常用的日志组件，而在.NET Core开发环境下，NLog的使用频率开始大幅提高。下面就来介绍一下NLog的基础使用方法。

2、引入NLog

新建一个Web API工程，使用NuGet引入如下组件：

NLog
NLog.Web.AspNetCore

在这里插入图片描述

3、配置文件nlog.config

新建一个XML文件，文件名为nlog.config，如下图所示：

在这里插入图片描述

将nlog.config文件改为始终复制，如下图所示：

在这里插入图片描述
在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="Off"
      internalLogFile="C:\temp\internal-nlog.txt">
	<targets>
		<!-- Trace级别日志，输出到文件 -->
		<target xsi:type="File"
                name="TraceFile"
                fileName="${basedir}/logs/${shortdate}_Trace.log"
                layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!-- Debug级别日志，输出到文件 -->
		<target xsi:type="File"
                name="DebugFile"
                fileName="${basedir}/logs/${shortdate}_Debug.log"
			    layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!-- Info级别日志，输出到文件 -->
		<target xsi:type="File"
                name="InfoFile"
                fileName="${basedir}/logs/${shortdate}_Info.log"
			    layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!-- Warn级别日志，输出到文件 -->
		<target xsi:type="File"
                name="WarnFile"
                fileName="${basedir}/logs/${shortdate}_Warn.log"
			    layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!-- Error级别日志，输出到文件 -->
		<target xsi:type="File"
                name="ErrorFile"
                fileName="${basedir}/logs/${shortdate}_Error.log"
			    layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!-- Fatal级别日志，输出到文件 -->
		<target xsi:type="File"
                name="FatalFile"
                fileName="${basedir}/logs/${shortdate}_Fatal.log"
			    layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
	</targets>
	<rules>
		<!-- Microsoft.*表示通配符，所有微软日志将被过滤 -->
		<logger name="Microsoft.*" minlevel="Trace"  final="true" />
		<logger name="*" minlevel="Trace" writeTo="TraceFile" />
		<logger name="*" minlevel="Debug" writeTo="DebugFile" />
		<logger name="*" minlevel="Info" writeTo="InfoFile" />
		<logger name="*" minlevel="Warn" writeTo="WarnFile" />
		<logger name="*" minlevel="Error" writeTo="ErrorFile" />
		<logger name="*" minlevel="Fatal" writeTo="FatalFile" />
	</rules>
</nlog>

3.1、targets节点

在上面的代码中，targets节点用于定义若干日志目标，一个targets节点可以包含多个target节点。

xsi:type="File"

xsi:type="File"表示将日志保存到文件，其他常用的还有xsi:type="Console"和xsi:type="Database"等。

name="TraceFile"

name="InfoFile"用于定义目标名称，开发者可自行定义。

fileName="${basedir}/logs/${shortdate}_Fatal.log"

fileName表示日志文件路径，这里的${basedir}是一个模板参数，它对应的路径是\bin\Debug\netcoreapp3.1\，${shortdate}也是一个模板参数，它表示获取当前系统时间。如果你不熟悉这些模板参数，也可以直接定义路径，如D:\logs\Trace.log。

layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}"

layout表示日志文本的格式，这里的${longdate}表示日志记录的时间，${logger}表示在哪一个代码文件中写入了日志，${uppercase:${level}}表示日志等级，${message} ${exception}表示日志内容。

3.2、rules节点

rules节点用于定义一系列规则。

minlevel="Trace"

minlevel表示最低记录哪一级别的日志。一般来说，Trace和Debug主要记录开发阶段的日志，系统正式上线后不需要记录这两个级别的日志。

writeTo="TraceFile"

writeTo参数表示按照哪个target进行写入。我们在上面定义了6个target节点，writeTo参数的值就是target节点中name的值。

4、设置NLog为日志管理器

引入NLog的相关组件后，我们需要将NLog设置为系统的日志管理器，修改Program.cs文件，代码如下：

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using NLog.Web;

namespace App
{
    public class Program
    {
        public static void Main(string[] args)
        {
            NLogBuilder.ConfigureNLog("nlog.config");
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                })
                .ConfigureLogging(logging=>
                {
                    logging.ClearProviders();
                })
                .UseNLog();
    }
}

5、生成日志

添加一个控制器HomeController，在其构造函数中注入ILogger接口，代码如下：

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        protected readonly ILogger<HomeController> _logger;

        public HomeController(ILogger<HomeController> logger)
        {
            _logger = logger;
        }

        [HttpGet]
        public ActionResult<string> Get()
        {
            _logger.LogTrace("This is track info");
            _logger.LogDebug("This is debug info");
            _logger.LogInformation("This is info");
            _logger.LogWarning("This is warn info");
            _logger.LogError("This is error info");
            _logger.LogCritical("This is fatal info");
            return "Hello World";
        }
    }
}

运行程序，可以发现日志文件已经生成，如下图所示：

在这里插入图片描述

5.1、Trace.log

在rules中规定TraceFile的最低记录级别minlevel="Trace"，因此Trace.log会记录Trace-Fatal的全部日志：

2023-02-06 14:26:37.0419|App.Controllers.HomeController|TRACE|This is track info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|DEBUG|This is debug info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|INFO|This is info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|WARN|This is warn info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|ERROR|This is error info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|FATAL|This is fatal info

5.2、Debug.log

在rules中规定DebugFile的最低记录级别minlevel="Debug"，因此Debug.log会记录Debug-Fatal的全部日志：

2023-02-06 14:26:37.0809|App.Controllers.HomeController|DEBUG|This is debug info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|INFO|This is info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|WARN|This is warn info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|ERROR|This is error info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|FATAL|This is fatal info

5.3、Info.log

在rules中规定InfoFile的最低记录级别minlevel="Info"，因此Info.log会记录Info-Fatal的全部日志：

2023-02-06 14:26:37.0809|App.Controllers.HomeController|INFO|This is info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|WARN|This is warn info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|ERROR|This is error info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|FATAL|This is fatal info

5.4、Warn.log

在rules中规定WarnFile的最低记录级别minlevel="Warn"，因此Warn.log会记录Wran-Fatal的全部日志：

2023-02-06 14:26:37.0809|App.Controllers.HomeController|WARN|This is warn info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|ERROR|This is error info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|FATAL|This is fatal info

5.5、Error.log

在rules中规定ErrorFile的最低记录级别minlevel="Error"，因此Error.log会记录Error-Fatal的全部日志：

2023-02-06 14:26:37.0809|App.Controllers.HomeController|ERROR|This is error info 
2023-02-06 14:26:37.0809|App.Controllers.HomeController|FATAL|This is fatal info

5.6、Fatal.log

在rules中规定FatalFile的最低记录级别minlevel="Fatal"，因此Fatal.log会记录Fatal的全部日志：

2023-02-06 14:26:37.0809|App.Controllers.HomeController|FATAL|This is fatal info

6、输出日志到html

上面实现了将日志消息记录到文本文件的操作，但随着日志数量的不断增加，阅读日志就会变得异常艰难。我们不妨将日志输出到html文件，然后利用一些简单的css属性来装饰一下，修改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="Off"
      internalLogFile="C:\temp\internal-nlog.txt">
	<targets>
		<!-- Trace级别日志，输出到html文件 -->
		<target xsi:type="File"
                name="TraceFile"
                fileName="${basedir}/logs/${shortdate}_Trace.html"
                layout="【记录时间】：${longdate} &lt;br&gt;
				        【文名名称】：${logger} &lt;br&gt;
						【日志级别】：${uppercase:${level}} &lt;br&gt;
						【日志内容】：${message} ${exception} &lt;hr size=2 color=red&gt;" />
	</targets>
	<rules>
		<!-- Microsoft.*表示通配符，所有微软日志将被过滤 -->
		<logger name="Microsoft.*" minlevel="Trace"  final="true" />
		<logger name="*" minlevel="Trace" writeTo="TraceFile" />
	</rules>
</nlog>

&lt;br&gt;

在上面的代码中，转义符&lt;表示<，&gt;表示>，因此&lt;br&gt;就表示html中的换行符号<br>。

&lt;hr size=2 color=red&gt;

同理，&lt;hr size=2 color=red&gt;表示<hr size=2 color=red>，也就是在html中定义一条分割线。程序运行结果如下所示：

在这里插入图片描述

7、结语

本文主要介绍了NLog的基础使用方法，实现了将日志写入文本文件和html的操作。在实际业务中，将日志记录到数据库中也是一项常见的操作，关于数据库中记录日志的相关操作我会在后续的博客中进行介绍。

HerryDong
关注
  • 3
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Asp.Net Core用NLog记录日志操作方法
10-16
在本文中，我们将详细介绍如何使用NLog在Asp.Net Core中进行日志记录，并满足特定需求。 需求分析： 1. 自动写入日志到数据库和文件：NLog允许配置多个目标（Targets），如文件和数据库，以实现日志的多渠道记录。 ...
asp.net core 使用NLog打印日志到txt文件
03-30
asp.net core 使用NLog打印日志到txt文件。 每个txt文件支持设置最大值，如设置为1M，则每个日志超过1M，会生成新的日志文件； 日志支持显示所在位置以及行号；
ASP.NET Core：ASP.NET Core中使用NLog记录日志
songjuntao8的专栏
05-08 1028
一、前言 在所有的应用程序中，日志功能是不可或缺的模块，我们可以根据日志信息进行调试、查看产生的错误信息，在ASP.NET Core中我们可以使用log4net或者NLog日志组件来实现记录日志的功能，这里讲解如何在ASP.NET Core中使用NLog。 这里采用的是.NET Core 3.1创建应用程序。 那么什么是NLog呢？ NLog是一个基于.NET平台编写的类库，我们可以使用NLog在应用程序中添加即为完善的跟踪调试代码。 NLog是一个简单灵活的.NET日志记录类库。通过使用NLog
.NET Core项目NLog日志框架使用
fly_duck的博客
08-02 7356
项目中日志是比较常见的一个功能模块，在开发阶段和运维阶段我们可以根据日志排查项目出现的问题，同时可以为项目运营阶段提供业务数据分析。所以日志是项目中不可或缺的功能模块，项目中一般会根据项目需要开发偏向业务的日志模块，而本博客主要介绍第三方日志框架NLog。通过引入NLog日志框架，项目中可以快速的实现基本的日志模块，大大的提高了开发效率。 NLog的Github地址：https://github...
ASP.NET 8 日志处理之NLog
最新发布
学会分享
03-30 497
日志处理之NLog
『NLog』.Net使用NLog使用方式及详细配置（输出至文件/RabbitMQ/远程网络Tcp）
热门推荐
老陈聊架构
03-03 1万+
📣读完这篇文章里你能收获到， Nlog输出至文件/RabbitMQ/远程网络Tcp配置文档， Nlog配置参数详解， .NET CORE项目接入
.net core3.1启用NLog记录日志
shaojiayong的博客
10-20 1735
前言 在之前的文章我们已经把.net core api项目成功部署到linux系统，接下来准备开始完善补齐我们的接口项目，一般.net项目记录日志信息的架包最常用的就是log4net跟NLog，根据自己喜好，本文使用的是NLog。 开始 创建一个新的ASP.NET Core项目 ...
.net core 3.0 NLog 日志的使用
Crazy2910的专栏
12-01 761
主要是配置多租户的 Nlog的 记录日志
ASP.NET Core开发教程之Logging利用NLog写日志文件
10-18
一直很喜欢 NLog 的简洁和扩展性，所以下面这篇文章主要给大家介绍了关于ASP.NET Core开发教程之Logging利用NLog写日志文件的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下
使用NLog给Asp.Net Core做请求监控的方法
10-18
本文将详细讲解如何使用NLog为Asp.Net Core应用设置请求监控。 首先，我们需要理解Asp.Net Core的请求管道。与Asp.Net Web API中的DelegatingHandler类似，Asp.Net Core引入了中间件（Middleware）的概念。中间件是...
ASP.NET COR3.1 集成日志插件NLog
zy0412326的专栏
02-19 210
ASP.NET COR3.1 集成日志插件NLog
.Net Core2.1+NLog
09-14
.Net Core2.1+NLog+数据库连接 <?xml version="1.0" encoding="utf-8" ?> <nlog xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true" throwExceptions="true" internalLogLevel="warn" internalLogFile="logfiles/internal-nlog.txt"> <targets> <target xsi:type="Null" name="blackhole" /> <target name="database" xsi:type="Database" dbProvider="System.Data.SqlClient" connectionString="Data Source=127.0.0.1;Initial Catalog=MiddleData;User ID=lzhu;Password=bl123456;" > <!-- create table NLog ( Id int identity, Application nvarchar(50) null, Logged datetime null, Level nvarchar(50) null, Message nvarchar(512) null, Logger nvarchar(250) null, Callsite nvarchar(512) null, Exception nvarchar(512) null, constraint PK_NLOG primary key (Id) ) --> <commandText> insert into nlog ( Application, Logged, Level, Message, Logger, CallSite, Exception ) values ( @Application, @Logged, @Level, @Message, @Logger, @Callsite, @Exception ); </commandText> <parameter name="@application" layout="NLogTestDemo" /> <parameter name="@logged" layout="${date}" /> <parameter name="@level" layout="${level}" /> <parameter name="@message" layout="${message}" /> <parameter name="@logger" layout="${logger}" /> <parameter name="@callSite" layout="${callsite:filename=true}" /> <parameter name="@exception" layout="${exception:tostring}" /> </target> </targets> <rules> <!--Skip Microsoft logs and so log only own logs--> <logger name="Microsoft.*" minlevel="Trace" writeTo="blackhole" final="true" /> <logger name="NLogTestDemo.*" minlevel="Info" writeTo="database" /> </rules> </nlog>
AspNetCoreNlog：ASP.NET Core NLog MS SQL Server PostgreSQL MySQL Elasticsearch
01-28
本系列中的NLog帖子： 历史 2020-01-12更新到.NET Core 3.1，NLog.Web.AspNetCore 4.9.0 2018-04-04更新至.NET Core 2.0，NLog 4.5.1和Elasticsearch Nuget程序包 使用NLog和MS SQLServer的ASP.NET Core日志记录 本文介绍如何在使用NLog登录到Microsoft SQL Server的ASP.NET Core应用程序中设置日志记录。 NLog.Web.AspNetCore Nuget包已添加到csproj文件中的依赖项中。 < Project xss=removed> < PropertyGroup> < TargetFramework>netcoreapp3.1</ TargetFramework> </ PropertyGroup> < ItemGroup> < PackageReference Include = " NLog.Targets.ElasticSearch "
.NetCore 下简单学习NLog日志写入文件
程序员思维的博客
11-05 1003
1、新建Asp.Net Core Web 应用程序。
netcore的NLog使用小记
weixin_30552811的博客
04-18 155
1. 启动应用程序日志配置 修改Program.cs，在WebHostBuilder构建时配置日志 public static IWebHostBuilder CreateWebHostBuilder(string[] args) => 　　WebHost.CreateDefaultBuilder(args) 　　.UseStartup...
.net core 3.1 添加 Nlog日志
fqydhk的专栏
03-07 4052
.net core 3.1 添加 Nlog日志 交流QQ群:555913397 有什么问题可以加群大家一起交流 1.添加Nuget程序包 1.1 NLog 1.2 NLog.Web.AspNetCore 2.创建Nlog配置文件 2.1创建的文件名称为 nlog.config (ps:也可以自定义其他名字,加载配置文件时修改为自定义的名称即可) 2.2 下面配置文件打印出来的效果如...
ASP.NET CORE Webapi项目配置Nlog
weixin_44172770的博客
04-08 858
1.安装Nlog.Web.ApsNetCore 2.添加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" intern...
.NET学习笔记----关于.NET Core那些事(1)【.netcore的项目结构、五种向页面传值的方式、Log4Net和NLog的使用】
qq_37739112的博客
01-20 1115
一、.NET Core的项目结构 二、向页面传值的五种方法 三、Log4Net与NLog的使用
Asp.Net Core Web应用程序—探索
li123128的博客
04-22 187
　　作为一个Windows系统下的开发者，我对于Core的使用机会几乎为0，但是考虑到微软的战略规划，我觉得，Core还是有先了解起来的必要。 　　 　　因为，目前微软已经搞出了两个框架了，一个是Net标准(.NetFramework)，一个是Net Core。 　　 　　而新特性的更新几乎都是在Net Core这个框架中。 　　 　　所以，考虑到未来，一旦Core完善了，那微软肯定会放弃现在的....
[.Net Core] - 使用 NLog 记录日志到 Sql Server
05-27
好的，以下是使用NLog将日志记录到SqlServer的步骤： 1. 首先，需要在项目中安装NLog和NLog.Web.AspNetCore包。可以使用NuGet包管理器或在项目文件中手动添加依赖项。 2. 在项目的appsettings.json文件中添加以下NLog配置： ``` "NLog": { "targets": { "database": { "type": "Database", "dbProvider": "System.Data.SqlClient", "connectionString": "Server=[server];Database=[database];User Id=[user];Password=[password];", "commandText": "INSERT INTO [Logs] ([Date], [Level], [Logger], [Message], [Exception]) VALUES (@Date, @Level, @Logger, @Message, @Exception);", "parameter": [ { "name": "@Date", "layout": "${date}" }, { "name": "@Level", "layout": "${level}" }, { "name": "@Logger", "layout": "${logger}" }, { "name": "@Message", "layout": "${message}" }, { "name": "@Exception", "layout": "${exception}" } ] } }, "rules": [ { "logger": "*", "minLevel": "Trace", "writeTo": "database" } ] } ``` 3. 在Startup.cs文件中添加以下代码： ```csharp public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory) { //... loggerFactory.AddNLog(); //... app.UseMiddleware<NLogMiddleware>(); //... } ``` 4. 创建一个名为Logs的表，用于存储日志记录。表结构应如下所示： ```sql CREATE TABLE [dbo].[Logs]( [Id] [int] IDENTITY(1,1) NOT NULL, [Date] [datetime2](7) NOT NULL, [Level] [nvarchar](50) NOT NULL, [Logger] [nvarchar](250) NOT NULL, [Message] [nvarchar](max) NOT NULL, [Exception] [nvarchar](max) NULL, CONSTRAINT [PK_Logs] PRIMARY KEY CLUSTERED ( [Id] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY] ``` 5. 现在，可以在代码中使用NLog记录日志了。例如： ```csharp private readonly ILogger<HomeController> _logger; public HomeController(ILogger<HomeController> logger) { _logger = logger; } public IActionResult Index() { _logger.LogInformation("Hello, world!"); return View(); } ``` 这将在Logs表中插入一条日志记录。 希望这可以帮助到你。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值