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

…186680)

## 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):

![log_overview](https://github.com/user-attachments/assets/3c5b3ea0-227e-41fa-ab1e-5618008b5d39)

Resolves #187096.

### Checklist

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <[email protected]>

src/plugins/discover/public/context_awareness/profile_providers/example_data_source_profile/profile.tsx

@@ -58,7 +58,15 @@ export const exampleDataSourceProfileProvider: DataSourceProfileProvider = {
       return {
         title: `Record #${recordId}`,
         docViewsRegistry: (registry) => {
-          registry.enableById('doc_view_logs_overview');
+          registry.add({
+            id: 'doc_view_example',
+            title: 'Example',
+            order: 0,
+            component: () => (
+              <div data-test-subj="exampleDataSourceProfileDocView">Example Doc View</div>
+            ),
+          });
+
           return prevValue.docViewsRegistry(registry);
         },
       };

src/plugins/discover/public/context_awareness/profile_providers/example_document_profile/profile.ts

@@ -13,14 +13,14 @@ export const exampleDocumentProfileProvider: DocumentProfileProvider = {
   profileId: 'example-document-profile',
   profile: {},
   resolve: (params) => {
-    if (getFieldValue(params.record, 'data_stream.type') !== 'logs') {
+    if (getFieldValue(params.record, 'data_stream.type') !== 'example') {
       return { isMatch: false };
     }
 
     return {
       isMatch: true,
       context: {
-        type: DocumentType.Log,
+        type: DocumentType.Default,
       },
     };
   },

src/plugins/discover/public/context_awareness/profile_providers/log_document_profile/accessors/get_doc_viewer.tsx

@@ -0,0 +1,33 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { i18n } from '@kbn/i18n';
+import { UnifiedDocViewerLogsOverview } from '@kbn/unified-doc-viewer-plugin/public';
+import React from 'react';
+import type { DocumentProfileProvider } from '../../../profiles';
+
+export const getDocViewer: DocumentProfileProvider['profile']['getDocViewer'] =
+  (prev) => (params) => {
+    const prevDocViewer = prev(params);
+
+    return {
+      ...prevDocViewer,
+      docViewsRegistry: (registry) => {
+        registry.add({
+          id: 'doc_view_logs_overview',
+          title: i18n.translate('discover.docViews.logsOverview.title', {
+            defaultMessage: 'Log overview',
+          }),
+          order: 0,
+          component: (props) => <UnifiedDocViewerLogsOverview {...props} />,
+        });
+
+        return prevDocViewer.docViewsRegistry(registry);
+      },
+    };
+  };

src/plugins/discover/public/context_awareness/profile_providers/log_document_profile/accessors/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export { getDocViewer } from './get_doc_viewer';

src/plugins/discover/public/context_awareness/profile_providers/log_document_profile/profile.test.ts

@@ -7,6 +7,7 @@
  */
 
 import { buildDataTableRecord } from '@kbn/discover-utils';
+import { DocViewsRegistry } from '@kbn/unified-doc-viewer';
 import { DocumentType } from '../../profiles';
 import { createContextAwarenessMocks } from '../../__mocks__';
 import { createLogDocumentProfileProvider } from './profile';
@@ -65,6 +66,32 @@ describe('logDocumentProfileProvider', () => {
       })
     ).toEqual(RESOLUTION_MISMATCH);
   });
+
+  describe('getDocViewer', () => {
+    it('adds a log overview doc view to the registry', () => {
+      const getDocViewer = logDocumentProfileProvider.profile.getDocViewer!(() => ({
+        title: 'test title',
+        docViewsRegistry: (registry) => registry,
+      }));
+      const docViewer = getDocViewer({
+        record: buildDataTableRecord({}),
+      });
+      const registry = new DocViewsRegistry();
+
+      expect(docViewer.title).toBe('test title');
+      expect(registry.getAll()).toHaveLength(0);
+      docViewer.docViewsRegistry(registry);
+      expect(registry.getAll()).toHaveLength(1);
+      expect(registry.getAll()[0]).toEqual(
+        expect.objectContaining({
+          id: 'doc_view_logs_overview',
+          title: 'Log overview',
+          order: 0,
+          component: expect.any(Function),
+        })
+      );
+    });
+  });
 });
 
 const buildMockRecord = (index: string, fields: Record<string, unknown[]> = {}) =>

