Asp .Net Core 集成 NLog

简介

NLog是一个基于.NET平台编写的日志记录类库，它可以在应用程序中添加跟踪调试代码，以便在开发、测试和生产环境中对程序进行监控和故障排除。NLog具有简单、灵活和易于配置的特点，支持在任何一种.NET语言中输出带有上下文的调试诊断信息，并能够将这些信息发送到一个或多个输出目标（target）中，如文件、数据库、控制台等。

NLog的API非常类似于log4net，但配置方式更加简单，使用路由表（routing table）进行配置，使得配置文件易于阅读和维护。此外，NLog还支持结构化日志记录，可以方便地记录复杂的数据类型，如对象、集合等。它还提供了可扩展性，允许用户编写自定义目标或传递自定义值，以满足特定的日志记录需求。

NLog支持多种平台，包括.NET Framework、.NET Core、Xamarin、ASP.NET等，可以在各种应用程序中使用。同时，NLog还遵从BSD license，允许商业应用且完全开放源代码，因此得到了广泛的应用和支持。

NLog 支持结构化日志 记录和传统日志记录。

NLog的重点是：高性能、易于使用、易于扩展和灵活配置。

 

NLog配置文件说明

文件位置

启动时，NLog 在各种文件中搜索其配置，如下所述。它加载找到的第一个 nlog 配置。当找到第一个 nlog 配置时，搜索结束。如果未找到配置，NLog 将不会执行任何日志记录。

对于独立的 *.exe 应用程序，按如下方式搜索文件：

  • 标准应用程序配置文件 app.config（例如 applicationname.exe.config）
  • 应用程序目录中的 applicationname.exe.nlog
  • 应用程序目录中的 NLog.config
  • NLog.dll.nlog 位于 NLog.dll 所在目录中（仅当 NLog 未安装在 GAC 中时）

对于 ASP.NET 应用程序，按如下方式搜索文件：

  • 标准 Web 应用程序配置文件 web.config
  • web.nlog 与 web.config 位于同一目录
  • 应用程序目录中的 NLog.config
  • NLog.dll.nlog 位于 NLog.dll 所在目录中（仅当 NLog 未安装在 GAC 中时）

另请参阅显式 NLog 配置加载（包括有关assetsXamarin Android 的 -folder 的详细信息）

元素说明

您可以使用以下元素作为 的子元素nlog。targets和rules在任何配置中都是必需的 其他是可选的，并且在高级场景中很有用。

  • targets– 定义日志目标/输出
  • rules– 定义日志路由规则
  • extensions– 从 *.dll 文件加载 NLog 扩展
  • include– 包括外部配置文件
  • variable– 设置配置变量的值
Targets：定义日志目标/输出
<targets><target name="f"xsi:type="File"fileName="${basedir}/logs/${shortdate}.log"layout="${longdate} ${uppercase:${level}} ${message}" maxArchiveFiles="5"archiveAboveSize="10240"archiveEvery="Day"/>
</targets>0

Nlog允许用户配置单个文件大小, 放置在内容过长效率过慢,配置了大小之后, Nlog会自动创建一个新的文件副本,插入新的日志输出。

maxArchiveFiles：允许生成的副本文件最大数量

archiveAboveSize：允许单个文件得最大容量

archiveEvery：按天生成

name：输出目标的名称，用于rules中路由规则writeTo指定

fileName：包含完整的生成文件的路径和文件名

xsi:type：输出类型如下

Chainsaw
ColoredConsole 
Console
Database
Debug
Debugger
EventLog
File
LogReceiverService
Mail
Memory
MethodCall
Network
NLogViewer
Null
OutputDebugString
PerfCounter
Trace
WebService

layout：用来规定输出内容格式，语法“${属性}”，可以把上下文信息插入到日志中。

系统变量参考：Config | NLog

Rules– 定义日志路由规则

路由顺序会对日志打印产生影响。路由匹配逻辑为顺序匹配。

