[Discover] Add support for log overview tab to Discover log profile #186680

davismcphee · 2024-06-22T03:27:56Z

Summary

This PR adds the log overview tab from Logs Explorer to the Discover log document profile. The only difference between the tab in Logs Explorer and Discover is that the one in Logs Explorer includes the O11y AI assistant while the Discover one doesn't (for now at least):

Resolves #187096.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

weltenwort · 2024-07-08T17:29:17Z

Hi @davismcphee, could you help us understand the intended scope of this effort? Is the goal to support the tab exactly as it exists in the Logs Explorer or does it deviate somehow?

davismcphee · 2024-07-09T02:42:48Z

@weltenwort The intent is to support it exactly as it exists in Logs Explorer, except for the O11y AI assistant, which should not yet be shown in Discover.

tonyghiani · 2024-07-11T07:28:51Z

...plugins/observability_solution/logs_explorer/public/customizations/logs_explorer_profile.tsx

+          component: (props) => (
+            <UnifiedDocViewerLogsOverview
+              {...props}
+              renderAIAssistant={plugins.logsShared.renderLogsAIAssistant}


Note
What if, instead of exporting a new logsShared.renderLogsAIAssistant renderer and introducing the dependency on logsShared, we directly consume this from the discoverShared registered feature as it was doing directly in the UnifiedDocViewer? It should be fine to introduce the dependency on discover-shared and consume the registered feature, also avoiding to update the signature of the logsShared plugin at all, wdyt?

const logsAIAssistantFeature = discoverShared.features.registry.getById( 'observability-logs-ai-assistant' ); registry.add({ id: 'doc_view_logs_overview', title: i18n.translate('xpack.logsExplorer.docViews.logsOverview.title', { defaultMessage: 'Overview', }), order: 0, component: (props) => ( <UnifiedDocViewerLogsOverview {...props} renderAIAssistant={logsAIAssistantFeature.render}

Good suggestion, thanks! I like that better and I suppose that's why we introduced discoverShared in the first place 🙂 Updated here: 97ba3c1.

tonyghiani · 2024-07-11T07:30:00Z

src/plugins/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.tsx

 import { LogsOverviewHeader } from './logs_overview_header';
 import { LogsOverviewHighlights } from './logs_overview_highlights';
 import { FieldActionsProvider } from '../../hooks/use_field_actions';
 import { getUnifiedDocViewerServices } from '../../plugin';
-import { LogsOverviewAIAssistant } from './logs_overview_ai_assistant';


Tip
This file could be removed right?

Yes it can, removed here: 97ba3c1.

tonyghiani

Hey @davismcphee, the taken approach LGTM, I just left a note on the introduced dependency and suggested a change to minimize changes to the plugin API, let me know your thoughts! The rest looks clean and doesn't need changes from the logs team 👌

davismcphee · 2024-07-11T20:34:14Z

/ci

davismcphee · 2024-07-11T21:18:36Z

/ci

davismcphee · 2024-07-12T02:44:36Z

/ci

davismcphee · 2024-07-12T04:32:51Z

/ci

… through discover_shared

…fix'

davismcphee · 2024-07-12T20:18:07Z

/ci

davismcphee · 2024-07-13T04:41:25Z

/ci

davismcphee

Thanks for the feedback @tonyghiani! Updated with your suggestions.

davismcphee · 2024-07-13T21:44:27Z

...plugins/observability_solution/logs_explorer/public/customizations/logs_explorer_profile.tsx

+          component: (props) => (
+            <UnifiedDocViewerLogsOverview
+              {...props}
+              renderAIAssistant={plugins.logsShared.renderLogsAIAssistant}


Good suggestion, thanks! I like that better and I suppose that's why we introduced discoverShared in the first place 🙂 Updated here: 97ba3c1.

davismcphee · 2024-07-13T21:44:43Z

src/plugins/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.tsx

 import { LogsOverviewHeader } from './logs_overview_header';
 import { LogsOverviewHighlights } from './logs_overview_highlights';
 import { FieldActionsProvider } from '../../hooks/use_field_actions';
 import { getUnifiedDocViewerServices } from '../../plugin';
-import { LogsOverviewAIAssistant } from './logs_overview_ai_assistant';


Yes it can, removed here: 97ba3c1.

elasticmachine · 2024-07-13T21:46:37Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

nreese

kibana-presentation changes LGTM
code review only

jughosta

Code changes LGTM 👍

tonyghiani

LGTM, thanks for the changes!

jloleysens

Did not test, but kibana JSONC changes LGTM!

elasticmachine · 2024-07-15T20:57:59Z

⏳ Build in-progress

Buildkite Build
Commit: 5c3f59d
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-186680-5c3f59d5f238
Observability Deployment

History

💛 Build #221461 was flaky 4ee16cc
💛 Build #221281 was flaky 4b82c4f
💔 Build #221258 failed 0251167
💔 Build #221043 failed 2f36c638b309d940ec76fcdb583daf59a4af93dc
💔 Build #221038 failed 0d037083ab4519539da8280832c3e7530cc9b90b

cc @davismcphee

davismcphee added release_note:enhancement Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Project:OneDiscover Enrich Discover with contextual awareness labels Jun 22, 2024

davismcphee self-assigned this Jun 22, 2024

kertal mentioned this pull request Jun 27, 2024

[OneDiscover] Add support for log overview tab to Discover document log profile #187096

Closed

tonyghiani reviewed Jul 11, 2024

View reviewed changes

davismcphee force-pushed the one-discover-log-profile-doc-viewer branch from 104fd90 to 8884ab3 Compare July 11, 2024 20:26

davismcphee and others added 8 commits July 12, 2024 17:14

Add support log overview tab to Discover log profile

7308ec3

Remove logs_shared dependency from logs_explorer and get AI assistant…

97ba3c1

… through discover_shared

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

e4fa82d

…fix'

Fix functional tests

791205e

Move getDocViewer to accessors folder

facdf85

Add log overview tab jest test

4ce922c

Add doc viewer log overview functional tests

42aecff

Fix broken tests and add serverless tests

0251167

davismcphee force-pushed the one-discover-log-profile-doc-viewer branch from e178e78 to 0251167 Compare July 12, 2024 20:16

Remove unused type

4b82c4f

davismcphee commented Jul 13, 2024

View reviewed changes

davismcphee marked this pull request as ready for review July 13, 2024 21:46

davismcphee requested a review from a team as a code owner July 13, 2024 21:46

davismcphee requested review from a team as code owners July 13, 2024 21:46

nreese approved these changes Jul 14, 2024

View reviewed changes

botelastic bot added the ci:project-deploy-observability Create an Observability project label Jul 14, 2024

jughosta approved these changes Jul 15, 2024

View reviewed changes

tonyghiani approved these changes Jul 15, 2024

View reviewed changes

jloleysens approved these changes Jul 15, 2024

View reviewed changes

davismcphee added 2 commits July 15, 2024 11:05

Merge branch 'main' into one-discover-log-profile-doc-viewer

4ee16cc

Merge branch 'main' into one-discover-log-profile-doc-viewer

5c3f59d

davismcphee merged commit 10c27a9 into elastic:main Jul 15, 2024
22 checks passed

davismcphee deleted the one-discover-log-profile-doc-viewer branch July 15, 2024 22:09

kibanamachine added v8.16.0 backport:skip This commit does not require backporting labels Jul 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Add support for log overview tab to Discover log profile #186680

[Discover] Add support for log overview tab to Discover log profile #186680

davismcphee commented Jun 22, 2024 •

edited

Loading

weltenwort commented Jul 8, 2024 •

edited

Loading

davismcphee commented Jul 9, 2024

tonyghiani Jul 11, 2024

davismcphee Jul 13, 2024

tonyghiani Jul 11, 2024

davismcphee Jul 13, 2024

tonyghiani left a comment

davismcphee commented Jul 11, 2024

davismcphee commented Jul 11, 2024

davismcphee commented Jul 12, 2024

davismcphee commented Jul 12, 2024

davismcphee commented Jul 12, 2024

davismcphee commented Jul 13, 2024

davismcphee left a comment

davismcphee Jul 13, 2024

davismcphee Jul 13, 2024

elasticmachine commented Jul 13, 2024

nreese left a comment

jughosta left a comment

tonyghiani left a comment

jloleysens left a comment

elasticmachine commented Jul 15, 2024 •

edited

Loading

[Discover] Add support for log overview tab to Discover log profile #186680

[Discover] Add support for log overview tab to Discover log profile #186680

Conversation

davismcphee commented Jun 22, 2024 • edited Loading

Summary

Checklist

For maintainers

weltenwort commented Jul 8, 2024 • edited Loading

davismcphee commented Jul 9, 2024

tonyghiani Jul 11, 2024

Choose a reason for hiding this comment

davismcphee Jul 13, 2024

Choose a reason for hiding this comment

tonyghiani Jul 11, 2024

Choose a reason for hiding this comment

davismcphee Jul 13, 2024

Choose a reason for hiding this comment

tonyghiani left a comment

Choose a reason for hiding this comment

davismcphee commented Jul 11, 2024

davismcphee commented Jul 11, 2024

davismcphee commented Jul 12, 2024

davismcphee commented Jul 12, 2024

davismcphee commented Jul 12, 2024

davismcphee commented Jul 13, 2024

davismcphee left a comment

Choose a reason for hiding this comment

davismcphee Jul 13, 2024

Choose a reason for hiding this comment

davismcphee Jul 13, 2024

Choose a reason for hiding this comment

elasticmachine commented Jul 13, 2024

nreese left a comment

Choose a reason for hiding this comment

jughosta left a comment

Choose a reason for hiding this comment

tonyghiani left a comment

Choose a reason for hiding this comment

jloleysens left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 15, 2024 • edited Loading

⏳ Build in-progress

History

davismcphee commented Jun 22, 2024 •

edited

Loading

weltenwort commented Jul 8, 2024 •

edited

Loading

elasticmachine commented Jul 15, 2024 •

edited

Loading