asp.net core NLog 配置

最新推荐文章于 2024-08-01 04:18:00 发布

霍夫曼

最新推荐文章于 2024-08-01 04:18:00 发布

阅读量698

点赞数 1

文章标签： java python log4j 大数据 json

本文链接：https://blog.csdn.net/hofmann/article/details/111659854

版权

本文介绍了如何在 ASP.NET Core 项目中配置和使用 NLog 进行日志记录，包括设置日志级别、创建 NLog.config 文件、配置目标（如文件日志）以及编写规则。同时，展示了如何在 Program.cs 中集成 NLog，并在业务控制器中注入并使用日志。此外，还展示了如何实现全局异常过滤器来捕获并记录异常。

摘要由CSDN通过智能技术生成

NuGet 添加引用NLog.Config 和 NLog.Web.AspNetCore
添加NLog.Config引用时会自动在项目根目录生成一个NLog.config文件，把文件属性设置成总是复制

日志级别：Trace -> Debug-> Information -> Warning -> Error-> Critical

修改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" xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd" autoReload="true" throwExceptions="false" internalLogLevel="Off" internalLogFile="c:\temp\nlog-internal.log"> <!-- optional, add some variables https://github.com/nlog/NLog/wiki/Configuration-file#variables --> <variable name="myvar" value="myvalue"/> <!-- See https://github.com/nlog/nlog/wiki/Configuration-file for information on customizing logging rules and outputs. --> <targets> <!-- add your targets here See https://github.com/nlog/NLog/wiki/Targets for possible targets. See https://github.com/nlog/NLog/wiki/Layout-Renderers for the possible layout renderers. --> <!-- Write events to a file with the date in the filename. <target xsi:type="File" name="f" fileName="${basedir}/logs/${shortdate}.log" layout="${longdate} ${uppercase:${level}} ${message}" /> --> <!--Error保存至文件--> <target name="error_file" xsi:type="File" maxArchiveFiles="30" encoding="utf-8" fileName="${basedir}/Logs/${date:yyyyMMdd}_Error.log" archiveFileName="${basedir}/Logs/${date:yyyyMMdd}_Error.{#}.log" archiveDateFormat="yyyyMMdd" archiveAboveSize="104857600" archiveNumbering="Sequence" layout="${date:yyyy-MM-dd HH\:mm\:ss} ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace}" /> <!--Trace保存至文件--> <target name="trace_file" xsi:type="File" maxArchiveFiles="30" encoding="utf-8" fileName="${basedir}/Logs/${date:yyyyMMdd}_Trace.log" archiveFileName="${basedir}/Logs/${date:yyyyMMdd}_Trace.{#}.log" archiveDateFormat="yyyyMMdd" archiveAboveSize="104857600" archiveNumbering="Sequence" layout="${date:yyyy-MM-dd HH\:mm\:ss} ${uppercase:${level}}： ${message}" /> </targets> <rules> <!-- add your logging rules here --> <logger name="*" minlevel="Trace" maxlevel="Warn" writeTo="trace_file" /> <!--<logger name="*" minlevel="Debug" writeTo="debugger" />--> <logger name="*" minlevel="Error" writeTo="error_file" /> <!-- Write all events with minimal level of Debug (So Debug, Info, Warn, Error and Fatal, but not Trace) to "f" <logger name="*" minlevel="Debug" writeTo="f" /> --> </rules> </nlog>

在Program.cs文件中添加如下代码：

            .ConfigureLogging(logging =>
            {
                logging.ClearProviders();
            }).UseNLog()

添加后如下：

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

注入和调用如下：

        private readonly ILogger<BusinessController> _logger;

        public BusinessController(ILogger<BusinessController> logger) { _logger = logger; } [HttpGet] public string Test() { var json = DateTime.Now.ToString(); _logger.LogInformation(json); _logger.LogError(json); _logger.LogDebug(json); _logger.LogCritical(json); _logger.LogTrace(json); _logger.LogWarning(json); return json; }

输出文件位置\bin\Debug\netcoreapp3.1，目录中会自建一个文件夹Logs

\bin\Debug\netcoreapp3.1\Logs

全局异常，添加过滤器；并在Startup.cs文件的ConfigureServices方法中添加过滤器

public class GlobalExceptionFilter: IExceptionFilter
    {
       public static Logger logger = LogManager.GetCurrentClassLogger();

        public void OnException(ExceptionContext filterContext)
        {
            logger.Error(filterContext.Exception);
            var result = new BaseResult()
            {
                ResultCode = ResultCodeAddMsgKeys.CommonExceptionCode,//系统异常代码
                ResultMsg = ResultCodeAddMsgKeys.CommonExceptionMsg,//系统异常信息
            };
            filterContext.Result = new ObjectResult(result);
            filterContext.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
            filterContext.ExceptionHandled = true;
        }
    }

参考

　　Asp.Net Core基础NLog记录日志

　　asp.net core 自定义认证方式--请求头认证

　　示例项目

　　Net Core平台灵活简单的日志记录框架NLog+Mysql组合初体验

　　ASP.NET Core 教程：NLog 的使用