讲师中心 微信公众号
AI工具推荐 视频效率加速

C#如何使用Serilog输出JSON_C#对接ELK日志分析系统【实用】

夏辰君_6226

夏辰君_6226

发布时间:2026-05-01 18:25:18

|

991人浏览过

|

来源于php中文网

原创

Serilog WriteTo.File() 默认使用 PlainTextFormatter 输出纯文本日志,导致 ELK 无法解析结构化字段;必须配置 JsonFormatter(renderMessage: true) 输出单行 JSON(JSON Lines)格式,确保每条日志为合法、无换行、无缩进的 JSON 对象,才能被 Filebeat 正确解析并提升字段。

c#如何使用serilog输出json_c#对接elk日志分析系统【实用】

Serilog 默认不输出 JSON 格式,必须显式配置 JsonFormatter 或使用 Serilog.Formatting.Json 包,否则 ELK 无法正确解析字段。

为什么 WriteTo.File() 默认输出不是 JSON?

Serilog 的 WriteTo.File() 默认用的是 PlainTextFormatter,日志是纯文本,类似:
[10:23:41 INF] User logged in: id=123
这种格式在 Kibana 里只能当一个 message 字符串,所有结构化字段(如 UserId、Level、Timestamp)全丢了。

要让 ELK 能按字段搜索、聚合、过滤,必须让每条日志是一行合法 JSON(即 “JSON Lines” 格式)。

  • 安装必需包:Serilog + Serilog.Sinks.File + Serilog.Formatting.Json
  • 配置时必须传入 new JsonFormatter(renderMessage: true),否则 message 字段不会展开为字符串
  • renderMessage: true 是关键——它把模板消息(如 "User {Id} logged in")渲染成实际值并写入 message 字段,否则该字段为空或只是模板

如何配置 Serilog 输出标准 JSON Lines 到文件?

ELK 的 Logstash/Filebeat 默认按行读取日志,所以必须确保每条日志严格为一行 JSON,不能换行、不能缩进。

正确配置示例:

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
Log.Logger = new LoggerConfiguration()
    .WriteTo.File(
        new JsonFormatter(renderMessage: true),
        "logs/log-.json",
        rollingInterval: RollingInterval.Day,
        retainedFileCountLimit: 7)
    .CreateLogger();
  • JsonFormatter 构造函数不加参数 → renderMessage 默认为 false,会导致 message 字段缺失内容
  • 文件后缀用 .json 更利于 Filebeat 自动识别类型,但非强制;关键是内容为 JSON Lines
  • 不要用 outputTemplate 配合 PlainTextFormatter“模拟” JSON——那是字符串拼接,字段名/值没转义,JSON 解析会失败

对接 Filebeat 时,processors 还需额外处理吗?

如果 Serilog 输出的是标准 JSON Lines(每行一个对象),Filebeat 可直接用 json.keys_under_root: true 提升字段,无需 Grok 解析。

推荐 Filebeat 配置片段:

filebeat.inputs:
- type: filestream
  paths:
    - /var/log/myapp/*.json
  parsers:
    - json:
        keys_under_root: true
        overwrite_keys: true
        add_error_key: true
  • keys_under_root: true 把 JSON 顶层字段(如 timestamp、level、message)直接提升为事件字段,不用写 json.timestamp
  • overwrite_keys: true 避免字段冲突(比如日志里有 host,和 Filebeat 自带的 host.name 冲突)
  • 别开 json.message_key:Serilog 的 message 已是字符串,不需要再从某个子字段提取

常见 JSON 解析失败的错误现象和定位方法

在 Kibana 发现日志全进 message 字段、字段为空、或报 json parse error,大概率是以下原因:

  • 日志文件里混入了非 JSON 行(比如程序启动时的 Console.WriteLine、ANSI 控制字符、空行)→ 用 head -n 20 logs/log-20240501.json | jq . 检查前 20 行是否都可解析
  • JsonFormatter 未传参 → 查看任意一行,确认是否存在 "message": "xxx" 字段,而不是 "message": null 或压根没有 message
  • 日志中含非法 Unicode(如 Windows 控制台截断的宽字符)→ 在 LoggerConfiguration() 中加 .MinimumLevel.Verbose() 并临时输出到控制台,观察原始内容
  • Filebeat 启动后没 reload 配置 → 执行 filebeat test config && filebeat test output 验证连通性

JSON 日志的脆弱点在于“一错全崩”:单个格式错误会阻断后续所有行的解析。最稳妥的做法是先本地生成小文件,用 jq -s '.' xxx.json 全量验证合法性,再上生产。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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

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

1012

2023.08.08

什么是c#
什么是c#

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

2931

2023.08.31

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

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

885

2024.03.13

C#Task用法
C#Task用法

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

2615

2024.03.14

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

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

312

2026.02.03

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

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

389

2026.02.06

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

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

631

2026.03.11

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

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

329

2026.04.13

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn