C#怎么使用Serilog_C#结构化日志写入ElasticSearch【进阶】

阿杰同学_5127

阿杰同学_5127

2026-04-30

338人浏览

原创

serilog.sinks.elasticsearch 直连丢字段主因是默认 omitenclosingobject: true 且未启用 autoregistertemplate,导致结构化属性被扁平化为字符串;须设 omitenclosingobject: false、autoregistertemplate: true、indexformat 为 "logs-{0:yyyy.mm.dd}" 并确保 ilm 模板匹配。

c#怎么使用serilog_c#结构化日志写入elasticsearch【进阶】

为什么直接用 Serilog.Sinks.Elasticsearch 会丢字段?

因为默认配置下,Serilog 会把整个 LogEvent 序列化成一个扁平的 JSON 对象,Properties 里的结构化数据(比如嵌套对象、字典、自定义类型)全被转成字符串塞进 messageTemplate 或 renderedMessage,ElasticSearch 收到的是“黑盒”文本,没法做聚合或字段过滤。

根本原因是 ElasticsearchSink 默认启用了 omitEnclosingObject: true,且没启用 autoRegisterTemplate: true 和正确的 indexFormat 策略。

  • 必须显式设置 autoRegisterTemplate: true,让 Serilog 自动推导并上传 ILM 兼容的索引模板
  • indexFormat 推荐用 "logs-{0:yyyy.MM.dd}",避免单索引过大,也方便按天滚动和清理
  • 禁用 omitEnclosingObject(即设为 false),否则 @p 记录的结构体直接消失

如何让 LogEvent.Properties 中的匿名对象/类实例真正变成 ES 的 nested 字段?

Serilog 默认不递归序列化复杂对象——它只调用 .ToString()。想保留结构,得靠 Destructure.AsScalar<t>()</t> 或 Destructure.ToMaximumDepth(n),但更稳妥的是用 LogContext + ILogger.ForContext<t>()</t> 显式注入已序列化的 JSON 字符串,并配合 ElasticsearchSink 的 customFormatter。

实操建议:

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 对需要保留结构的类型(如 HttpRequest, ApiResponse<t></t>),先用 System.Text.Json.JsonSerializer.SerializeToString(obj) 转成字符串,再用 Log.ForContext("RawRequest", json, destructureObjects: false)
  • 在 Sink 配置里传入自定义 ITextFormatter,继承 CompactJsonFormatter 并重写 Format(),把 LogEvent.Properties["RawRequest"] 的值原样写入 JSON,不加引号、不转义
  • ES 端需提前在索引模板中声明该字段为 "type": "object" 或 "type": "nested",否则即便写入了 JSON,也会被动态映射成 text

IndexName 和 IndexFormat 搞混会导致什么?

很多人以为 indexName 是模板名,其实它是「写入时实际使用的索引名」;而 indexFormat 是用于生成每日索引名的格式字符串(如 "logs-{0:yyyy.MM.dd}")。如果只配 indexName = "logs",所有日志都往一个叫 logs 的索引里写,既无法滚动,又容易触发 ES 的单索引大小上限(50GB 默认),查询也变慢。

  • indexName 必须留空(null)或删掉,否则会覆盖 indexFormat 行为
  • indexFormat 中的日期格式必须用 DateTime 标准格式符,{0:yyyy-MM-dd} 不行(ES 不认连字符作索引名),得用 {0:yyyy.MM.dd} 或 {0:yyyyMMdd}
  • 如果用了 ILM,indexFormat 生成的索引名必须匹配 ILM 策略中的 pattern,例如策略匹配 "logs-*",那 indexFormat 就得是 "logs-{0:yyyy.MM.dd}"

ES 连接失败却没报错?检查 SelfLog 和 HttpClient 超时

Serilog.Sinks.Elasticsearch 默认静默丢弃发送失败的日志——它不会抛异常,也不会写入本地 fallback 文件(除非你手动配)。最常见原因是 HttpClient 连接超时(默认 10 秒)或 TLS 版本不匹配(ES 8.x 默认要求 TLS 1.2+)。

  • 启用 Serilog 自检:Serilog.Debugging.SelfLog.Enable(Console.Out),能看到底层 HTTP 请求是否发出、响应码多少
  • 显式构造 HttpClient 并设置 Timeout = TimeSpan.FromSeconds(30),传给 ElasticsearchSinkOptions.HttpClient
  • 若 ES 启用了 HTTPS 且证书非权威签发,需在 HttpClientHandler 中设置 ServerCertificateCustomValidationCallback,否则连接直接被 .NET 拦截
  • 别依赖 WriteTo.Async() 来“缓解”失败——异步只是把日志压进内存队列,队列满或进程退出时照样丢

结构化日志写入 ES 的关键不在“能不能写”,而在“写的字段能不能查、聚合、告警”。漏掉模板注册、混淆索引命名规则、放任 HttpClient 默认超时,这三处出问题,日志就等于白写。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

892

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2451

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

825

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2595

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

272

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

369

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

289

20

Elasticsearch 从入门到搜索引擎实战
Elasticsearch 从入门到搜索引擎实战

本专题带你从零掌握 Elasticsearch 分布式搜索引擎。深入解析倒排索引核心原理,涵盖单机与 Docker 环境搭建、IK 中文分词器配置及索引文档的 CRUD 操作。通过丰富的 Query DSL 实战案例,详解布尔查询、聚合分析与高亮显示,助你快速构建毫秒级响应的企业级高性能搜索服务。

2026.05.12

39

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Conan 2 Essentials 免费课程
Conan 2 Essentials 免费课程

共0课时 | 0人学习

CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 高级依赖模型介绍
Conan 2 高级依赖模型介绍

共0课时 | 0人学习