src/plugins/discover/public/context_awareness/profile_providers/log_document_profile/profile.ts → src/plugins/discover/public/context_awareness/profile_providers/log_document_profile/profile.tsx

@@ -9,12 +9,15 @@
 import { DataTableRecord } from '@kbn/discover-utils';
 import { DocumentProfileProvider, DocumentType } from '../../profiles';
 import { ProfileProviderServices } from '../profile_provider_services';
+import { getDocViewer } from './accessors';
 
 export const createLogDocumentProfileProvider = (
   services: ProfileProviderServices
 ): DocumentProfileProvider => ({
   profileId: 'log-document-profile',
-  profile: {},
+  profile: {
+    getDocViewer,
+  },
   resolve: ({ record }) => {
     const isLogRecord = getIsLogRecord(record, services.logsContextService.isLogsIndexPattern);
 

src/plugins/discover/public/context_awareness/profile_providers/register_profile_providers.test.ts

@@ -68,7 +68,7 @@ describe('registerProfileProviders', () => {
     const documentContext = documentProfileServiceMock.resolve({
       record: {
         id: 'test',
-        flattened: { 'data_stream.type': 'logs' },
+        flattened: { 'data_stream.type': 'example' },
         raw: {},
       },
     });
@@ -100,7 +100,7 @@ describe('registerProfileProviders', () => {
     const documentContext = documentProfileServiceMock.resolve({
       record: {
         id: 'test',
-        flattened: { 'data_stream.type': 'logs' },
+        flattened: { 'data_stream.type': 'example' },
         raw: {},
       },
     });

src/plugins/unified_doc_viewer/kibana.jsonc

@@ -8,7 +8,7 @@
     "server": false,
     "browser": true,
     "requiredBundles": ["kibanaUtils"],
-    "requiredPlugins": ["data", "discoverShared", "fieldFormats", "share"],
+    "requiredPlugins": ["data", "fieldFormats", "share"],
     "optionalPlugins": ["fieldsMetadata"]
   }
 }

src/plugins/unified_doc_viewer/public/__mocks__/services.ts

@@ -8,7 +8,6 @@
 
 import { analyticsServiceMock } from '@kbn/core-analytics-browser-mocks';
 import { dataPluginMock } from '@kbn/data-plugin/public/mocks';
-import { discoverSharedPluginMock } from '@kbn/discover-shared-plugin/public/mocks';
 import { fieldFormatsMock } from '@kbn/field-formats-plugin/common/mocks';
 import { fieldsMetadataPluginPublicMock } from '@kbn/fields-metadata-plugin/public/mocks';
 import { uiSettingsServiceMock } from '@kbn/core-ui-settings-browser-mocks';
@@ -24,7 +23,6 @@ export const mockUnifiedDocViewer: jest.Mocked<UnifiedDocViewerStart> = {
 export const mockUnifiedDocViewerServices: jest.Mocked<UnifiedDocViewerServices> = {
   analytics: analyticsServiceMock.createAnalyticsServiceStart(),
   data: dataPluginMock.createStartContract(),
-  discoverShared: discoverSharedPluginMock.createStartContract(),
   fieldFormats: fieldFormatsMock,
   fieldsMetadata: fieldsMetadataPluginPublicMock.createStartContract(),
   storage: new Storage(localStorage),

src/plugins/unified_doc_viewer/public/components/doc_viewer_logs_overview/index.ts

@@ -5,6 +5,7 @@
  * in compliance with, at your election, the Elastic License 2.0 or the Server
  * Side Public License, v 1.
  */
+
 import { LogsOverview } from './logs_overview';
 
 // Required for usage in React.lazy

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

@@ -10,23 +10,29 @@ import React from 'react';
 import { DocViewRenderProps } from '@kbn/unified-doc-viewer/types';
 import { getLogDocumentOverview } from '@kbn/discover-utils';
 import { EuiHorizontalRule, EuiSpacer } from '@elastic/eui';
+import { ObservabilityLogsAIAssistantFeatureRenderDeps } from '@kbn/discover-shared-plugin/public';
 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';
 import { LogsOverviewDegradedFields } from './logs_overview_degraded_fields';
 
+export type LogsOverviewProps = DocViewRenderProps & {
+  renderAIAssistant?: (deps: ObservabilityLogsAIAssistantFeatureRenderDeps) => JSX.Element;
+};
+
 export function LogsOverview({
   columns,
   dataView,
   hit,
   filter,
   onAddColumn,
   onRemoveColumn,
-}: DocViewRenderProps) {
+  renderAIAssistant,
+}: LogsOverviewProps) {
   const { fieldFormats } = getUnifiedDocViewerServices();
   const parsedDoc = getLogDocumentOverview(hit, { dataView, fieldFormats });
+  const LogsOverviewAIAssistant = renderAIAssistant;
 
   return (
     <FieldActionsProvider
@@ -40,7 +46,7 @@ export function LogsOverview({
       <EuiHorizontalRule margin="xs" />
       <LogsOverviewHighlights formattedDoc={parsedDoc} flattenedDoc={hit.flattened} />
       <LogsOverviewDegradedFields rawDoc={hit.raw} />
-      <LogsOverviewAIAssistant doc={hit} />
+      {LogsOverviewAIAssistant && <LogsOverviewAIAssistant doc={hit} />}
     </FieldActionsProvider>
   );
 }

src/plugins/unified_doc_viewer/public/components/lazy_doc_viewer_logs_overview.tsx

@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import React from 'react';
+import { EuiDelayRender, EuiSkeletonText } from '@elastic/eui';
+import { dynamic } from '@kbn/shared-ux-utility';
+
+export const UnifiedDocViewerLogsOverview = dynamic(() => import('./doc_viewer_logs_overview'), {
+  fallback: (
+    <EuiDelayRender delay={300}>
+      <EuiSkeletonText />
+    </EuiDelayRender>
+  ),
+});

src/plugins/unified_doc_viewer/public/index.tsx

@@ -29,4 +29,7 @@ export { useEsDocSearch } from './hooks';
 export { UnifiedDocViewer } from './components/lazy_doc_viewer';
 export { UnifiedDocViewerFlyout } from './components/lazy_doc_viewer_flyout';
 
+export type { LogsOverviewProps as UnifiedDocViewerLogsOverviewProps } from './components/doc_viewer_logs_overview/logs_overview';
+export { UnifiedDocViewerLogsOverview } from './components/lazy_doc_viewer_logs_overview';
+
 export const plugin = () => new UnifiedDocViewerPublicPlugin();

src/plugins/unified_doc_viewer/public/plugin.tsx

@@ -17,7 +17,6 @@ import { DataPublicPluginStart } from '@kbn/data-plugin/public';
 import { FieldFormatsStart } from '@kbn/field-formats-plugin/public';
 import { CoreStart } from '@kbn/core/public';
 import { dynamic } from '@kbn/shared-ux-utility';
-import { DiscoverSharedPublicStart } from '@kbn/discover-shared-plugin/public';
 import { FieldsMetadataPublicStart } from '@kbn/fields-metadata-plugin/public';
 import { SharePluginStart } from '@kbn/share-plugin/public';
 import type { UnifiedDocViewerServices } from './types';
@@ -31,9 +30,6 @@ const fallback = (
   </EuiDelayRender>
 );
 
-const LazyDocViewerLogsOverview = dynamic(() => import('./components/doc_viewer_logs_overview'), {
-  fallback,
-});
 const LazyDocViewerLegacyTable = dynamic(() => import('./components/doc_viewer_table/legacy'), {
   fallback,
 });
@@ -50,7 +46,6 @@ export interface UnifiedDocViewerStart {
 
 export interface UnifiedDocViewerStartDeps {
   data: DataPublicPluginStart;
-  discoverShared: DiscoverSharedPublicStart;
   fieldFormats: FieldFormatsStart;
   fieldsMetadata: FieldsMetadataPublicStart;
   share: SharePluginStart;
@@ -62,18 +57,6 @@ export class UnifiedDocViewerPublicPlugin
   private docViewsRegistry = new DocViewsRegistry();
 
   public setup(core: CoreSetup<UnifiedDocViewerStartDeps, UnifiedDocViewerStart>) {
-    this.docViewsRegistry.add({
-      id: 'doc_view_logs_overview',
-      title: i18n.translate('unifiedDocViewer.docViews.logsOverview.title', {
-        defaultMessage: 'Overview',
-      }),
-      order: 0,
-      enabled: false, // Disabled doc view by default, can be programmatically enabled using the DocViewsRegistry.prototype.enableById method.
-      component: (props) => {
-        return <LazyDocViewerLogsOverview {...props} />;
-      },
-    });
-
     this.docViewsRegistry.add({
       id: 'doc_view_table',
       title: i18n.translate('unifiedDocViewer.docViews.table.tableTitle', {
@@ -123,15 +106,14 @@ export class UnifiedDocViewerPublicPlugin
 
   public start(core: CoreStart, deps: UnifiedDocViewerStartDeps) {
     const { analytics, uiSettings } = core;
-    const { data, discoverShared, fieldFormats, fieldsMetadata, share } = deps;
+    const { data, fieldFormats, fieldsMetadata, share } = deps;
     const storage = new Storage(localStorage);
     const unifiedDocViewer = {
       registry: this.docViewsRegistry,
     };
     const services = {
       analytics,
       data,
-      discoverShared,
       fieldFormats,
       fieldsMetadata,
       storage,

src/plugins/unified_doc_viewer/public/types.ts

@@ -11,7 +11,6 @@ export type { UnifiedDocViewerSetup, UnifiedDocViewerStart } from './plugin';
 
 import type { AnalyticsServiceStart } from '@kbn/core-analytics-browser';
 import type { DataPublicPluginStart } from '@kbn/data-plugin/public';
-import type { DiscoverSharedPublicStart } from '@kbn/discover-shared-plugin/public';
 import type { FieldFormatsStart } from '@kbn/field-formats-plugin/public';
 import type { FieldsMetadataPublicStart } from '@kbn/fields-metadata-plugin/public';
 import type { Storage } from '@kbn/kibana-utils-plugin/public';
@@ -22,7 +21,6 @@ import type { UnifiedDocViewerStart } from './plugin';
 export interface UnifiedDocViewerServices {
   analytics: AnalyticsServiceStart;
   data: DataPublicPluginStart;
-  discoverShared: DiscoverSharedPublicStart;
   fieldFormats: FieldFormatsStart;
   fieldsMetadata: FieldsMetadataPublicStart;
   storage: Storage;

test/accessibility/apps/discover.ts

@@ -122,8 +122,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
 
     // adding a11y tests for the new data grid
     it('a11y test on single document view', async () => {
-      await testSubjects.click('docTableExpandToggleColumn');
-      await PageObjects.discover.clickDocViewerTab('doc_view_table');
+      await dataGrid.clickRowToggle();
       await a11y.testAppSnapshot();
     });
 

test/functional/apps/dashboard/group1/url_field_formatter.ts

@@ -25,6 +25,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
   const deployment = getService('deployment');
   const retry = getService('retry');
   const security = getService('security');
+  const dataGrid = getService('dataGrid');
 
   const checkUrl = async (fieldValue: string) => {
     const windowHandlers = await browser.getAllWindowHandles();
@@ -79,16 +80,16 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       await common.setTime({ from, to });
       await common.navigateToApp('discover');
       await discover.selectIndexPattern('logstash-*');
-      await testSubjects.click('docTableExpandToggleColumn');
+      await dataGrid.clickRowToggle();
       await retry.waitForWithTimeout(`${fieldName} is visible`, 30000, async () => {
         return await testSubjects.isDisplayed(`tableDocViewRow-${fieldName}-value`);
       });
       const fieldLink = await find.byCssSelector(
         `[data-test-subj="tableDocViewRow-${fieldName}-value"] a`
       );
       const fieldValue = await fieldLink.getVisibleText();
-      await fieldLink.click();
       await retry.try(async () => {
+        await fieldLink.click();
         await checkUrl(fieldValue);
       });
     });