elastic/kibana

[APM] Add more info to the "Number of items in this trace exceed what is displayed" (xpack.apm.waterfall.exceedsMax) EuiCallOut

Open

#118282 opened on Nov 11, 2021

View on GitHub
 (10 comments) (0 reactions) (0 assignees)TypeScript (19,065 stars) (8,021 forks)batch import
Team:obs-ux-infra_services - DEPRECATEDapm:waterfallenhancementgood first issuestale

Description

Kibana version

7.15.1

Steps to Reproduce

  1. set up a separate deployment's kibana to report into APM
  2. pull up a trace for alerting:monitoring_alert_jvm_memory_usage (it's a taskManager run type)
  3. check the trace sample, especially after some time has passed

Expected Behavior

When the number of items exceeds the setting xpack.apm.waterfall.exceedsMax we should display the message:

Number of items in this trace exceed the maximum configured value (100). Please configure xpack.apm.ui.maxTraceItems to increase this value. See docs for more details

Actual Behavior

Get a number of items exceed message like this:

Screen Shot 2021-11-11 at 13 15 56

To work around this I ended up just browsing the kibana code to find the setting (maxTraceItems). Once I had that I was able to google my way to https://www.elastic.co/guide/en/kibana/current/apm-settings-in-kibana.html

Implementation details

https://github.com/elastic/kibana/blob/main/x-pack/plugins/apm/server/routes/traces/get_trace_items.ts#L77

Contributor guide

Tech stack
typescriptreactnodejs
Domain
frontendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Kibana APM pluginUnderstanding of Kibana configuration settingsAbility to edit TypeScript code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the file where the callout message is defined, likely in `x pack/plugins/apm/public/components/...` or the server side message constant. Modify the message string to include `xpack.apm.ui.maxTraceItems` and a link to the Kibana APM settings documentation (e.g., https://www.elastic.co/guide/en/kibana/current/apm settings in kibana.html). Test the change locally by triggering the trace item limit and verify the updated callout displays correctly.