日志可以分不同级别进行输出，日志规则rules里面可以控制输出的日志级别。不同级别的日志代表日志的重要程度，比如一些debug级别的日志在生产环境就会被控制不输出，以减少日志文件的大小。

<rules><logger name="*" minlevel="Debug" writeTo="file" />
</rules>name：记录者的名字。
  • ame– 匹配记录器对象的记录器名称 - 可能包含通配符（* 和 ?）
  • minlevel– 记录的最低级别（与指定级别和上面的级别匹配）
  • maxlevel– 记录的最大级别（与指定级别和下面的级别匹配）
  • level– 单级记录
  • levels- 以逗号分隔的要记录的级别列表
  • writeTo– 以逗号分隔的要写入的目标列表
  • final– 最终规则匹配后不处理任何规则
  • enabled- 设置为false禁用规则而不删除它
  • ruleName- 允许使用 Configuration.FindRuleByName和进行规则查找的规则标识符Configuration.RemoveRuleByName。NLog 4.6.4 中引入
  • FinalMinLevel - 记录器匹配将被限制为以下规则的指定最低级别。NLog 5.0中引入

日志级别有如下，自上而下，等级递增。

  • Trace - 最常见的记录信息，一般用于普通输出
  • Debug - 同样是记录信息，不过出现的频率要比Trace少一些，一般用来调试程序
  • Info - 信息类型的消息
  • Warn - 警告信息，一般用于比较重要的场合
  • Error - 错误信息
  • Fatal - 致命异常信息。一般来讲，发生致命异常之后程序将无法继续执行。

日志过滤器：可以在路由当中, 为每个路由配置自定义得日志过滤器fliter，如下所示

<rules><logger name="*" writeTo="file"><filters><when condition="length('${message}') > 100" action="Ignore" /><when condition="equals('${logger}','MyApps.SomeClass')" action="Ignore" /><when condition="(level >= LogLevel.Debug and contains('${message}','PleaseDontLogThis'))" action="Ignore" /><when condition="not starts-with('${message}','PleaseLogThis')" action="Ignore" /></filters></logger>
</rules>

Asp .Net Core 集成 NLog

安装 NLog.Web.AspNetCore 包

  1. 在您的项目中，通过 NuGet 包管理器安装 NLog.Web.AspNetCore 包。在 Visual Studio 中，您可以右键点击项目 -> 选择 "Manage NuGet Packages" -> 搜索 NLog.Web.AspNetCore -> 点击 "Install"。

    或者通过命令行安装：

    dotnet add package NLog.Web.AspNetCore

  2. 配置 NLog

    创建一个 nlog.config 文件在项目的根目录下，并添加您的 NLog 配置。例如：

<?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"  throwExceptions="false"  internalLogLevel="Info" internalLogFile="internal-nlog.txt">  <!-- 定义日志输出目标 -->  <targets>  <target xsi:type="File" name="file" fileName="${basedir}/logs/nlog.txt"  layout="${longdate} ${level:uppercase=true} ${message} ${exception}" />  </targets>  <!-- 定义日志规则 -->  <rules>  <logger name="*" minlevel="Debug" writeTo="file" />  </rules>  
</nlog>

  1. 在 Program.cs 中配置 NLog

    // 添加 NLog  
builder.Logging.ClearProviders();  
//builder.Logging.SetMinimumLevel(LogLevel.Debug);  
//NLogBuilder.ConfigureNLog("nlog.config");  
builder.Host.UseNLog();

  2. 使用 NLog

    现在您可以在控制器、服务等中注入 ILogger 并使用它记录日志。NLog 将处理这些日志并记录到配置的目标中。

    using Microsoft.AspNetCore.Mvc;namespace NLogTest.Controllers
{[ApiController][Route("[controller]")]public class WeatherForecastController : ControllerBase{private readonly ILogger<WeatherForecastController> _logger;public WeatherForecastController(ILogger<WeatherForecastController> logger){_logger = logger;}[HttpGet(Name = "GetWeatherForecast")]public IEnumerable<WeatherForecast> Get(){try{           int a = 1 / int.Parse("0");return null;}catch (Exception ex){_logger.LogDebug(ex, ex.Message);_logger.LogTrace(ex, ex.Message);_logger.LogInformation(ex, ex.Message);_logger.LogWarning(ex, ex.Message);_logger.LogError(ex, ex.Message);return Enumerable.Empty<WeatherForecast>();}}}
}

