Java中 OpenTelemetry 怎么将自定义异常和异常链记录到 Trace Span 的 Event 中

老墨君_9363

老墨君_9363

2026-07-24

359人浏览

原创

opentelemetry 中应使用 recordexception() 方法记录自定义异常及异常链,它自动提取类型、消息、堆栈并遵循语义约定,递归处理 cause 和 suppressed 异常,主异常标记 exception.escaped = true,无需手动构造 event。

java中 opentelemetry 怎么将自定义异常和异常链记录到 trace span 的 event 中

OpenTelemetry 中,将自定义异常和异常链记录到 Span 的 Event 中,核心是使用 recordException() 方法 —— 它会自动提取异常类型、消息、堆栈,并将完整异常链(包括 cause 和 suppressed exceptions)作为 Span Event 记录,同时设置标准语义约定属性。

使用 recordException() 正确记录异常

这是最推荐的方式,无需手动构造 Event。它内置遵循 OpenTelemetry 语义约定(OTel Exception Conventions),自动处理嵌套异常:

  • 调用 span.recordException(throwable),传入任意 Throwable(包括自定义异常)
  • 底层会递归遍历 getCause() 和 getSuppressed(),为每层异常生成带 exception.type、exception.message、exception.stacktrace 属性的 Event
  • 主异常标记为 exception.escaped = true(若发生在当前 Span 内且未被捕获),其他链式异常标记为 false

确保自定义异常信息可被正确提取

自定义异常类无需特殊继承,但需保证 getMessage() 和 printStackTrace()(或 getStackTrace())能提供有意义内容:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 避免在 getMessage() 中返回空或泛化字符串(如 "Error occurred"),应包含关键上下文(如 "Failed to parse JSON for user ID=123")
  • 若重写了 fillInStackTrace() 并禁用了堆栈(如某些高性能场景),recordException() 将无法获取 stacktrace —— 建议仅在明确需要时关闭,否则保持默认行为
  • 若异常携带业务字段(如 error code、request ID),可通过额外属性补充:
    span.setAttribute("custom.error.code", myEx.getErrorCode());

手动添加 Event 的适用场景与注意事项

仅当需补充 recordException() 之外的上下文(如捕获前的日志、重试动作)时,才手动创建 Event:

  • 不要用 addEvent("exception", attributes) 替代 recordException() —— 这会丢失语义、堆栈解析和链式展开能力
  • 若必须手动记录,至少设置标准属性:
    span.addEvent("exception", Attributes.builder()<br>  .put("exception.type", ex.getClass().getName())<br>  .put("exception.message", ex.getMessage())<br>  .put("exception.stacktrace", Arrays.toString(ex.getStackTrace()))<br>  .build());

    ⚠️ 注意:这不会自动处理 cause 链,需自行递归添加
  • 更推荐的做法:先调用 recordException(),再用 addEvent("retry_attempt", Attributes.of("attempt", 2)) 补充业务事件

验证是否生效

在 Jaeger / Zipkin / OTLP 后端查看 Span 时,应看到:

  • Events 列表中出现一个或多个名为 exception 的事件
  • 每个事件含 exception.type(如 com.example.MyValidationException)、exception.message、exception.stacktrace(完整堆栈文本)
  • 若存在 cause(如 MyValidationException 包裹 JsonParseException),会看到两个独立的 exception Event,后者带 exception.escaped = false
  • Span 自身可能标记 status.code = ERROR(取决于 SDK 配置,默认通常开启)

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9957

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7082

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6252

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1084

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

888

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1296

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2609

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19931

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1175

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习