[Observability] Page attachment type by dominiqueclarke · Pull Request #225295 · elastic/kibana

dominiqueclarke · 2025-06-25T13:34:02Z

Summary

This PR defines a generic "page" attachment type which can be used to attach any page in Kibana to a case. The attachment type is then implemented for the Synthetics monitor details page.

Overview

See implementation issue and its parent meta for more details on the "why" as well as our short-term future plans for extending this page attachment idea.

Technical details

Testing

Add the xpack.observabilityShared.unsafe.investigativeExperienceEnabled: true feature flag.
Create a Synthetics monitor. The easiest way to do so is to create a cluster via oblt cli and attach your local Kibana to it.
Visit the Synthetics monitor details page.
Click the Add to Case Button
Ensure the attachment is added successfully via toast. Click View Case
You should see the name of the monitor hyperlinked in the attachment comment. You should also see a Go to Monitor button in the comment actions. Lastly, you should see a Go To Monitor button in the actions dropdown.
When you visit each link, you should be navigated back to the monitor details history page, with the time range as absolute value for the time range the user was viewing at the time they added the attachment.

Appendix

Persistable state attachment type docs

…ke/kibana into feat/cases-link-attachment

…ses-link-attachment

…apping'

…ke/kibana into feat/cases-link-attachment

…apping'

…ses-page-attachment

…ke/kibana into feat/cases-page-attachment

michaelolo24 · 2025-07-18T15:20:25Z

x-pack/platform/packages/shared/kbn-page-attachment-schema/src/schema/v1.ts

