Serilog文档翻译系列(三) - 基础配置

news2024/9/24 9:18:36

Serilog 使用简单的 C# API 来配置日志记录。当需要外部配置时,可以(慎用)通过使用 Serilog.Settings.AppSettings 包或 Serilog.Settings.Configuration 包进行混合配置。

创建日志记录器

日志记录器是通过 LoggerConfiguration 对象创建的:

Log.Logger = new LoggerConfiguration().CreateLogger();
Log.Information("No one listens to me!");
// Finally, once just before the application exits...
Log.CloseAndFlush();

上面的示例将创建一个不记录任何事件的日志记录器。要查看日志事件,必须配置一个接收器。

接收器

日志事件接收器通常将日志事件记录到某些外部表示形式中,最常见的是控制台、文件或数据存储。Serilog 的接收器通过 NuGet 分发。在 Wiki 上,有一个精心整理的可用接收器列表。

这个示例将使用控制台接收器包和文件接收器包,控制台接收器包用于格式化日志数据输出到控制台,文件接收器包用于将日志事件写入一组按日期标记的文本文件。

$ dotnet add package Serilog.Sinks.Console
$ dotnet add package Serilog.Sinks.File

接收器通过 WriteTo 配置对象进行配置。

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
.CreateLogger();
Log.Information("Ah, there you are!");

 多个接收器可以同时激活。如果需要添加额外的接收器可以通过链式调用 WriteTo 块来实现:

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .WriteTo.File("log-.txt", rollingInterval: RollingInterval.Day)
    .CreateLogger();

输出模板

基于文本的接收器使用输出模板来控制格式。可以通过 outputTemplate 参数进行修改:

.WriteTo.File("log.txt",outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}")

上面的示例中展示的默认模板使用了内置的属性,如 Timestamp 和 Level。来自事件的属性,包括使用增强器附加的属性,也可以出现在输出模板中。

{Message:lj} 格式选项使消息中的数据以 JSON 格式(j)输出,但字符串文字会原样输出。

添加 {Properties:j} 到输出模板中,以包括额外的上下文信息。

在输出模板中添加 {Properties:j} 可以包含额外的上下文信息。这允许你将与日志事件相关联的所有属性(包括自定义属性)以 JSON 格式输出到日志文件中,从而提供额外的调试和跟踪信息。

最低级别

Serilog 实现了日志事件处理中常见的“最低级别”概念。

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .WriteTo.Console()
    .CreateLogger();

MinimumLevel 配置对象允许指定一个日志事件级别作为最低级别。在上面的示例中,级别为 Debug 及更高级别的日志事件将被处理并最终写入控制台。

级别

使用场景

Verbose(详细)

详细事件是最详细的级别,很少(甚至从不)在生产应用程序中启用

Debug(调试)

调试事件用于记录系统内部事件,这些事件不一定能从外部观察到,但是对应确定问题发生原因很有帮助

Information(信息)

信息事件描述系统中发生的事情,这些事情与系统的职责和功能相对应。通常,这些是系统可以执行的可观察操作

Warning(警告)

当服务降级、面临危险或可能超出其预期参数时,使用警告事件

Error(错误)

当功能不可用或预期被打破时,使用错误事件

Fatal(致命)

最关键的级别,致命事件需要立即关注

默认级别 - 如果未指定 MinimumLevel,则将处理 Information 级别及更高级别的事件。

覆盖每个接收器

有时,我们希望将详细的日志写入一个介质,而将不太详细的日志写入另一个介质。

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .WriteTo.File("log.txt")
    .WriteTo.Console(restrictedToMinimumLevel: LogEventLevel.Information)
    .CreateLogger();

在这个例子中,调试级别的日志将被写入到滚动文件中,而只有级别及以上的日志会被写入到控制台。而只有信息级别日志和更高级别的日志将写入控制台

所有提供的接收器都支持 restrictedToMinimumLevel 配置参数。

记录器与接收器的最低级别 - 需要了解的是,日志级别只能提高,而不能降低。也就是说,如果记录器的 MinimumLevel被设置为 Information,那么即使接收器的指定级别为 Debug,它仍然只会接收到 Information 级别的事件。这是因为记录器级别配置是控制哪些日志语句会导致事件的创建,而接收器级别配置是对这些事件进行筛选。如果你想要创建具有更详细级别的单一记录器,那么你应该使用单独的 LoggerConfiguration实例。

增强器

增强器是简单的组件,用于添加、删除或修改附加到日志事件的属性。例如,可以使用 增强器为每个事件附加线程 ID。

class ThreadIdEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty(
                "ThreadId", Thread.CurrentThread.ManagedThreadId));
    }
}

增强器是通过 Enrich 配置对象来添加的。

Log.Logger = new LoggerConfiguration()
    .Enrich.With(new ThreadIdEnricher())
    .WriteTo.Console(outputTemplate: "{Timestamp:HH:mm} [{Level}] ({ThreadId}) {Message}{NewLine}{Exception}")
    .CreateLogger();

上面的配置展示了如何通过增强器添加的属性在输出格式化中使用。

如果在应用程序运行期间,增强的属性值是恒定的,可以使用快捷方法 WithProperty 来简化配置。

Log.Logger = new LoggerConfiguration()
    .Enrich.WithProperty("Version", "1.0.0")
    .WriteTo.Console()
    .CreateLogger();

增强器以及它们附加的属性通常与使用结构化存储的接收器一起使用时更加有用,因为在这些接收器中可以查看和过滤属性值。

过滤器

事件可以通过过滤器进行选择性记录。过滤器只是日志事件的筛选规则,其中一些常见场景由 Matching 类处理。

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .Filter.ByExcluding(Matching.WithProperty<int>("Count", p => p < 10))
    .CreateLogger();

子日志记录器

有时,需要对接收器看到的内容进行更细粒度的控制。为此,Serilog 允许完整的日志记录管道作为接收器使用。

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .WriteTo.Logger(lc => lc
        .Filter.ByIncludingOnly(...)
        .WriteTo.File("log.txt"))
    .CreateLogger();

 对于子日志记录器处理不佳的场景,可以创建多个独立的顶级管道。虽然 Log.Logger 只能分配一个管道,但你的应用程序可以使用任意数量的额外 ILogger 实例。

请注意,如果在 WriteTo.Logger() 回调中指定了解构策略,则这些策略将不会生效,因为子日志记录器处理的是已经创建的LogEvent对象。

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

STM32硬件篇:W25Q64

W25Q64简介 W25Qxx系列是一种低成本、小型化、使用简单&#xff08;使用SPI通信协议&#xff09;的非易失性&#xff08;掉电不丢失&#xff09;存储器&#xff0c;常用于数据存储、字库存储、固件程序存储等场景。 【注意】W25Qxx芯片只支持SPI的模式0和模式3。 存储介质&am…

【单片机开发】IAP技术详解及应用

【前言】 在单片机开发过程中&#xff0c;程序的烧录是一个至关重要的环节。随着技术的不断演进&#xff0c;单片机烧录方式也日益多样化。 【单片机开发】单片机的烧录方式详解&#xff08;ICP、IAP、ISP&#xff09;-CSDN博客文章浏览阅读775次&#xff0c;点赞14次&#x…

kali系统学习笔记1

收集DSN相关信息命令 1、ping IP/URL 例如 ping 153.3.238.110 ping www.baidu.com2、nslookup 域名 例如 nslookup www.baidu.com3、dig URL //查询域名正向解析 dig www.baidu.com //查询域名所有解析&#xff08;正向、反向&#xff09; dig www.baidu.com any//通过指…

江协科技stm32————11-1SPI通信协议

目录 SPI通信 硬件电路 移位示意图 SPI时序基本单元 模式0 模式1 SPI时序 发送指令 指定地址写 指定地址读 SPI通信 四根通信线&#xff1a; SCK&#xff08;Serial Clock&#xff09;&#xff1a;串行时钟线 MOSI&#xff08;Master Output Slave Input&#xff09…

书生大模型实战营闯关记录----第十一关:LMDeploy 量化部署进阶实践 KV cache量化部署,W4A16 模型量化和部署

文章目录 1 配置LMDeploy环境1.1 环境搭建1.2 InternStudio环境获取模型1.3 LMDeploy验证启动模型文件 2 LMDeploy与InternLM2.5 2.1 LMDeploy API部署InternLM2.52.1.1 启动API服务器 2.1.2 以命令行形式连接API服务器 2.1.3 以Gradio**网页形式连接API服务器** 2.2 LMDeploy…

使用developer command prompt查看代码信息

1.在Visual Studio里面写入以下的代码&#xff0c;命名为Myproject #include <iostream>template<typename T> T Sub(T a, T b) {return a - b; } int main() {int x 1, y 2;int z Sub(x, y);double a 1.0, b 2.0;double c Sub(a, b);return 0; }2.打开dev…

在VBA中,对Excel单元格的操作方法 (qo+op)

一、读取单元格内容 读取单元格的内容&#xff0c;将单元格的值赋给一个变量。例如&#xff0c;读取A1单元格的内容并打印到窗口。 Sub Cell() Dim cellContent As String cellContent Worksheets("Sheet1").Range("A1").Value Debug.Print cellContent …

C语言基础(二十八)

1、冒泡排序&#xff1a; #include "date.h" #include <stdio.h> #include <stdlib.h> #include <time.h> // 函数声明 void bubbleSort(int *arr, int n); int* createRandomArray(int n, int *size); int main() { int time getTi…

全能型AI vs 专业型AI:未来AI市场的决战?

