[Incident Management] When fetching dashboards referenced panels are also fetched #228811

cesco-f · 2025-07-21T14:55:54Z

This PR closes #212125

Acceptance criteria

Visualizations included in a dashboard "by reference" can be evaluated and used as criteria for returning the dashboard via our related dashboards API (currently, only "by value" dashboards are searched)
This evaluation of by reference visualizations should happen in the same related dashboards API request (not a separate one) ✅

elasticmachine · 2025-07-21T14:56:01Z

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

...k/solutions/observability/plugins/observability/server/services/related_dashboards_client.ts

… also fetched

…nly used internally

…d panel

dominiqueclarke

I'd ideally like to fetch each panel reference only once.

Currently, if two or more dashboards share the same reference, the reference is fetched multiple times. Tested by saving a relevant lens visualization to the library, and then adding it to multiple dashboards.

Also, I noticed that relevant panels are not considered when added to a dashboard via the "Copy to Dashboard" control. When adding a relevant panel to a different dashboard using the control, the dashboard I copied over to was surfaced as a suggested dashboard

...k/solutions/observability/plugins/observability/server/services/related_dashboards_client.ts

x-pack/solutions/observability/plugins/observability/server/services/helpers.ts

...k/solutions/observability/plugins/observability/server/services/related_dashboards_client.ts

…hboardsClient

nickpeihl

presentation team changes lgtm

code review only

elasticmachine · 2025-08-06T10:22:16Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 903b3f2

Failed CI Steps

FTR Configs #56

Test Failures