+
+export const pageAttachmentPersistedStateSchema = z.object({
+  /**
+   * The type of page or page asset, e.g., 'dashboard', 'synthetics-test-run', 'slo-history', etc


Why do we need type here?

It's basically a sub-type to help us make future decisions about how to render this page, how to evaluate it in LLM analysis, etc.

@jasonrhodes Michael and I had actually discussed this over zoom last week. I should have put the reply here for reference.

michaelolo24

Thank you for responding to all of the feedback here! LGTM!

benakansara

LGTM. I have a few observations.

When creating a new case from monitor details page, the Actions popover doesn't close and once in create case form, it's not possible to move or remove it manually.

Should we allow right click on this link?

When I click on "Add to case", loading animation is shown next to "Run test manually" instead of "Add to case".

benakansara · 2025-07-21T13:58:33Z

x-pack/platform/plugins/shared/cases/kibana.jsonc

    "extraPublicDirs": [
-      "common"
+      "common",
+      "public/client/attachment_framework/types"


I wonder if we should move these types to common?

...servability/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.tsx

…synthetics/components/monitor_details/actions.tsx Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com>

…miniqueclarke/kibana into feat/observability-generic-attachment

...bility/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.test.tsx

…synthetics/components/monitor_details/actions.test.tsx

...bility/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.test.tsx

…synthetics/components/monitor_details/actions.test.tsx

...bility/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.test.tsx

…synthetics/components/monitor_details/actions.test.tsx

elasticmachine · 2025-07-21T20:39:48Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: dbb5783

Failed CI Steps

FTR Configs #65

Test Failures

[job] [logs] FTR Configs #65 / @ess @serverless @skipInServerlessMKI Import prebuilt rules when the package is not installed imports new prebuilt rules

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`observability`	1412	1421	+9
`synthetics`	1367	1369	+2
total			+11

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/page-attachment-schema`	-	3	+3
`cases`	109	110	+1
`observabilityShared`	506	515	+9
`triggersActionsUi`	494	493	-1
total			+12

Async chunks

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

id	before	after	diff
`cases`	1.3MB	1.3MB	+247.0B
`observability`	1.3MB	1.3MB	+3.1KB
`synthetics`	1.0MB	1.0MB	+3.0KB
total			+6.4KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`observabilityShared`	18	19	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`cases`	135.0KB	135.2KB	+240.0B
`observability`	95.8KB	155.6KB	+59.8KB
`observabilityShared`	66.9KB	67.0KB	+152.0B
`synthetics`	28.0KB	28.2KB	+149.0B
`triggersActionsUi`	105.7KB	105.6KB	-66.0B
total			+60.3KB

Unknown metric groups

API count

id	before	after	diff
`@kbn/page-attachment-schema`	-	3	+3
`cases`	129	130	+1
`observabilityShared`	512	521	+9
`triggersActionsUi`	498	497	-1
total			+12

async chunk count

id	before	after	diff
`observability`	23	25	+2

ESLint disabled line counts

id	before	after	diff
`observability`	46	48	+2

Total ESLint disabled count

id	before	after	diff
`observability`	47	49	+2

History

💔 Build #321480 failed cf31a52
💔 Build #321402 failed d63072c
💔 Build #320661 failed 2f40548
💚 Build #320075 succeeded 08be407
💚 Build #319635 succeeded 941403f

Closes elastic#226073 ## Summary This PR defines a generic "page" attachment type which can be used to attach any page in Kibana to a case. The attachment type is then implemented for the Synthetics monitor details page. <img width="1066" alt="Screenshot 2025-06-25 at 10 43 15 PM" src="https://github.com/user-attachments/assets/6b55bf8f-b9ca-476f-b4ca-634b8e17d461" /> ## Overview See [implementation issue](elastic#226073) and [its parent meta](elastic#226072) for more details on the "why" as well as our short-term future plans for extending this page attachment idea. ## Technical details 1. [The type definition for the attachment persisted state](https://github.com/elastic/kibana/pull/225295/files#diff-682c62b478a2d1aea2a471733166259185c1ba4534e293abec015abd64cc4c27) 2. [The attachment spec](https://github.com/elastic/kibana/pull/225295/files#diff-2083a0a3bb7f475e6b8a50a061c2a0a78499b416f5d7465aaa3171a8dd8971fa) 3. [The Synthetics implementation](https://github.com/elastic/kibana/pull/225295/files#diff-302cdc10545ddfaf8eae433954a03c7cd21b94c4f2f0706364ce50c1edf36a3b) ## Testing 1. Add the `xpack.observabilityShared.unsafe.investigativeExperienceEnabled: true` feature flag. 2. Create a Synthetics monitor. The easiest way to do so is to create a cluster via oblt cli and attach your local Kibana to it. 3. Visit the Synthetics monitor details page. 4. Click the Add to Case Button 8. Ensure the attachment is added successfully via toast. Click View Case 9. You should see the name of the monitor hyperlinked in the attachment comment. You should also see a Go to Monitor button in the comment actions. Lastly, you should see a Go To Monitor button in the actions dropdown. 10. When you visit each link, you should be navigated back to the monitor details history page, with the time range as absolute value for the time range the user was viewing at the time they added the attachment. ## Appendix 1. [Persistable state attachment type docs](https://docs.elastic.dev/reops/attachment-framework-persistable-state) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Bena Kansara <bena.kansara@elastic.co> Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com>

This reverts commit 33a9007.

This reverts commit 33a9007. I reviewed the files and resolved the merge conflicts. I didn’t fully revert the PR, instead I cherry-picked the following: - Locator enhancement (covering for time range and tabId) - Actions - Bug fix for running tests manually with required permissions - Route config updates (covering Actions and tabs) - Import adjustments ## Note These PRs need to be merged first in the order they are listed: - #236872 - <del>https://github.com/elastic/kibana/pull/236869</del> - #237064 --------- Co-authored-by: Panagiota Mitsopoulou <giota85@gmail.com>

…ic#236958) This reverts commit 33a9007. I reviewed the files and resolved the merge conflicts. I didn’t fully revert the PR, instead I cherry-picked the following: - Locator enhancement (covering for time range and tabId) - Actions - Bug fix for running tests manually with required permissions - Route config updates (covering Actions and tabs) - Import adjustments ## Note These PRs need to be merged first in the order they are listed: - elastic#236872 - <del>https://github.com/elastic/kibana/pull/236869</del> - elastic#237064 --------- Co-authored-by: Panagiota Mitsopoulou <giota85@gmail.com>

dominiqueclarke and others added 27 commits June 10, 2025 15:22

add link attachment type

77d172f

[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

3bcb4d4

remove dashboard dependency from triggers actions ui

bc5c03d

Merge branch 'feat/cases-link-attachment' of github.com:dominiqueclar…

192116f

…ke/kibana into feat/cases-link-attachment

Merge branch 'main' of https://github.com/elastic/kibana into feat/ca…

8f3782f

…ses-link-attachment

integrate screenshot

0aeebda

merge upstream

6037685

adjust types

5266320

[CI] Auto-commit changed files from 'node scripts/styled_components_m…

14e8f82

…apping'

quick checks

ac2ef57

Merge branch 'feat/cases-link-attachment' of github.com:dominiqueclar…

22cc56a

…ke/kibana into feat/cases-link-attachment

remove unnecessary dashboard dependency

9d0d253

[CI] Auto-commit changed files from 'node scripts/styled_components_m…

b45cdba

…apping'

split and merge screenshot images

6d1c98b

add actions

5bd0383

merge upstream

d28a975

remove screenshot functionality

e9818ad

adjust rendered component

b988b67

adjust types and linting

6565e1b

adjust types

711442b

adjust test

ad3b528

Merge branch 'main' of https://github.com/elastic/kibana into feat/ca…

beb55d4

…ses-page-attachment

Merge branch 'main' into feat/cases-page-attachment

f612f90

adjust types

072a087

Merge branch 'feat/cases-page-attachment' of github.com:dominiqueclar…

da1e7a7

…ke/kibana into feat/cases-page-attachment

adjust tests

d81aec3

adjust types

c7166c5

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

remove dashboard implementation

479cf7c

dominiqueclarke force-pushed the feat/observability-generic-attachment branch from a3a9ecf to 479cf7c Compare June 25, 2025 13:38

dominiqueclarke added 3 commits July 17, 2025 22:43

adjust config

c3378bf

add link to EuiIcon

e8037be

adjust comment

2f40548

michaelolo24 reviewed Jul 18, 2025

View reviewed changes

michaelolo24 approved these changes Jul 18, 2025

View reviewed changes

Merge branch 'main' into feat/observability-generic-attachment

d63072c

benakansara approved these changes Jul 21, 2025

View reviewed changes

dominiqueclarke and others added 3 commits July 21, 2025 11:41

Update x-pack/solutions/observability/plugins/synthetics/public/apps/…

b5d9da5

…synthetics/components/monitor_details/actions.tsx Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com>

adjust tests

932bf1a

Merge branch 'feat/observability-generic-attachment' of github.com:do…

cf31a52

…miniqueclarke/kibana into feat/observability-generic-attachment

dominiqueclarke commented Jul 21, 2025

View reviewed changes

...bility/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.test.tsx Outdated Show resolved Hide resolved

Update x-pack/solutions/observability/plugins/synthetics/public/apps/…

8c045a8

…synthetics/components/monitor_details/actions.test.tsx

dominiqueclarke commented Jul 21, 2025

View reviewed changes

...bility/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.test.tsx Outdated Show resolved Hide resolved

Update x-pack/solutions/observability/plugins/synthetics/public/apps/…

8ef4b60

…synthetics/components/monitor_details/actions.test.tsx

dominiqueclarke commented Jul 21, 2025

View reviewed changes

...bility/plugins/synthetics/public/apps/synthetics/components/monitor_details/actions.test.tsx Outdated Show resolved Hide resolved

Update x-pack/solutions/observability/plugins/synthetics/public/apps/…

dbb5783

…synthetics/components/monitor_details/actions.test.tsx

jcger approved these changes Jul 22, 2025

View reviewed changes

kdelemme mentioned this pull request Jul 22, 2025

feat(slo): add to case #228976

Merged

dominiqueclarke merged commit 33a9007 into elastic:main Jul 22, 2025
14 checks passed

fkanout added a commit to fkanout/kibana that referenced this pull request Sep 30, 2025

Revert "[Observability] Page attachment type (elastic#225295)"

40a3140

This reverts commit 33a9007.

mgiota added a commit to mgiota/kibana that referenced this pull request Sep 30, 2025

Revert "[Observability] Page attachment type (elastic#225295)"

e9c5727

This reverts commit 33a9007.

mgiota added a commit to mgiota/kibana that referenced this pull request Sep 30, 2025

Revert "[Observability] Page attachment type (elastic#225295)"

5196fc8

This reverts commit 33a9007.

mgiota added a commit to mgiota/kibana that referenced this pull request Sep 30, 2025

Revert "[Observability] Page attachment type (elastic#225295)"

d413b8a

This reverts commit 33a9007.

mgiota added a commit to mgiota/kibana that referenced this pull request Sep 30, 2025

Revert "[Observability] Page attachment type (elastic#225295)"

b89690d

This reverts commit 33a9007.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Observability] Page attachment type #225295

[Observability] Page attachment type #225295
dominiqueclarke merged 99 commits intoelastic:mainfrom
dominiqueclarke:feat/observability-generic-attachment

dominiqueclarke commented Jun 25, 2025 •

edited

Loading

Uh oh!

michaelolo24 Jul 18, 2025

Uh oh!

jasonrhodes Jul 22, 2025

Uh oh!

dominiqueclarke Jul 22, 2025

Uh oh!

michaelolo24 left a comment

Uh oh!

benakansara left a comment

Uh oh!

benakansara Jul 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Jul 21, 2025

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

Conversation

dominiqueclarke commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Overview

Technical details

Testing

Appendix

Uh oh!

michaelolo24 Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

jasonrhodes Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

michaelolo24 left a comment

Choose a reason for hiding this comment

Uh oh!

benakansara left a comment

Choose a reason for hiding this comment

Uh oh!

benakansara Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Jul 21, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

dominiqueclarke commented Jun 25, 2025 •

edited

Loading