ASP.NET Core 日志框架:Serilog
在 ASP.NET Core 日志模型 中对日志整体实现方式进行了介绍,通过使用内置日志记录器来实现日志的输出路径。而在实际项目开发中,使用第三方日志框架来记录日志也是非常多的,首先一般基础的内置日志记录器在第三方日志框架中都有实现,然后很多第三方日志框架在功能上更强大和丰富,能满足我们更多的项目分析和诊断的需求。
本文主要介绍 Serilog[1] 这个日志框架的使用,它是目前比较突出和受欢迎的一个日志框架。Serilog
在日志记录上采用 json
的格式,方便日志的快速查询与过滤。
默认日志行为
在使用 Serilog
之前我们先看看 ASP.NET Core API 项目默认的日志输出行为。创建基于 ASP.NET Core 3.1 的 API 项目后启动,默认访问会 weatherforecast
接口,然后可以从控制台和调试窗口看到如下输出日志 (ASP.NET Core API 项目模板默认集成了 Console
和 Debug
日志记录器):
日志输出等级在配置文件中有默认设置参数,appsettings.Development.json
(开发环境)和 appsettings.json
(生产环境)的 Logging
节点。下面以 appsettings.Development.json
为例:
{"Logging": {"LogLevel": {"Default": "Debug","System": "Information","Microsoft": "Information"}}
}
开发环境下默认输出 Debug
及以上等级日志,System
和 Microsoft
开头的日志 Information
及以上等级会输出,所以从上面的截图看到大批 Info
日志。
Serilog 使用
和内置日志记录器一样,Serilog
也有自己的日志记录器组件,NuGet 包命名上基本都是 Serilog.Sinks.xxx
的形式,如:Serilog.Sinks.Console
、Serilog.Sinks.File
、Serilog.Sinks.Seq
、Serilog.Sinks.ElasticSearch
等,接下来先以 Serilog.Sinks.Console
为例。
安装
Serilog.Settings.Configuration
(读取配置)、Serilog.Sinks.Console
(日志输出到控制台) NuGet 包 ;配置文件添加
Serilog
配置,WriteTo
指定输出目标位置,它是一个数组类型,所以可以指定多个目标位置,这里暂时只指定输出到控制台:{"Serilog": {"MinimumLevel": {"Default": "Debug"},"WriteTo": [{ "Name": "Console" }]} }
Program.cs 添加
UseSerilog
,设置配置信息:public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(webBuilder =>{webBuilder.UseSerilog((context, logger) =>{logger.ReadFrom.Configuration(context.Configuration);});webBuilder.UseStartup<Startup>();});
在 Startup.cs 的
Configure
请求管道中添加UseSerilogRequestLogging
:public void Configure(IApplicationBuilder app, IWebHostEnvironment env) {if (env.IsDevelopment()){app.UseDeveloperExceptionPage();}app.UseSerilogRequestLogging();app.UseRouting();app.UseAuthorization();app.UseEndpoints(endpoints =>{endpoints.MapControllers();}); }
日志输出效果如下:
由于日志总是输出一堆,并不能区分什么日志来自
Serilog
,其实Serilog
输出的日志是非常简洁的,只有HTTP GET ...
这一条,其他都是 AspNetCore 本身输出的。
日志输出简化
为了使日志输出更简洁,我们可以设置不输出 AspNetCore Info 日志,只需在 Serilog
配置节点中设置 AspNetCore 日志输出级别为 Warning
:
{"Serilog": {"MinimumLevel": {"Default": "Debug","Override": {"Microsoft.AspNetCore": "Warning"}},"WriteTo": [{ "Name": "Console" }]}
}
日志属性扩展
这部分我们将增加使用 Serilog.Sinks.Seq
日志记录器,不过在使用前需要先安装 Seq[2],和 ElasticSearch
类似,主要提供日志存储和查询,安装非常简单,这里不再赘述,参考 Windows or Docker[3]。
Seq
服务启动后修改配置文件,在 WriteTo
节点内增加 Seq
的配置参数:
"WriteTo": [{ "Name": "Console" },{"Name": "Seq","Args": {"serverUrl": "http://localhost:5341/"}}
]
在 Seq
中查看日志如下,基于 ParentId
、RequestId
、TraceId
可实现链路跟踪:
手动记录的日志如下:
虽然通过之前的配置使一次请求中系统日志只保留了一条,但相比之下可能丢失了一些重要信息,如:endpoint
、contentType
等,所以我们需要在日志体上增加一些扩展属性,做到数量少但内容丰富。
前面在 Startup 的 Configure
方法中添加过 UseSerilogRequestLogging
,该方法还支持更多的参数配置,通过指定 EnrichDiagnosticContext
委托方法的实现向 IDiagnosticContext
对象中添加扩展属性,这些扩展属性将会作用于请求日志体中。(Serilog.AspNetCore
已将接口 IDiagnosticContext
作为单例添加到了 DI 容器中,可以在任何类中通过其 Set
方法添加扩展属性)
public static class LogUtil
{public static void EnrichDiagnosticContext(IDiagnosticContext diagnosticContext, HttpContext httpContext){var request = httpContext.Request;diagnosticContext.Set("Host", request.Host);diagnosticContext.Set("ContentType", httpContext.Response.ContentType);var endpoint = httpContext.GetEndpoint();if (endpoint is object){diagnosticContext.Set("EndpointName", endpoint.DisplayName);}}
}
app.UseSerilogRequestLogging(opts =>
{opts.EnrichDiagnosticContext = LogUtil.EnrichDiagnosticContext;
});
在 Seq
中查看日志如下,已包含添加的扩展属性:
参考资料
[1]
Serilog: https://github.com/serilog/serilog-aspnetcore
[2]
Seq: https://datalust.co/seq
[3]
Windows or Docker: https://docs.datalust.co/docs/getting-started
ASP.NET Core 日志框架:Serilog相关推荐
- 在 ASP.NET Core 中使用 Serilog 使用 Fluentd 将日志写入 Elasticsearch
在 ASP.NET Core 中使用 Serilog 使用 Fluentd 将日志写入 Elasticsearch 原文来自:https://andrewlock.net/writing-logs-t ...
- 如何在 ASP.Net Core 中使用 Serilog
记录日志的一个作用就是方便对应用程序进行跟踪和排错调查,在实际应用上都是引入 日志框架,但如果你的 日志文件 包含非结构化的数据,那么查询起来将是一个噩梦,所以需要在记录日志的时候采用结构化方式. 将 ...
- Asp.NET Core+ABP框架+IdentityServer4+MySQL+Ext JS之部署到Linux
尝试新的开发组合:Asp.NET Core+ABP框架+IdentityServer4+MySQL+Ext JS Asp.NET Core+ABP框架+IdentityServer4+MySQL+Ex ...
- 《ASP.NET Core 6框架揭秘》实例演示[19]:数据加解密与哈希
数据保护(Data Protection)框架旨在解决数据在传输与持久化存储过程中的一致性(Integrity)和机密性(confidentiality)问题,前者用于检验接收到的数据是否经过篡改,后 ...
- 《ASP.NET Core 6框架揭秘》实例演示[32]:错误页面的N种呈现方式
由于ASP.NET是一个同时处理多个请求的Web应用框架,所以在处理某个请求过程中出现异常并不会导致整个应用的中止.出于安全方面的考量,为了避免敏感信息外泄,客户端在默认情况下并不会得到详细的出错信息 ...
- 《ASP.NET Core 6框架揭秘》实例演示[18]:HttpClient处理管道
在<<ASP.NET Core 6框架揭秘>实例演示[17]:利用IHttpClientFactory工厂来创建HttpClient>之后,我们将关注点放到HttpClient ...
- ASP.NET Core 入门教程 2、使用ASP.NET Core MVC框架构建Web应用
原文:ASP.NET Core 入门教程 2.使用ASP.NET Core MVC框架构建Web应用 一.前言 1.本文主要内容 使用dotnet cli创建基于解决方案(sln+csproj)的项目 ...
- 《ASP.NET Core 3 框架揭秘(上下册)》送书结果公告
[免费送书].Net5实操后的我一夜未眠,来个大胆预测!的送书抽奖结果已经出来了: 这位中奖的同学尽快填写收货地址,4/2 日还没有完成填写将作废,奖品可是热门的<ASP.NET Core 3 ...
- 通过极简模拟框架让你了解ASP.NET Core MVC框架的设计与实现[中篇]:请求响应
<200行代码,7个对象--让你了解ASP.NET Core框架的本质>让很多读者对ASP.NET Core管道有了真实的了解.在过去很长一段时间中,有很多人私信给我:能否按照相同的方式分 ...
最新文章
- gcc和g++是什么,有什么区别?
- sklearn 岭回归
- [LeetCode] NO.292 Nim Game
- Android中dp与px互转的方法
- mysql索引有哪些了解_Mysql索引(简单了解)
- php控制器实现自动映射,PHP实现路由映射到指定控制器
- M1芯片版mac软件安装出现异常怎么办?解决方法来了
- 如何避免重要需求遗漏?
- Spark内核解析2
- 启程 一些高考后的想法
- 暑假周进度总结报告7
- mysql增加sort_buffer_MySQL数据库之MySQL中的sort_buffer_size参数大小的设置问题
- nodejs mysql数据推送_使用Nodejs实现实时推送MySQL数据库最新信息到客户端
- FJNU 1196 汪老司机(DP or 建图+最短路)
- sed,awk,grep教程
- html+css静态页面Demo(参考一唯科技官网)
- 数字图像处理之matlab大作业:美图秀秀
- Windows PE/COFF
- 如何进行计算机系统安装教程,电脑怎么重装系统:系统安装教程
- 随机生成20个手机号码