Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[8.x] [Logs Overview] Add a flyout to show category document examples (…
…#194867) (#197966) # Backport This will backport the following commits from `main` to `8.x`: - [[Logs Overview] Add a flyout to show category document examples (#194867)](#194867) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Kerry Gallagher","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-24T14:49:27Z","message":"[Logs Overview] Add a flyout to show category document examples (#194867)\n\n## Summary\r\n\r\nImplements https://github.com/elastic/kibana/issues/193450.\r\n\r\n## Discover changes⚠️ \r\n\r\nAs part of this we need to render a basic table with the log level and\r\nsummary columns, which is technically context aware but only in the\r\nsense we know we want it to be a logs context up front.\r\n\r\nThe \"correct\" solution here (or at least from recent conversations) is\r\nto use the saved search embeddable. There is upcoming work planned to\r\nmove log stream component usages over to the saved search embeddable.\r\nHowever, currently this isn't in a place to just be dropped in without\r\nsome pretty extensive work. I didn't feel comfortable doing a big push\r\non that work as a side effort to this work, especially with a loose (if\r\npossible) 8.16 aim for this.\r\n\r\nWhat I've done (and which isn't ideal I appreciate) is used the start\r\ncontract of the Discover plugin to export the columns / cells\r\npre-wrapped with the Discover services. It's not ideal in the sense of\r\ndependencies, but technically Discover doesn't use logs shared. I\r\nconsidered Discover shared but that's for registering functionality for\r\nDiscover, rather than the other way around.\r\n\r\nEventually we'll be able to remove this and convert over to the new\r\nsolution. I'm all ears to a better solution, but there's a big mismatch\r\nbetween the needs here and dropping in something that exists currently.\r\nThankfully the changeset for Discover is small if we're happy to keep\r\nthis temporarily.\r\n\r\nEdit: I've made some notes here:\r\nhttps://github.com/elastic/logs-dev/issues/111#issuecomment-2411096251\r\n\r\nEdit: New package added here:\r\nhttps://github.com/elastic/kibana/commit/c290819c1c1e1cb5a67d437cca7783c0e2302c8f\r\n\r\n## Overview\r\n\r\nFrom a high level:\r\n\r\n- Adds a new state machine for handling \"details\" to show in the flyout\r\n(document examples now, plus details and a timeline later).\r\n\r\n- Hooks this up to a flyout expanded from the categories table.\r\n\r\n- Provides linking to Discover to view documents from the category in\r\nthe flyout.\r\n\r\nI've also left some comments inline.\r\n\r\n## UI / UX \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: Felix Stürmer <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Felix Stürmer <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>","sha":"6b63f7f6314e9c05525df32629be7ba769c6ab4c","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport missing","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-logs","backport:version"],"title":"[Logs Overview] Add a flyout to show category document examples ","number":194867,"url":"https://github.com/elastic/kibana/pull/194867","mergeCommit":{"message":"[Logs Overview] Add a flyout to show category document examples (#194867)\n\n## Summary\r\n\r\nImplements https://github.com/elastic/kibana/issues/193450.\r\n\r\n## Discover changes⚠️ \r\n\r\nAs part of this we need to render a basic table with the log level and\r\nsummary columns, which is technically context aware but only in the\r\nsense we know we want it to be a logs context up front.\r\n\r\nThe \"correct\" solution here (or at least from recent conversations) is\r\nto use the saved search embeddable. There is upcoming work planned to\r\nmove log stream component usages over to the saved search embeddable.\r\nHowever, currently this isn't in a place to just be dropped in without\r\nsome pretty extensive work. I didn't feel comfortable doing a big push\r\non that work as a side effort to this work, especially with a loose (if\r\npossible) 8.16 aim for this.\r\n\r\nWhat I've done (and which isn't ideal I appreciate) is used the start\r\ncontract of the Discover plugin to export the columns / cells\r\npre-wrapped with the Discover services. It's not ideal in the sense of\r\ndependencies, but technically Discover doesn't use logs shared. I\r\nconsidered Discover shared but that's for registering functionality for\r\nDiscover, rather than the other way around.\r\n\r\nEventually we'll be able to remove this and convert over to the new\r\nsolution. I'm all ears to a better solution, but there's a big mismatch\r\nbetween the needs here and dropping in something that exists currently.\r\nThankfully the changeset for Discover is small if we're happy to keep\r\nthis temporarily.\r\n\r\nEdit: I've made some notes here:\r\nhttps://github.com/elastic/logs-dev/issues/111#issuecomment-2411096251\r\n\r\nEdit: New package added here:\r\nhttps://github.com/elastic/kibana/commit/c290819c1c1e1cb5a67d437cca7783c0e2302c8f\r\n\r\n## Overview\r\n\r\nFrom a high level:\r\n\r\n- Adds a new state machine for handling \"details\" to show in the flyout\r\n(document examples now, plus details and a timeline later).\r\n\r\n- Hooks this up to a flyout expanded from the categories table.\r\n\r\n- Provides linking to Discover to view documents from the category in\r\nthe flyout.\r\n\r\nI've also left some comments inline.\r\n\r\n## UI / UX \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: Felix Stürmer <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Felix Stürmer <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>","sha":"6b63f7f6314e9c05525df32629be7ba769c6ab4c"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194867","number":194867,"mergeCommit":{"message":"[Logs Overview] Add a flyout to show category document examples (#194867)\n\n## Summary\r\n\r\nImplements https://github.com/elastic/kibana/issues/193450.\r\n\r\n## Discover changes⚠️ \r\n\r\nAs part of this we need to render a basic table with the log level and\r\nsummary columns, which is technically context aware but only in the\r\nsense we know we want it to be a logs context up front.\r\n\r\nThe \"correct\" solution here (or at least from recent conversations) is\r\nto use the saved search embeddable. There is upcoming work planned to\r\nmove log stream component usages over to the saved search embeddable.\r\nHowever, currently this isn't in a place to just be dropped in without\r\nsome pretty extensive work. I didn't feel comfortable doing a big push\r\non that work as a side effort to this work, especially with a loose (if\r\npossible) 8.16 aim for this.\r\n\r\nWhat I've done (and which isn't ideal I appreciate) is used the start\r\ncontract of the Discover plugin to export the columns / cells\r\npre-wrapped with the Discover services. It's not ideal in the sense of\r\ndependencies, but technically Discover doesn't use logs shared. I\r\nconsidered Discover shared but that's for registering functionality for\r\nDiscover, rather than the other way around.\r\n\r\nEventually we'll be able to remove this and convert over to the new\r\nsolution. I'm all ears to a better solution, but there's a big mismatch\r\nbetween the needs here and dropping in something that exists currently.\r\nThankfully the changeset for Discover is small if we're happy to keep\r\nthis temporarily.\r\n\r\nEdit: I've made some notes here:\r\nhttps://github.com/elastic/logs-dev/issues/111#issuecomment-2411096251\r\n\r\nEdit: New package added here:\r\nhttps://github.com/elastic/kibana/commit/c290819c1c1e1cb5a67d437cca7783c0e2302c8f\r\n\r\n## Overview\r\n\r\nFrom a high level:\r\n\r\n- Adds a new state machine for handling \"details\" to show in the flyout\r\n(document examples now, plus details and a timeline later).\r\n\r\n- Hooks this up to a flyout expanded from the categories table.\r\n\r\n- Provides linking to Discover to view documents from the category in\r\nthe flyout.\r\n\r\nI've also left some comments inline.\r\n\r\n## UI / UX \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: Felix Stürmer <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Felix Stürmer <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>","sha":"6b63f7f6314e9c05525df32629be7ba769c6ab4c"}}]}] BACKPORT--> Co-authored-by: Kerry Gallagher <[email protected]>
- Loading branch information
1 parent
fedd197
commit c4f03ae