Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] [Logs Overview] Add a flyout to show category document examples (#194867) #197966

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

kibanamachine
Copy link
Contributor

Backport

This will backport the following commits from main to 8.x:

Questions ?

Please refer to the Backport tool documentation

…tic#194867)

## Summary

Implements elastic#193450.

## Discover changes ⚠️

As part of this we need to render a basic table with the log level and
summary columns, which is technically context aware but only in the
sense we know we want it to be a logs context up front.

The "correct" solution here (or at least from recent conversations) is
to use the saved search embeddable. There is upcoming work planned to
move log stream component usages over to the saved search embeddable.
However, currently this isn't in a place to just be dropped in without
some pretty extensive work. I didn't feel comfortable doing a big push
on that work as a side effort to this work, especially with a loose (if
possible) 8.16 aim for this.

What I've done (and which isn't ideal I appreciate) is used the start
contract of the Discover plugin to export the columns / cells
pre-wrapped with the Discover services. It's not ideal in the sense of
dependencies, but technically Discover doesn't use logs shared. I
considered Discover shared but that's for registering functionality for
Discover, rather than the other way around.

Eventually we'll be able to remove this and convert over to the new
solution. I'm all ears to a better solution, but there's a big mismatch
between the needs here and dropping in something that exists currently.
Thankfully the changeset for Discover is small if we're happy to keep
this temporarily.

Edit: I've made some notes here:
elastic/logs-dev#111 (comment)

Edit: New package added here:
elastic@c290819

## Overview

From a high level:

- Adds a new state machine for handling "details" to show in the flyout
(document examples now, plus details and a timeline later).

- Hooks this up to a flyout expanded from the categories table.

- Provides linking to Discover to view documents from the category in
the flyout.

I've also left some comments inline.

## UI / UX

![Screenshot 2024-10-10 at 15 05
21](https://github.com/user-attachments/assets/49b525b1-f730-4e90-9a84-05175edb8c40)

![flyout_open](https://github.com/user-attachments/assets/0995b952-566b-4e09-80cf-20ad94343980)

![discover_link](https://github.com/user-attachments/assets/249ef269-0105-48af-9c81-ebae1cfb1680)

---------

Co-authored-by: Felix Stürmer <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
Co-authored-by: Felix Stürmer <[email protected]>
Co-authored-by: Julia Rechkunova <[email protected]>
(cherry picked from commit 6b63f7f)
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@kibanamachine kibanamachine merged commit c4f03ae into elastic:8.x Oct 28, 2024
37 checks passed
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
canvas 1287 1289 +2
cloudSecurityPosture 655 657 +2
discover 995 1001 +6
esqlDataGrid 364 366 +2
eventAnnotationListing 579 581 +2
lens 1464 1466 +2
logsExplorer 564 566 +2
logsShared 298 698 +400
observability 1063 1065 +2
searchPlayground 265 267 +2
securitySolution 6129 6131 +2
slo 849 851 +2
unifiedDocViewer 220 222 +2
unifiedHistogram 186 188 +2
total +430

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/discover-contextual-components - 34 +34
@kbn/discover-utils 147 200 +53
logsShared 284 285 +1
total +88

Async chunks

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

id before after diff
discover 825.6KB 821.9KB -3.7KB
logsShared 327.4KB 424.1KB +96.8KB
total +93.0KB

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
@kbn/discover-contextual-components - 2 +2
@kbn/discover-utils 1 4 +3
@kbn/observability-logs-overview 3 4 +1
total +6

Page load bundle

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

id before after diff
logsShared 174.5KB 175.2KB +734.0B
Unknown metric groups

API count

id before after diff
@kbn/discover-contextual-components - 37 +37
@kbn/discover-utils 181 234 +53
logsShared 313 314 +1
total +91

async chunk count

id before after diff
logsShared 15 17 +2

ESLint disabled line counts

id before after diff
@kbn/discover-contextual-components - 3 +3
discover 27 24 -3
total -0

Total ESLint disabled count

id before after diff
@kbn/discover-contextual-components - 3 +3
discover 29 26 -3
total -0

cc @Kerry350

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport ci:project-deploy-observability Create an Observability project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants