ASP.NET Core 中的日志记录

最新推荐文章于 2024-05-06 02:19:39 发布
最新推荐文章于 2024-05-06 02:19:39 发布
阅读量344 收藏
点赞数
文章标签： 运维 网络 git
原文链接：http://www.cnblogs.com/royzshare/p/9454625.html
版权

目录

内置日志的使用

Logger 是 asp .net core 的内置 service，所以我们就不需要在ConfigureService里面注册了。同时在asp.net core 2.0版本及以后，系统已经在CreateDefaultBuilder方法里默认配置了输出到Console和Debug窗口的Logger。

.ConfigureLogging(delegate(WebHostBuilderContext hostingContext, ILoggingBuilder logging)
{
    logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
    logging.AddConsole();
    logging.AddDebug();
})

所以我们可以Controller里面直接注入ILoggerFactory然后再创建具体的Logger。

private readonly ILogger _logger;
public HomeController(ILoggerFactory logger)
{
    _logger = logger.CreateLogger<HomeController>();
}

但是还有更好的方式，Container可以直接提供一个ILogger的实例，这时候呢Logger就会使用T的名字作为日志的类别：

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

然后在【Output】窗口中可以看到输出的日志：

LogDemo> info: LogDemo.Controllers.HomeController[0]
LogDemo>       Return Index view

Log到Debug窗口或者Console窗口还是比较方便的，但是正式生产环境中这肯定不够用。正式环境应该Log到文件或者数据库等。接下来试下Nlog。

使用Nlog

  1. NuGet添加 NLog.Web.AspNetCore。

    <PackageReference Include="Microsoft.AspNetCore.App" />

  2. 添加配置文件

    新建一个文件nlog.config(建议全部小写，linux系统中要注意)， 并右键点击其属性，将其“复制到输出目录”设置为“始终复制”。文件内容如下

    <?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.txt">

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

  <!-- the targets to write to -->
  <targets>
    <!-- write logs to file  -->
    <target xsi:type="File" name="allfile" fileName="c:\temp\nlog-all-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId_Id}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}" />

    <!-- another file log, only own logs. Uses some ASP.NET core renderers -->
    <target xsi:type="File" name="ownFile-web" fileName="c:\temp\nlog-own-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId_Id}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />
  </targets>

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

    <!--Skip non-critical Microsoft logs and so log only own logs-->
    <logger name="Microsoft.*" maxLevel="Info" final="true" />
    <!-- BlackHole without writeTo -->
    <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
  </rules>
</nlog>
        <Content Update="nlog.config">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>

  3. 修改Program.cs文件

    添加引用 NLog.Web 和 Microsoft.Extensions.Logging。
    在 .UseStartup() 后添加一句 .UseNLog() 。

    如果要禁用默认的输出框日志，可以调用logging.ClearProviders()

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .UseStartup<Startup>()
        .ConfigureLogging(logging =>
        {
            logging.ClearProviders();
            logging.SetMinimumLevel(LogLevel.Trace);
        })
        .UseNLog();

  4. 输出到数据库

    除了把日志输出到文件之外，也可以保存到SQL Server， PostgreSQL， MySQL， Elasticsearch等。下面是保存到SQL Server的一个示例配置：

    <?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="d:\temp\logs\internal-nlog.txt">

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

  <!-- the targets to write to -->
  <targets>
    <!-- write logs to file  -->
    <target xsi:type="File" name="allfile" fileName="d:\temp\logs\all-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId_Id}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}" />

    <target name="blackhole" xsi:type="Null" />

    <target name="database" xsi:type="Database" dbProvider="System.Data.SqlClient">
      <connectionString>
        Server=.;Database=Log;Trusted_Connection=True
      </connectionString>
      <commandText>
              insert into dbo.Log (
              Application, Logged, Level, Message,
              Logger, CallSite, Exception
              ) values (
              @Application, @Logged, @Level, @Message,
              @Logger, @Callsite, @Exception
              );
          </commandText>

          <parameter name="@application" layout="Application" />
          <parameter name="@logged" layout="${date}" />
          <parameter name="@level" layout="${level}" />
          <parameter name="@message" layout="url: ${aspnet-request-url} | action: ${aspnet-mvc-action} | ${message}" />

          <parameter name="@logger" layout="${logger}" />
          <parameter name="@callSite" layout="${callsite:filename=true}" />
          <parameter name="@exception" layout="${exception:tostring}" />
    </target>
  </targets>

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

    <!--Skip non-critical Microsoft logs and so log only own logs-->
    <logger name="Microsoft.*" maxLevel="Info" final="true" />
    <!-- BlackHole without writeTo -->
    <logger name="*" minlevel="Info" writeTo="database" />
  </rules>
</nlog>

  5. 配置简要说明

    targets：用于配置输出相关内容，比如 type 属性可选项为File、Mail、Console等，用于设置输出目标，layout属性用于设置输出信息的组成元素及格式。
    rules： 其实是一个“路由表”，日志是从上到下匹配的。 logger name="Microsoft." maxlevel="Info" final="true" 一句话的 final="true" 过滤掉了"Microsoft." Info级别以下的日志。

  6. 全局异常中间件

    除了输出日志外，可以写一个中间件来处理全局的异常。

    public class GlobalErrorHandlingMiddleware
{
    private readonly RequestDelegate next;
    private readonly ILogger<GlobalErrorHandlingMiddleware> _logger;

    public GlobalErrorHandlingMiddleware(RequestDelegate next, ILogger<GlobalErrorHandlingMiddleware> logger)
    {
        this.next = next;
        this._logger = logger;
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await next(context);
        }
        catch (Exception ex)
        {

            var Request = context.Request;
            ///访问路径
            string visit_url = Request.Path;
            ///URL 请求方法
            string method = Request.Method.ToUpper();
            ///URL 请求的参数
            string url_paramters = string.Empty;

            if (method == "GET") url_paramters = Request.QueryString.Value;


            if (method == "POST")
            {
                foreach (var item in Request.Form)
                    url_paramters = url_paramters + item.Key + "=" + item.Value + "&";
            }

            ///错识信息
            string err_msg = ex.Message;//ex.StackTrace;

            ///日志格式内容
            var logs_msg = $"{visit_url}#{method}#{url_paramters}#{err_msg}";

            _logger.LogError(logs_msg);

            var statusCode = context.Response.StatusCode;

            var msg = $"Status Code: {statusCode}, Message: {ex.Message}";

            await HandleExceptionAsync(context, msg);
        }
    }

    private static Task HandleExceptionAsync(HttpContext context, string msg)
    {
        //var data = new Result { Title = "异常中间件返回", Msg = msg };
        //var result = JsonConvert.SerializeObject(data);
        //context.Response.ContentType = "application/json;charset=utf-8";
        return context.Response.WriteAsync(msg);
    }
}

public static class GlobalErrorHandlingMiddlewareExtensions
{
    public static IApplicationBuilder UseGlobalErrorHandlingMiddleware(
        this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<GlobalErrorHandlingMiddleware>();
    }
}

集成ELK

  1. ELK简介

    ELK是三个开源软件的缩写，分别表示：Elasticsearch , Logstash, Kibana , 它们都是开源软件。现在新增了一个FileBeat，它是一个轻量级的日志收集处理工具。
    • Logstash: 是动态数据收集管道，能够同时从多个来源采集数据、转换数据、然后将数据存到数据库中。
    • Elastaicsearch: 分布式搜索和分析引擎，提供搜集、分析、存储数据三大功能。。
    • Kibana：数据可视化Web。
    • Beats: 轻量型采集器的平台，从边缘机器向 Logstash 和 Elasticsearch 发送数据。

    ELK

  2. 环境快速搭建

    这里使用docker-compose一键搭建ELK测试环境：

    1. 请确保已经安装Docker-compose

      docker-compose --version

    2. 下载代码从 The ELK stack powered by Docker and Compose 从并运行：

      git clone https://github.com/deviantony/docker-elk.git
cd docker-elk
docker-compose up -d
    3. 浏览器上访问安装服务器的ip:5601 可以打开 kibana 管理后台
      • 5000: Logstash TCP input.
      • 9200: Elasticsearch HTTP
      • 9300: Elasticsearch TCP transport
      • 5601: Kibana

  3. 修改nlog配置文件

    <target xsi:type="Network"
        name="ownLog-tcp"
        keepConnection="false"
        address="tcp://IP:5000"
        layout="${longdate}|${event-properties:item=EventId_Id}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />

    启动项目测试，进入 kibana 后台配置并添加 index pattern。

  4. 其他写入Elasticsearch的方法

    把日志写入Elasticsearch的方法可以有多种：
    • Logstash：如上面的例子。它的优势是灵活性和诸多插件，它的问题是性能以及资源消耗。
    • Filebeat：轻量级的日志传输工具，可以将将日志直接传输存储到 Elasticsearch，也可经过Logstash或者Kafka/Redis。
    • .Net Core logger provider：如果仅限于 .Net Core的话，可以基于Elasticsearch的 .Net Core SDK封装一个日志提供程序直接写入Elasticsearch。

参考

转载于:https://www.cnblogs.com/royzshare/p/9454625.html

badiu_30394251
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
详解ASP.NET Core应用中如何记录和查看日志
10-20
在ASP.NET Core应用程序中，日志记录是诊断和调试应用问题的关键工具。本文将深入探讨如何在ASP.NET Core中配置和使用日志记录系统。 首先，ASP.NET Core的日志系统基于三个核心组件：Logger、LoggerFactory和...
ASP.NET Core 日志
随笔
03-23 956
NET Core 支持适用于各种内置和第三方日志记录提供程序的日志记录 API。 内置日志记录提供程序 Console：logging.AddConsole(); dotnet run 查看控制台日志记录输出。 Debug：调试logging.AddDebug(); 在 Linux 中，此提供程序将日志写入 /var/log/message。 EventSource： logging.AddEventSourceLogger(); 在 Windows 中，它使用 PerfView 实用工具收集和查看日志，
玩转ASP.NET Core中的日志组件
weixin_30389003的博客
09-21 443
简介 日志组件，作为程序员使用频率最高的组件，给程序员开发调试程序提供了必要的信息。ASP.NET Core中内置了一个通用日志接口ILogger，并实现了多种内置的日志提供器，例如 Console Debug EventSource EventLog TraceSource Azure App Service 除了内置的日志提供器，ASP.NET Core还支持了多种第三方日志工具，例如 ...
.net8系列-05图文并茂手把手教你.NET Core 下使用 Log4Net 记录日志，配置日志组件log4net
最新发布
tangdou369098655的博客
05-06 1688
og4net设计用于帮助.NET应用程序的开发者控制日志信息的生成过程，使得日志信息可以根据配置被输出到多种目的地，包括控制台、文件系统、数据库、电子邮件、Windows事件日志等。
【ASP.NET Core 基础知识】--部署和维护--日志记录和错误处理
喵叔
02-10 1874
ASP.NET Core 日志记录和错误处理是开发 ASP.NET Core 应用程序中至关重要的方面。本文介绍了日志记录和错误处理的基本概念、内置提供程序、第三方提供程序以及它们在应用程序开发中的应用。在文章中，我们首先讨论了日志记录的概念，它是记录应用程序运行时状态、活动和事件的过程。随后，我们介绍了 ASP.NET Core 内置的日志记录提供程序，包括控制台、调试、事件源、EventLog、TraceSource 等。通过使用这些内置提供程序，开发人员可以方便地记录日志并查看应用程序的运行情况。
.NET Core下的日志（1）：记录日志信息
weixin_33670713的博客
10-25 407
记录各种级别的日志是所有应用不可或缺的功能。关于日志记录的实现，我们有太多第三方框架可供选择，比如Log4Net、NLog、Loggr和Serilog 等，当然我们还可以选择微软原生的诊断机制（相关API定义在命名空间“System.Diagnostics”中）实现对日志的记录。.NET Core提供了独立的日志模型使我们可以采用统一的API来完成...
微软日志工厂 Microsoft.Extensions.Logging 中增加 log4net 的日志输出
weixin_30321709的博客
12-06 2641
前提： 　　需要nuget Microsoft.Extensions.Logging.Log4Net.AspNetCore 2.2.6； 描述：解决 .net core微软日志工厂 Microsoft.Extensions.Logging 增加 log4net的日志输出，暂时分为 info,Error,Debug三种类型，按天记录； 实际效果： ....
Asp.Net Core用NLog记录日志操作方法
10-16
在本文中，我们将详细介绍如何使用NLog在Asp.Net Core中进行日志记录，并满足特定需求。 需求分析： 1. 自动写入日志到数据库和文件：NLog允许配置多个目标（Targets），如文件和数据库，以实现日志的多渠道记录。 ...
使用Serilog增强ASP.NET Core日志记录管道
04-05
在ASP.NET Core应用程序中，日志记录是诊断和调试问题的关键工具。Serilog是一个流行的、灵活的日志库，它提供了一种结构化日志记录的方法，可以将日志数据发送到多种目标，如控制台、文件、数据库或云服务。本篇...
ASP.NET Core 2.0 WebApi全局配置及日志实例
10-18
在ASP.NET Core 2.0中，微软引入了一个统一的日志接口`Microsoft.Extensions.Logging`，它允许开发者选择不同的日志提供器，包括NLog、Serilog等。 要使用NLog，首先需要通过NuGet安装`NLog.Web.AspNetCore`包。...
Asp.Net Core NLog 将日志输出到数据库以及添加LayoutRenderer的支持
05-22 311
在这之前打算用Apache的Log4Net，但是发现其AdoNetAppender方法已经不存在了，无法使用配置文件直接输出到数据库了，因此我便改用了NLog框架。 一、对项目添加NLog 通过Nuget安装NLog NLog.Extensions.Logging、NLog.Web.AspNetCore ...
ASP.NET Core 全局异常处理和日志记录
01-20
文章目录添加自定义业务异常类添加全局异常过滤器像容器添加服务 添加自定义业务异常类 public class BusinessException : Exception { public BusinessException(){} public BusinessException(string message) : base(message) {} public BusinessException(string message, Exception innerException) : base(message, innerException) {} }
ASP.NET Core 基础（八）——日志记录
catshitone的专栏
04-20 1091
日志组件包括提供器（Provider）和记录器（Logger） # 1.日志提供程序（Log provider） 框架自带的日志provider有以下几种，前4个都在`CreateDefaultBuilder`里被添加进去，后续几个需要添加nuget包。 - 控制台：即`Consol.WriteLine()` - 调试：即`Debug.WriteLine()` - EventSource：EventSource 提供程序写入名称为 Microsoft-Extensions-Logging 的跨平台事件源。
asp.net core 日志
weixin_33860553的博客
12-03 104
ASP.NET Core 中的日志记录 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1 日志级别：Trace -》Debug-》 Information -》Warning-》 Error-》 Critical 级别包含范围由大到小 ，如 Trace 就包含了所有信息。 基...
ASP.NET Core：ASP.NET Core中使用NLog记录日志
songjuntao8的专栏
05-08 1050
一、前言 在所有的应用程序中，日志功能是不可或缺的模块，我们可以根据日志信息进行调试、查看产生的错误信息，在ASP.NET Core中我们可以使用log4net或者NLog日志组件来实现记录日志的功能，这里讲解如何在ASP.NET Core中使用NLog。 这里采用的是.NET Core 3.1创建应用程序。 那么什么是NLog呢？ NLog是一个基于.NET平台编写的类库，我们可以使用NLog在应用程序中添加即为完善的跟踪调试代码。 NLog是一个简单灵活的.NET日志记录类库。通过使用NLog
日志系统——日志的分类与过滤（3）
世界既不黑也不白，而是一道精致的灰。
12-13 1494
文章目录
ASP.NET Core可视化日志组件使用-LogDashboard
混迹自留地
06-20 1856
前言 首次发现这个组件实在’net9’大佬写的文章里面发现的。经过自己使用是用发现是真的不错，LogDashboard 特性：授权访问，自定义日志模型，日志追踪，堆栈查看 支持的日志组件：nlog，log4net，serilog 支持的数据源：txt，数据库 官网地址：https://doc.logdashboard.net/ serilog的使用 serilog是NET下优秀的日志项目，对NETCore支持友好，扩展丰富。abp框架更是将其做为框架默认的日志组件，logdashboard完全支持seri
ASP.NET Core应用程序的参数配置及使用
dotNET跨平台
08-29 2059
应用程序的开发不仅仅是写代码这点事情。假设你正在开发一个能够支持多次部署的微服务，此时你就需要有一个合理的应用程序配置方案，以便在开发和生产环境中能够方便地选用不同的配置...
日志系统——NLog的使用（2）
世界既不黑也不白，而是一道精致的灰。
12-13 2345
文章目录一、使用文本文件记录日志二、日志文件要分期三、通过NLog来记录日志四、输出到文本文件 一、使用文本文件记录日志       因为当日志在控制台输出后，并不会保存之前的日志记录，当日志量大的时候，在控制台查看十分麻烦，所以要讲日志记录保存到文件中 。 二、日志文件要分期       （1）日志文件按日期分类是为了防止单个文件过大，导致文件的查看异常麻烦   &n
【ASP.NET编程知识】.net core日志结构化.docx
05-15
【ASP.NET编程知识】.net core日志结构化.docx

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值