Serilog .NET（开发者如何使用）

结构化日志记录

Serilog 的一个突出特点是其对结构化日志记录的支持。 Serilog 允许您记录结构化数据，而不仅仅是简单地记录纯文本消息。 这种结构化数据可以是 JSON 对象、字典或任何其他可以序列化的类型。 通过记录结构化数据，您可以使用 Elasticsearch 或 Splunk 之类的工具轻松分析和查询日志事件。

灵活的配置

Serilog 提供灵活的配置选项，允许您根据应用程序的需要自定义日志记录行为。 您可以通过编程方式或使用配置文件来配置 Serilog。 这种灵活性使您能够在不需要重新启动应用程序的情况下，在运行时调整日志记录行为。

Sink 库

Serilog 提供各种 sink 库，允许您将日志事件发送到不同的目的地。 一些受欢迎的 sink 库包括：

• Serilog.Sinks.Console: 将日志事件发送到控制台。
• Serilog.Sinks.File: 将日志事件写入文本文件。
• Serilog.Sinks.Seq: 将日志事件发送到 Seq，一个结构化日志服务器。
• Serilog.Sinks.Elasticsearch: 将日志事件发送到 Elasticsearch。

这些 sink 库使 Serilog 可以轻松集成到不同的日志记录基础架构和工具中。

日志丰富化

日志丰富化是一种允许您向日志事件添加额外上下文信息的功能。 Serilog 提供各种丰富器，可以自动向日志事件中添加诸如时间戳、线程 ID 或日志级别等信息。 您还可以创建自定义丰富器以添加特定于应用程序的信息。

日志过滤

Serilog 允许您基于各种标准过滤日志事件。 您可以配置过滤器以根据日志级别、属性值或任何其他条件排除或包括日志事件。 这种过滤功能使您能够专注于与分析或故障排除最相关的日志事件。

通过了解和利用这些功能，您可以利用 Serilog 的强大功能来增强日志记录能力，并获得有关应用程序行为的宝贵见解。

结构化日志记录: A Core Feature

Serilog 的主要优势在于将日志消息转变为结构化数据。 与其他输出纯文本的日志库不同，Serilog 生成的是结构化的 JSON 格式日志，简化了日志数据的解析和查询。 这种能力对于现代应用程序至关重要，因为日志分析和监控是运营智能的重要组成部分。 当日志消息被输入到像 ELK（Elasticsearch、Logstash、Kibana）堆栈这样的系统进行高级分析时，结构化日志尤为有用。

丰富的日志事件细节

Serilog 通过上下文信息丰富日志事件，为应用程序内部的活动提供一个全面的视图。 每个日志事件可以包含许多细节，除了简单的日志消息外，还包括时间戳、日志级别、异常细节和自定义属性。 这使得 Serilog 在日志深度和清晰度方面优于其他日志库，提供给开发人员关于应用程序行为和性能的关键见解。

通过配置文件

使用配置 JSON 文件定义日志级别、输出目的地（如日志文件或控制台）和日志输出格式。 配置文件方法提供了在不修改代码的情况下更改日志记录行为的灵活性。 这是通过在 appsettings.json 文件中指定设置来完成的，允许您将日志输出定向到各种 sink，例如控制台、文件或甚至基于云的日志管理服务。

通过代码编程

或者，使用 LoggerConfiguration 类直接在代码中配置 Serilog。 这种方法通常用于设置更复杂的日志场景，例如动态日志级别或自定义日志 sink。 例如，您可以配置一个滚动日志文件，在特定时间间隔或达到某一大小时创建新的日志文件，确保日志文件管理的效率。

// Create a logger instance with a rolling log file that creates a new log file every day
var logger = new LoggerConfiguration()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day) 
    .CreateLogger();

// Create a logger instance with a rolling log file that creates a new log file every day
var logger = new LoggerConfiguration()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day) 
    .CreateLogger();

' Create a logger instance with a rolling log file that creates a new log file every day
Dim logger = (New LoggerConfiguration()).WriteTo.File("logs/myapp.txt", rollingInterval:= RollingInterval.Day).CreateLogger()

与 ASP.NET Core 的集成

将 Serilog 集成到 ASP.NET Core 中涉及通过包管理器控制台添加 Serilog 包，并在 Program.cs 文件中设置记录器。 .NET 6 中的 var builder 和 var app 语句无缝地将 Serilog 插入到应用程序的日志基础结构中。 此过程用 Serilog 替换默认记录器，确保所有日志消息都通过 Serilog 管道处理。

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

var app = builder.Build();

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

var app = builder.Build();

Dim builder = WebApplication.CreateBuilder(args)

' Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog(Function(ctx, lc) lc.WriteTo.Console().ReadFrom.Configuration(ctx.Configuration))

Dim app = builder.Build()

IronPDF。

IronPDF 允许在 .NET 应用程序中创建、读取和编辑 PDF。 这在与 Serilog 结合生成日志数据的 PDF 报告时尤其有用，可以在标准化格式中轻松分发和查看日志信息。

光学字符识别 (OCR) 是一种将不同类型的文档转换为可编辑和可搜索数据的技术。

IronOCR 是一个光学字符识别（OCR）库，可以将图像翻译为 125 种语言的文本。 该功能可用于需要从图像或扫描文档中提取文本数据的日志记录场景，从而使用更多上下文信息丰富日志数据。

了解更多关于 IronXL 是一个 Excel 库，可帮助处理 Excel 文件而无需安装 Excel。

IronXL 提供无需 Office Interop 的工作 Excel 的功能。 这在日志记录中尤其有用，因为日志数据可以导出到 Excel 进行进一步分析和报告，提供了一个熟悉的数据操作和可视化界面。

开始使用 IronBarcode 是一个专为 .NET 框架设计的条码读取和写入库。

IronBarcode 促进 QR 码和条形码的读取和生成。 该库可以在日志文件中嵌入或提取编码信息，增强日志信息的安全性和可追溯性。