elastic/kibana

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

Open

#213436 opened on Mar 6, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (19,065 stars) (8,021 forks)batch import
Team:obs-ux-infra_services - DEPRECATEDdiscussgood first issuetechnical debt

Description

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

Contributor guide

Tech stack
typescriptreact
Domain
frontenddeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScriptReactUnderstanding of APM UI components
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
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.