[job] [logs] FTR Configs #56 / InfraOps App Metrics UI Home page with metrics present sort nodes by ascending value

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`dashboard`	689	690	+1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/observability-schema`	10	8	-2
`dashboard`	92	94	+2
total			-0

Unknown metric groups

API count

id	before	after	diff
`@kbn/observability-schema`	10	8	-2
`dashboard`	96	98	+2
total			-0

History

💛 Build #325844 was flaky 1d99452
💚 Build #325461 succeeded 49fa8d1
💚 Build #324600 succeeded 7f1766f
💚 Build #324201 succeeded 2eda724
💚 Build #323678 succeeded 448202e
💚 Build #323633 succeeded 663431e

...ck/solutions/observability/plugins/observability/server/services/referenced_panel_manager.ts

...k/solutions/observability/plugins/observability/server/services/related_dashboards_client.ts

nreese · 2025-08-06T16:11:33Z

src/platform/plugins/shared/dashboard/common/is_dashboard_panel.ts

+
+import type { DashboardAttributes, DashboardPanel } from '../server/content_management';
+
+export const isDashboardPanel = (


Is isDashboardPanel needed? Why not just use existing isDashboardSection?

TypeScript doesn’t automatically infer that if a value is not a DashboardSection, then it must be a DashboardPanel. To avoid manual type casting, I created a second type guard function.

dominiqueclarke · 2025-08-07T02:39:16Z

...ck/solutions/observability/plugins/observability/server/services/referenced_panel_manager.ts

  // So, if the same saved object panel is referenced in two different dashboards, it will have different panelIndex values in each dashboard, but the same panelId, since they're both referencing the same panel.
  private panelsById = new Map<string, ReferencedPanelAttributesWithReferences>();
  private panelIndexToId = new Map<string, string>();
+  private panelsTypeById = new Map<string, string>();


This looks great, but I'm just confused a bit again by the variable names. Maybe panelsToFetchById. Maybe not the best. I just don't understand what 'type' means here semantically.

The key of the map stores the panel ID and the value stores the panel type, I'll need both to fetch the panels.
That's why I called this map panelsTypeById, it follows the valueBykey pattern and reflects what’s stored.

What is you find confusing?

Thanks. I haven't looked at this domain in a while so I've been getting confused about what each individual piece is and how they all work together

After stepping through the code some more, I see the type is essentially the saved object type. Thank you very much for explaining.

dominiqueclarke

LGTM! Thanks for the work.

…also fetched (elastic#228811)

cesco-f requested review from a team as code owners July 21, 2025 14:55

cesco-f added release_note:enhancement backport:skip This PR does not require backporting v9.2.0 labels Jul 21, 2025

botelastic bot added the Team:actionable-obs Formerly "obs-ux-management", responsible for SLO, o11y alerting, significant events, & synthetics. label Jul 21, 2025

github-actions bot added the author:obs-ux-management PRs authored by the obs ux management team label Jul 21, 2025

cesco-f changed the title ~~[Incident Management] When fetching dashboards referenced panel are also fetched~~ [Incident Management] When fetching dashboards referenced panels are also fetched Jul 21, 2025

cesco-f force-pushed the panel-references branch from b797833 to 9f47052 Compare July 21, 2025 15:31

nickpeihl reviewed Jul 21, 2025

View reviewed changes

...k/solutions/observability/plugins/observability/server/services/related_dashboards_client.ts Outdated Show resolved Hide resolved

cesco-f added 3 commits July 25, 2025 15:58

feat(panel references): when fetching dashboards referenced panel are…

fdeb028

… also fetched

refactor(panels): improved types for valid dashboard panels

513f59e

fix(referenced panel): referenced panel saved object attributes are o…

e4ba2e7

…nly used internally

cesco-f force-pushed the panel-references branch from 73b4582 to e4ba2e7 Compare July 25, 2025 13:59

cesco-f and others added 4 commits July 25, 2025 17:21

Merge branch 'main' into panel-references

b04de21

test(fix): fixed test

72257a9

Merge branch 'main' into panel-references

663431e

feat(index and fields): index and fields are retreived from reference…

448202e

…d panel

cesco-f requested review from ThomThomson and nickpeihl July 28, 2025 08:21

dominiqueclarke requested changes Jul 29, 2025

View reviewed changes

cesco-f added 2 commits July 29, 2025 10:50

feat(referenced panel manager): added referenced panel manager class

5b0d7e6

refactor(move): moved fetchRelatedDashboards at the top of RelatedDas…

35446d7

…hboardsClient

cesco-f requested a review from dominiqueclarke July 29, 2025 08:56

cesco-f and others added 3 commits July 29, 2025 11:20

chore(has by id): removed hasById in referenced panel manager

2eda724

Merge branch 'main' into panel-references

7f1766f

Merge branch 'main' into panel-references

49fa8d1

nickpeihl approved these changes Aug 1, 2025

View reviewed changes

Merge branch 'main' into panel-references

1d99452

cesco-f removed the request for review from ThomThomson August 4, 2025 09:01

Merge branch 'main' into panel-references

903b3f2

dominiqueclarke requested a review from ThomThomson August 6, 2025 14:54

dominiqueclarke reviewed Aug 6, 2025

View reviewed changes

...ck/solutions/observability/plugins/observability/server/services/referenced_panel_manager.ts Outdated Show resolved Hide resolved

dominiqueclarke reviewed Aug 6, 2025

View reviewed changes

...k/solutions/observability/plugins/observability/server/services/related_dashboards_client.ts Outdated Show resolved Hide resolved

chore(comment): added comment

a1c1add

nreese reviewed Aug 6, 2025

View reviewed changes

perf(bulk get): panels are retreived using bulkGet

8462438

dominiqueclarke reviewed Aug 7, 2025

View reviewed changes

dominiqueclarke self-requested a review August 7, 2025 12:52

dominiqueclarke approved these changes Aug 7, 2025

View reviewed changes

cesco-f merged commit a14f553 into elastic:main Aug 8, 2025
12 checks passed

cesco-f deleted the panel-references branch August 8, 2025 08:37

NicholasPeretti pushed a commit to NicholasPeretti/kibana that referenced this pull request Aug 18, 2025

[Incident Management] When fetching dashboards referenced panels are …

aef0d31

…also fetched (elastic#228811)

qn895 pushed a commit to qn895/kibana that referenced this pull request Aug 26, 2025

[Incident Management] When fetching dashboards referenced panels are …

1905526

…also fetched (elastic#228811)


		import type { DashboardAttributes, DashboardPanel } from '../server/content_management';

		export const isDashboardPanel = (

[Incident Management] When fetching dashboards referenced panels are also fetched #228811

[Incident Management] When fetching dashboards referenced panels are also fetched #228811

Uh oh!

Conversation

cesco-f commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Acceptance criteria

Uh oh!

elasticmachine commented Jul 21, 2025

Uh oh!

Uh oh!

dominiqueclarke left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nickpeihl left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Aug 6, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

API count

History

Uh oh!

Uh oh!

Uh oh!

nreese Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

cesco-f Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

cesco-f Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

cesco-f commented Jul 21, 2025 •

edited

Loading

cesco-f Aug 7, 2025 •

edited

Loading