elastic/kibana

[APM] Proposal: Merge error sample and trace summary into a single component

Open

#213,436 创建于 2025年3月6日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)TypeScript (19,065 star) (8,021 fork)batch import
Team:obs-ux-infra_services - DEPRECATEDdiscussgood first issuetechnical debt

描述

Trace summary and error sample summary look super similar, and they could be merged into a single component. As a background, we had 2 bugs related to those because of missing fields coming from the queries: if it was a single component, we wouldn't have prevented the bug from happening, but we could have found all usages and would have been easier to fix all places as now they are completely separate. Ref: #213430 and https://github.com/elastic/kibana/pull/206932

👍 :

  • Easier to test
  • Less repeating code
  • Easier to maintain
  • Easier to find similar issues to the above

👎 :

  • Harder to customize and have different data
  • Changes will affect both places (which can be 👍 and 👎 )
  • They are different summaries based on the context, so it might create confusion - good naming is required

⚠ This is just a proposal open for discussion

贡献者指南

技术栈
typescriptreact
领域
frontenddeveloper experience
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
TypeScriptReactUnderstanding of APM UI components
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
25
研究方向
Start by examining the current trace summary and error sample summary components in the Kibana APM plugin (likely located in packages/plugins/apm). Review the linked pull requests #213430 and #206932 to understand the missing fields bugs. Analyze the similarities and differences in the components' data and usage. Propose a merged component design that maintains customization where needed, and outline testing strategy.