[APM] Fix metrics tab crash: migrate from controlGroupState to pinned_panels by smith · Pull Request #254999 · elastic/kibana

smith · 2026-02-25T19:50:11Z

Summary

The APM service metrics tab crashes when loading the static JSON dashboard because the dashboard plugin's DashboardState no longer has a controlGroupState property — controls are now represented as pinned_panels.

Caused by: [Controls Anywhere] Feature Branch — #245588

That PR refactored the entire controls system, removing the controlGroup embeddable and replacing controlGroupState with pinned_panels in DashboardState. The APM static_dashboard/index.tsx was updated to use the new controlGroupStateBuilder API signature (adding the uiActions param), but the fundamental issue was missed: the controlGroupState object built by the builder is no longer consumed by the dashboard. The getInitialInput() return value spreads into DashboardState, which silently ignores the controlGroupState property — or worse, the controlGroupStateBuilder.addDataControlFromField() call throws during control type detection via uiActions, causing getCreationOptions to fall into the catch block and return empty options (no panels rendered at all).

A follow-up PR ([Dashboards as Code] snake_case controls schemas — #249300) snake_cased the field names in the builder call but didn't address the underlying issue.

Fix:

Replace the controlGroupStateBuilder + controlGroupState pattern with a direct pinned_panels array in the new format
Add useControlsIntegration: true to DashboardCreationOptions so the controls render
Remove the now-unused @kbn/control-group-renderer dependency and UiActionsStart parameter

Changes

x-pack/solutions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.tsx — migrated controls from controlGroupState to pinned_panels
x-pack/solutions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.test.tsx — added Jest tests for getCreationOptions contract
x-pack/solutions/observability/plugins/apm/tsconfig.json — replaced @kbn/control-group-renderer reference with @kbn/controls-constants

Test plan

Navigate to an APM service with a known runtime dashboard (e.g. Java, Node.js) → Metrics tab
Verify the "Node name" options list control renders above the dashboard
Verify dashboard panels load without errors
Verify filtering by node name works correctly
Jest tests pass

Copilot

Pull request overview

This PR fixes a crash in the APM service metrics tab by migrating the dashboard controls system from the deprecated controlGroupState API to the new pinned_panels format introduced in the "Controls Anywhere" feature.

Changes:

Replaced controlGroupStateBuilder with direct pinned_panels array configuration
Added useControlsIntegration: true flag to enable controls rendering
Removed unused @kbn/control-group-renderer dependency and UiActionsStart parameter

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
x-pack/solutions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.tsx	Migrated controls from deprecated `controlGroupState` to new `pinned_panels` format and removed unused imports
x-pack/solutions/observability/plugins/apm/tsconfig.json	Updated dependency from `@kbn/control-group-renderer` to `@kbn/controls-constants`

smith · 2026-02-25T20:07:13Z

/oblt-deploy

…nned_panels The dashboard plugin removed `controlGroupState` from `DashboardState`, replacing it with `pinned_panels`. The APM static dashboard component was still using `controlGroupStateBuilder.addDataControlFromField()` to build a `controlGroupState` object passed via `getInitialInput()`. This caused the "Node name" options list control to either fail to initialize or be silently dropped. Replace the deprecated pattern with direct `pinned_panels` array construction and enable `useControlsIntegration` in creation options. Co-authored-by: Cursor <cursoragent@cursor.com>

Verify the pinned_panels contract: useControlsIntegration flag, options list control shape, data view ID pass-through, panel forwarding, and error toast on failure. Made-with: Cursor

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

...ions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.test.tsx

elasticmachine · 2026-02-26T03:49:41Z

Pinging @elastic/obs-presentation-team (Team:obs-presentation)

…pp/metrics/static_dashboard/index.test.tsx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

The pinned_panels array element is a discriminated union of control types. Accessing config.data_view_id without narrowing fails type checking because not all control variants (e.g. timeSlider, esqlControl) have that property. Made-with: Cursor

Heenawter

Solution makes sense to me 🙇 Thanks for tackling this - code review LGTM

miloszmarcinkowski · 2026-02-27T14:56:45Z

...ions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.test.tsx

+    jest.restoreAllMocks();
+    jest.clearAllMocks();


It seems to be redundant to call clearAllMocks(). Are they not overlapping?

rmyz · 2026-03-04T11:40:32Z

/ci

elasticmachine · 2026-03-04T13:11:33Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: f0d4a3f

Failed CI Steps

Test Failures

[job] [logs] Jest Tests #9 / discover responsive sidebar search bar customization should allow to toggle sidebar

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`apm`	2229	2207	-22

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`apm`	2.7MB	2.7MB	-71.7KB

Unknown metric groups

async chunk count

id	before	after	diff
`apm`	86	85	-1

History

💔 Build #404297 failed 6eb8ae2
💔 Build #404267 failed 7833c87
💔 Build #403172 failed 55ef2fd
💚 Build #402666 succeeded 9ec5329
💔 Build #401663 failed 79f2e15
💔 Build #401628 failed de6afce

…_panels (elastic#254999) ## Summary The APM service metrics tab crashes when loading the static JSON dashboard because the dashboard plugin's `DashboardState` no longer has a `controlGroupState` property — controls are now represented as `pinned_panels`. **Caused by:** [Controls Anywhere] Feature Branch — elastic#245588 That PR refactored the entire controls system, removing the `controlGroup` embeddable and replacing `controlGroupState` with `pinned_panels` in `DashboardState`. The APM `static_dashboard/index.tsx` was updated to use the new `controlGroupStateBuilder` API signature (adding the `uiActions` param), but the fundamental issue was missed: the `controlGroupState` object built by the builder is no longer consumed by the dashboard. The `getInitialInput()` return value spreads into `DashboardState`, which silently ignores the `controlGroupState` property — or worse, the `controlGroupStateBuilder.addDataControlFromField()` call throws during control type detection via `uiActions`, causing `getCreationOptions` to fall into the catch block and return empty options (no panels rendered at all). A follow-up PR ([Dashboards as Code] `snake_case` controls schemas — elastic#249300) snake_cased the field names in the builder call but didn't address the underlying issue. **Fix:** - Replace the `controlGroupStateBuilder` + `controlGroupState` pattern with a direct `pinned_panels` array in the new format - Add `useControlsIntegration: true` to `DashboardCreationOptions` so the controls render - Remove the now-unused `@kbn/control-group-renderer` dependency and `UiActionsStart` parameter ### Changes - `x-pack/solutions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.tsx` — migrated controls from `controlGroupState` to `pinned_panels` - `x-pack/solutions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.test.tsx` — added Jest tests for `getCreationOptions` contract - `x-pack/solutions/observability/plugins/apm/tsconfig.json` — replaced `@kbn/control-group-renderer` reference with `@kbn/controls-constants` ## Test plan - [x] Navigate to an APM service with a known runtime dashboard (e.g. Java, Node.js) → Metrics tab - [x] Verify the "Node name" options list control renders above the dashboard - [x] Verify dashboard panels load without errors - [x] Verify filtering by node name works correctly - [x] Jest tests pass --------- Co-authored-by: Cursor <cursoragent@cursor.com>

smith requested review from Heenawter and Copilot February 25, 2026 20:01

Copilot AI reviewed Feb 25, 2026

View reviewed changes

smith added release_note:fix backport:skip This PR does not require backporting labels Feb 26, 2026

smith and others added 2 commits February 25, 2026 21:45

Add Jest tests for JsonMetricsDashboard creation options

b6600a9

Verify the pinned_panels contract: useControlsIntegration flag, options list control shape, data view ID pass-through, panel forwarding, and error toast on failure. Made-with: Cursor

smith force-pushed the fix/apm-metrics-dashboard-controls branch from 1b29825 to b6600a9 Compare February 26, 2026 03:47

smith marked this pull request as ready for review February 26, 2026 03:48

smith requested a review from a team as a code owner February 26, 2026 03:48

smith requested a review from Copilot February 26, 2026 03:48

smith enabled auto-merge (squash) February 26, 2026 03:48

Copilot AI reviewed Feb 26, 2026

View reviewed changes

...ions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.test.tsx Show resolved Hide resolved

...ions/observability/plugins/apm/public/components/app/metrics/static_dashboard/index.test.tsx Show resolved Hide resolved

botelastic bot added the Team:obs-presentation Focus: APM UI, Infra UI, Hosts UI, Universal Profiling, Obs Overview and left Navigation label Feb 26, 2026

smith and others added 6 commits February 26, 2026 08:07

Update x-pack/solutions/observability/plugins/apm/public/components/a…

2b82690

…pp/metrics/static_dashboard/index.test.tsx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update x-pack/solutions/observability/plugins/apm/public/components/a…

ee9904d

…pp/metrics/static_dashboard/index.test.tsx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Changes from node scripts/regenerate_moon_projects.js --update

de6afce

Changes from node scripts/eslint_all_files --no-cache --fix

d396c8b

Merge branch 'main' into fix/apm-metrics-dashboard-controls

79f2e15

Heenawter approved these changes Feb 26, 2026

View reviewed changes

miloszmarcinkowski self-requested a review February 27, 2026 14:53

miloszmarcinkowski reviewed Feb 27, 2026

View reviewed changes

miloszmarcinkowski approved these changes Feb 27, 2026

View reviewed changes

smith added 2 commits March 1, 2026 13:08

Merge branch 'main' into fix/apm-metrics-dashboard-controls

9ec5329

Merge branch 'main' into fix/apm-metrics-dashboard-controls

55ef2fd

smith mentioned this pull request Mar 4, 2026

Metrics tab under service inventory results an error "Error while loading dashboard for agent "java" on runtime "Java"." #255408

Closed

Merge branch 'main' into fix/apm-metrics-dashboard-controls

7833c87

rmyz and others added 3 commits March 4, 2026 12:04

fixes

6eb8ae2

Changes from node scripts/lint_ts_projects --fix

fcd85dd

Changes from node scripts/regenerate_moon_projects.js --update

f0d4a3f

smith merged commit d5727c9 into elastic:main Mar 4, 2026
13 checks passed

kibanamachine added the v9.4.0 label Mar 4, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[APM] Fix metrics tab crash: migrate from controlGroupState to pinned_panels#254999

[APM] Fix metrics tab crash: migrate from controlGroupState to pinned_panels#254999
smith merged 14 commits intoelastic:mainfrom
smith:fix/apm-metrics-dashboard-controls

smith commented Feb 25, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

smith commented Feb 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Feb 26, 2026

Uh oh!

Heenawter left a comment

Uh oh!

miloszmarcinkowski Feb 27, 2026

Uh oh!

rmyz commented Mar 4, 2026

Uh oh!

Uh oh!

elasticmachine commented Mar 4, 2026

async chunk count

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

smith commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

smith commented Feb 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Feb 26, 2026

Uh oh!

Heenawter left a comment

Choose a reason for hiding this comment

Uh oh!

miloszmarcinkowski Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

rmyz commented Mar 4, 2026

Uh oh!

Uh oh!

elasticmachine commented Mar 4, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

async chunk count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

smith commented Feb 25, 2026 •

edited

Loading