NLog 自定义全局变量

            app.Use(async (context, next) =>{GlobalDiagnosticsContext.Set("TenantId", 1);GlobalDiagnosticsContext.Set("CreateUserId", 111);await next();});// 使用
${gdc:TenantId}

将日志消息写入MySQL数据库

Database target · NLog/NLog Wiki · GitHub

安装Nuget包

dotnet add package NLog.Database
dotnet add package MySql.Data

数据库准备(MySQL)

create database mcode_log;
use mcode_log;
create table if not exists erp_log
(Id              bigint auto_increment comment '主键'primary key,TenantId        bigint       null comment '租户Id',ApplicationName varchar(100) null comment '程序名称',HostName        varchar(100) null comment '主机',Ip              varchar(100) null comment 'Ip地址',Message         text         null comment '信息',Level           varchar(50)  null comment '级别',ExceptionInfo   text         null comment '异常信息',CallInfo        text         null comment '调用信息',RequestMethod   varchar(20)  null comment '请求方法',RequestUrl      varchar(512) null comment '请求地址',RequestBody     text         null comment '请求主体',CreateTime      datetime     null comment '创建时间',CreateUserId    bigint       null comment '创建用户',CreateUserName  varchar(50)  null comment '创建用户名称'
);

配置NLog

<?xml version="1.0" encoding="utf-8"?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"autoReload="true"throwExceptions="false" throwConfigExceptions="true"internalLogLevel="warn"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><!--生产环境 throwExceptions 建议为false --><extensions><add assembly="NLog.Web.AspNetCore"/><add assembly="NLog.Database"/></extensions><!--internalLogFile="logfiles"--><targets async="true"><!--屏幕打印消息--><target name="console" xsi:type="ColoredConsole"layout="${newline}=======================================================================${newline} 【当前时间】: [${date:format=yyyy-MM-dd HH\:mm\:ss}]                           ${newline} 【 级 别 】：[${level}]                            ${newline} 【 调 用 】：[${callsite}] [${callsite-linenumber}] [${callsite-filename}] [${stacktrace}]                                                            ${newline} 【 消 息 】：[${message}]   ${newline} 【 异 常 】：[${exception:format=ToString}] [${threadname}] [${threadid}]" /><!--VS输出窗口--><target name="debugger" xsi:type="Debugger"layout="${newline}=======================================================================${newline} 【当前时间】: [${date:format=yyyy-MM-dd HH\:mm\:ss}]                           ${newline} 【 级 别 】：[${level}]                            ${newline} 【 调 用 】：[${callsite}] [${callsite-linenumber}] [${callsite-filename}] [${stacktrace}]                                                            ${newline} 【 消 息 】：[${message}]   ${newline} 【 异 常 】：[${exception:format=ToString}] [${threadname}] [${threadid}]" /><!--保存至文件--><target name="info" xsi:type="File" maxArchiveFiles="30"fileName="${basedir}/Logs/Info/${shortdate}.txt"layout="${newline}=======================================================================${newline} 【当前时间】: [${date:format=yyyy-MM-dd HH\:mm\:ss}]                           ${newline} 【 级 别 】：[${level}]                            ${newline} 【 调 用 】：[${callsite}] [${callsite-linenumber}] [${callsite-filename}] [${stacktrace}]                                                            ${newline} 【 消 息 】：[${message}]   ${newline} 【 异 常 】：[${exception:format=ToString}] [${threadname}] [${threadid}]" /><!--保存至文件--><target name="error" xsi:type="File" maxArchiveFiles="30"fileName="${basedir}/Logs/Error/${shortdate}.txt"layout="${newline}=======================================================================${newline} 【当前时间】: [${date:format=yyyy-MM-dd HH\:mm\:ss}]                           ${newline} 【 级 别 】：[${level}]                            ${newline} 【 调 用 】：[${callsite}] [${callsite-linenumber}] [${callsite-filename}] [${stacktrace}]                                                            ${newline} 【 消 息 】：[${message}]   ${newline} 【 异 常 】：[${exception:format=ToString}] [${threadname}] [${threadid}]" /><!--写入数据库--><target xsi:type="Null" name="blackhole"/><target name="database" xsi:type="Database"dbProvider="MySql.Data.MySqlClient.MySqlConnection, MySql.Data"connectionString="server=110.41.14.13;Database=mcode_log;user id=root;password=123456;SslMode=none"><!--<target name="database" xsi:type="Database"dbProvider="MySqlConnector.MySqlConnection, MySqlConnector"connectionString="server=127.0.0.1;Database=mcode_log;user id=root;password=123456;SslMode=none">--><commandText>insert into erp_log (TenantId, ApplicationName, HostName, Ip, Message, Level, ExceptionInfo, CallInfo,RequestMethod, RequestUrl, RequestBody, CreateTime, CreateUserId, CreateUserName)values (@TenantId,@ApplicationName,@HostName,@Ip,@Message,@Level,@ExceptionInfo,@CallInfo,@RequestMethod,@RequestUrl,@RequestBody,@CreateTime,@CreateUserId,@CreateUserName);</commandText><!--注意：对于非字符串，要指定dbType"--><parameter name="@TenantId" layout="${gdc:TenantId}"  dbType="DbType.Int64" /><parameter name="@ApplicationName" layout="${gdc:ApplicationName}"   /><parameter name="@HostName" layout="${hostname}" /><parameter name="@Ip" layout="${gdc:Ip}" /><parameter name="@Message" layout="${message}" /><parameter name="@Level" layout="${level}" /><parameter name="@ExceptionInfo" layout="[${exception:format=ToString}] [${threadname}] [${threadid}]" /><parameter name="@CallInfo" layout="[${callsite}] [${callsite-linenumber}] [${callsite-filename}] [${stacktrace}]" /><parameter name="@RequestMethod" layout="${gdc:RequestMethod}" /><parameter name="@RequestUrl" layout="${gdc:RequestUrl}" /><parameter name="@RequestBody" layout="${gdc:RequestBody}" /><parameter name="@CreateTime" layout="${date}"  dbType="DbType.DateTime" /><parameter name="@CreateUserId" layout="${gdc:CreateUserId}" dbType="DbType.Int64" /><parameter name="@CreateUserName" layout="${gdc:CreateUserName}" /></target></targets><!--规则--><rules><logger name="*" minlevel="Warn" writeTo="console" /><logger name="NLogTest.*" minlevel="Debug"  writeTo="debugger" /><logger name="NLogTest.*" minlevel="Info" maxlevel="Info"  writeTo="info" /><logger name="*" minlevel="Warn" writeTo="error" /><logger name="NLogTest.*" minlevel="Warn" writeTo="database" /></rules>
</nlog>

在这里插入图片描述
在这里插入图片描述

其它数据库

MySql and .NET Core

Install package: NuGet Gallery | MySql.Data 8.3.0

dbProvider="MySql.Data.MySqlClient.MySqlConnection, MySql.Data"

or if using packages: NuGet Gallery | MySqlConnector 2.3.5 and NuGet Gallery | MySqlConnector.Logging.NLog 2.0.0

dbProvider="MySqlConnector.MySqlConnection, MySqlConnector"
System.Data.SQLite and .NET Core

Install package: NuGet Gallery | System.Data.SQLite 1.0.118

dbProvider="System.Data.SQLite.SQLiteConnection, System.Data.SQLite"
Microsoft.Data.SqlClient and .NET Core

Install package: NuGet Gallery | Microsoft.Data.SqlClient 5.1.5

dbProvider="Microsoft.Data.SqlClient.SqlConnection, Microsoft.Data.SqlClient"
Microsoft.Data.Sqlite and .NET Core

Install package: NuGet Gallery | Microsoft.Data.Sqlite 8.0.1

dbProvider="Microsoft.Data.Sqlite.SqliteConnection, Microsoft.Data.Sqlite"
Npgsql and .NET core

Install package: NuGet Gallery | Npgsql 8.0.1

dbProvider="Npgsql.NpgsqlConnection, Npgsql"
Oracle.ManagedDataAccess and .NET
dbProvider="Oracle.ManagedDataAccess.Client.OracleConnection, Oracle.ManagedDataAccess"
Mono.Data.Sqlite and .NET
dbProvider="Mono.Data.Sqlite.SqliteConnection, Mono.Data.Sqlite"

INI 复制 全屏

记录故障排除

有时我们的应用程序不会向日志文件写入任何内容，即使我们应该正确配置了日志记录。日志未写入的原因可能有很多。最常见的问题是权限问题，通常在 ASP.NET 进程中，其中aspnet_wp.exe或w3wp.exe进程可能没有对我们要存储日志的目录的写访问权限。

NLog 旨在吞掉日志记录可能导致的运行时异常。以下设置可以更改此行为和/或重定向这些消息。

  • <nlog throwExceptions="true" />-throwExceptions在配置文件中添加该属性会导致 NLog 停止屏蔽异常并将其传递给调用应用程序。该属性在部署时非常有用，可以快速定位任何问题。至关重要的是，一旦应用程序正确配置throwExceptions为"false"运行，就应立即进行配置，这样意外的日志记录问题就不会导致应用程序挂起或崩溃。
  • <nlog throwConfigExceptions="true" /> - 类似于throwExceptions但仅与配置异常隔离。与此不同的是throwExceptions，启用它并不危险，建议在生产环境中启用，因为在生产环境中，日志记录配置的初始设置成功至关重要。NLog 4.3 中引入。默认null（表示未配置，而是使用 的值throwExceptions）
  • <nlog internalLogLevel="Trace|Debug|Info|Warn|Error|Fatal" />– 确定内部日志级别。级别越高，内部日志输出越不详细。当需要诊断日志记录问题时，输出通常非常有帮助。有关设置输出到文件或控制台的选项，请参阅内部日志记录。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/457982.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

transformer剪枝论文汇总

transformer剪枝论文汇总

文章目录 NN Pruning摘要实验 大模型剪枝LLM-PrunerSparseGPT LTPVTPWidth & Depth PruningPatch SlimmingDynamicViTSPViTDynamicBERTViT SlimmingFastFormersNViTUVCPost-training pruning NN Pruning 《Block Pruning For Faster Transformers》 《为更快的transformer…
阅读更多...
删除和清空Hive外部表数据

删除和清空Hive外部表数据

外部表和内部表区别 未被external修饰的是内部表&#xff08;managed table&#xff09;&#xff0c;被external修饰的为外部表&#xff08;external table&#xff09;&#xff1b; 区别&#xff1a; 内部表数据由Hive自身管理&#xff0c;外部表数据由HDFS管理&#xff1b; …
阅读更多...
Flink 2.0 状态存算分离改造实践

Flink 2.0 状态存算分离改造实践

本文整理自阿里云智能 Flink 存储引擎团队兰兆千在 FFA 2023 核心技术&#xff08;一&#xff09;中 的分享&#xff0c;内容关于 Flink 2.0 状态存算分离改造实践的研究&#xff0c;主要分为以下四部分&#xff1a; Flink 大状态管理痛点 阿里云自研状态存储后端 Gemini 的存…
阅读更多...
golang windows 环境搭建 环境配置

golang windows 环境搭建 环境配置

golang windows 环境搭建 环境配置 Golang学习之路一环境搭建 MacBook Linux 树莓派raspberrypi安装Golang环境 官网下载地址: https://go.dev/dl/ https://golang.google.cn/dl/ 下载对应系统版本&#xff0c;例如windows 64位系统&#xff0c;下载&#xff1a;xxx.window…
阅读更多...
vue项目打包时如何去除文件的hash值？

vue项目打包时如何去除文件的hash值？

默认情况下&#xff0c;生成的静态资源在它们的文件名中包含了 hash 以便更好的控制缓存。然而&#xff0c;这也要求 index 的 HTML 是被 Vue CLI 自动生成的。如果你无法使用 Vue CLI 生成的 index HTML&#xff0c;你可以通过将这个选项设为 false 来关闭文件名哈希。 vue.c…
阅读更多...
uniapp 使用renderjs引入echarts

uniapp 使用renderjs引入echarts

效果图&#xff1a; 1.1renderjs引入echarts 组件zmui-echarts.vue&#xff1a; <template><view class"zmui-echarts" :prop"option" :change:prop"echarts.delay"></view> </template><script>export defaul…
阅读更多...
mac电脑快捷指令实现拼图

mac电脑快捷指令实现拼图

mac访达&#xff0c;搜索输入‘快捷指令’&#xff0c;找到‘快捷指令’&#xff0c; 点击快捷指令&#xff0c;进入快捷指令中心&#xff0c;搜索‘拼图’ &#xff0c;选中‘照片拼图’&#xff0c; 点击‘添加快捷指令’&#xff0c; 在‘所有快捷键指令’中可以看到添加的快…
阅读更多...
我的docker随笔43：问答平台answer部署

我的docker随笔43：问答平台answer部署

本文介绍开源问答社区平台Answer的容器化部署。 起因 笔者一直想搭建一个类似stack overflower这样的平台&#xff0c;自使用了Typora&#xff0c;就正式全面用MarkdownTyporagit来积累自己的个人知识库&#xff0c;但没有做到web化&#xff0c;现在也还在探索更好的方法。 无…
阅读更多...
Swift Combine 从入门到精通一

Swift Combine 从入门到精通一

1. Combine 简介 用 Apple 官方的话来说&#xff0c;Combine 是: a declarative Swift API for processing values over time. Combine 是 Apple 用来实现函数响应式编程的库&#xff0c; 类似于 RxSwift。 RxSwift 是 ReactiveX 对 Swift 语言的实现。 Combine 使用了许多可以…
阅读更多...
论文阅读-Transformer-based language models for software vulnerability detection

论文阅读-Transformer-based language models for software vulnerability detection

「分享了一批文献给你&#xff0c;请您通过浏览器打开 https://www.ivysci.com/web/share/biblios/D2xqz52xQJ4RKceFXAFaDU/ 您还可以一键导入到 ivySCI 文献管理软件阅读&#xff0c;并在论文中引用 」 本文主旨&#xff1a;本文提出了一个系统的框架来利用基于Transformer的语…
阅读更多...
开启一个服务，将服务器指定的文件读取，传播到网上其他终端

开启一个服务，将服务器指定的文件读取，传播到网上其他终端

from flask import Flask, render_template_string app Flask(__name__)app.route(/get-data) def get_data():# 读取data.txt文件的内容with open(r./2024/2/4/data.txt, r) as file:data file.read()print(data)# 返回数据的HTML表示return render_template_string(<div…
阅读更多...
基于Linux的HTTP代理服务器搭建与配置实战

基于Linux的HTTP代理服务器搭建与配置实战

在数字化世界中&#xff0c;HTTP代理服务器扮演着至关重要的角色&#xff0c;它们能够帮助我们管理网络请求、提高访问速度&#xff0c;甚至在某些情况下还能保护我们的隐私。而Linux系统&#xff0c;凭借其强大的功能和灵活性&#xff0c;成为了搭建HTTP代理服务器的理想选择。…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023