随着人工智能&#xff08;AI&#xff09;技术的飞速发展&#xff0c;AI的应用范围已从最初的学术研究扩展到商业、医疗、制造、金融等众多领域。在这个过程中&#xff0c;不同类型的AI产品应运而生&#xff0c;并逐渐成为市场的焦点。近年来&#xff0c;全能型AI和专业型AI之间…

【时时三省】(C语言基础)指针进阶6qsort函数的使用

山不在高&#xff0c;有仙则名。水不在深&#xff0c;有龙则灵。 ----CSDN 时时三省 qsort函数的使用 冒泡排序 qsort() 快速排序 它什么类型都可以用 比如&#xff1a; 整形数据 字符串数据 结构体排序 void gsort ( void * base&#xff0c;// base中存放的是待排…

智能指针(RAII)

智能指针&#xff08;RAII&#xff09; 一、内存泄漏1、介绍2、原因3、泄漏的内存类型分类 二、RAII1、介绍2、基本思想3、优点4、实现方式 三、unique_ptr1、介绍2、主要特性3、注意事项4、unique_ptr类5、示例代码6、运行结果7、简单实现 四、shared_ptr1、介绍2、主要特点3、…

深度学习(11)---Swin Transformer详解

文章目录 一、引言二、结构三、Patch Merging操作四、W-MSA详解五、SW-MSA详解 一、引言 1. 在原论文中&#xff0c;首先在开头作者就分析&#xff0c;当前的Transformer从NLP迁移到CV上没有大放异彩主要原因集中在&#xff1a;  (1) 两个领域涉及的规模不同&#xff0c;NLP的…

YOLOv9改进策略【模型轻量化】| ShufflenetV2,通过通道划分构建高效网络

一、本文介绍 本文记录的是基于ShufflenetV2的YOLOv9目标检测轻量化改进方法研究。FLOPs是评价模型复杂独的重要指标&#xff0c;但其无法考虑到模型的内存访问成本和并行度&#xff0c;因此本文在YOLOv9的基础上引入ShufflenetV2&#xff0c;使其在在保持准确性的同时提高模型…

十一. 常用类

文章目录 一、包装类1.1 包装类的继承关系1.2 包装类和基本数据类型的转换1.3 包装类与String之间的转换1.4 包装类的常用方法 二、String类2.1 String类的理解和创建对象2.2 String的创建方式2.3 字符串的特性2.4 String的常用方法 三、StringBuffer和StringBuilder类3.1 Stri…

重塑PDF编辑体验:最新在线工具深度评测

现在用PDF的场景多了&#xff0c;随之而来的加速了PDF编辑、转换工具的飞速发展&#xff0c;很多时候因为便捷大家更喜欢使用在线的工具。今天我就分享几款pdf在线编辑工具提高你文档处理效率。 1.福昕PDF编辑器 链接一下>>https://editor.foxitsoftware.cn 在沉浸阅…

Datawhale X 李宏毅苹果书 AI夏令营|机器学习基础之线性模型

1. 线性模型 线性模型是机器学习中最基础和常见的模型之一。在线性模型中&#xff0c;预测变量&#xff08;输入特征&#xff09;和目标变量&#xff08;输出&#xff09;之间的关系被建模为一个线性组合。数学形式可以表示为&#xff1a; 其中&#xff1a;x 是输入特征向量&a…

加速 PyTorch 模型:使用 ROCm 在 AMD GPU 上应用 torch.compile

Accelerate PyTorch Models using torch.compile on AMD GPUs with ROCm — ROCm Blogs 介绍 PyTorch 2.0 引入了一个名为*torch.compile()*的工具&#xff0c;可以极大地加速 PyTorch 代码和模型。通过将 PyTorch 代码转换为高度优化的内核&#xff0c;torch.compile 在现有代…

【深入理解SpringCloud微服务】深入理解微服务配置中心原理,并手写一个微服务配置中心

【深入理解SpringCloud微服务】深入理解微服务配置中心原理&#xff0c;并手写一个微服务配置中心 为什么要使用配置中心配置中心原理如何手写一个配置中心使用PropertySourceLocator监听配置变更&#xff0c;刷新配置 实现一个微服务配置中心服务端库表ConfigCenterController…

全国中学基础信息 API 数据接口

全国中学基础信息 API 数据接口 基础数据&#xff0c;高校高考&#xff0c;提供全国初级高级中学基础数据&#xff0c;定时更新&#xff0c;多维度筛选。 1. 产品功能 2024 年数据已更新&#xff1b;提供最新全国中学学校基本信息&#xff1b;包含全国初级中学与高等中学&#…

JavaWeb:实验一JSP运行环境安装及配置

一、实验目的 1&#xff0e;掌握JSP程序运行环境配置的基本要求。 2&#xff0e;熟悉HTML的常用标签使用以及静态网页的制作。 二、实验性质 验证性实验 三、实验内容 制作一个静态网站的基本页面index.html&#xff0c;要求如下&#xff1a; 1&#xff…