[8.x] 🌊 Streams: Link to streams in Discover (elastic#214052) (elastic#215469)

flash1293 · web-flow · commit 9494ee808da8 · 2025-03-24T15:57:59.000+02:00
# Backport This will backport the following commits from `main` to `8.x`: - [🌊 Streams: Link to streams in Discover (elastic#214052)](elastic#214052)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)
diff --git a/src/platform/plugins/shared/discover/public/context_awareness/profile_providers/observability/log_document_profile/accessors/get_doc_viewer.tsx b/src/platform/plugins/shared/discover/public/context_awareness/profile_providers/observability/log_document_profile/accessors/get_doc_viewer.tsx
@@ -23,6 +23,8 @@ export const createGetDocViewer =
       'observability-logs-ai-assistant'
     );
 
+    const streamsFeature = services.discoverShared.features.registry.getById('streams');
+
     return {
       ...prevDocViewer,
       docViewsRegistry: (registry) => {
@@ -36,6 +38,7 @@ export const createGetDocViewer =
             <UnifiedDocViewerLogsOverview
               {...props}
               renderAIAssistant={logsAIAssistantFeature?.render}
+              renderStreamsField={streamsFeature?.renderStreamsField}
             />
           ),
         });
diff --git a/src/platform/plugins/shared/discover_shared/public/services/discover_features/types.ts b/src/platform/plugins/shared/discover_shared/public/services/discover_features/types.ts
@@ -22,6 +22,15 @@ import { FeaturesRegistry } from '../../../common';
  * will be shown on the logs-overview preset tab of the UnifiedDocViewer.
  */
 
+export interface StreamsFeatureRenderDeps {
+  doc: DataTableRecord;
+}
+
+export interface StreamsFeature {
+  id: 'streams';
+  renderStreamsField: (deps: StreamsFeatureRenderDeps) => JSX.Element;
+}
+
 export interface ObservabilityLogsAIAssistantFeatureRenderDeps {
   doc: DataTableRecord;
 }
@@ -39,7 +48,10 @@ export interface ObservabilityCreateSLOFeature {
 }
 
 // This should be a union of all the available client features.
-export type DiscoverFeature = ObservabilityLogsAIAssistantFeature | ObservabilityCreateSLOFeature;
+export type DiscoverFeature =
+  | StreamsFeature
+  | ObservabilityLogsAIAssistantFeature
+  | ObservabilityCreateSLOFeature;
 
 /**
  * Service types
diff --git a/src/platform/plugins/shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.tsx b/src/platform/plugins/shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.tsx
@@ -13,6 +13,7 @@ import { getLogDocumentOverview } from '@kbn/discover-utils';
 import { EuiHorizontalRule, EuiSpacer } from '@elastic/eui';
 import { ObservabilityLogsAIAssistantFeatureRenderDeps } from '@kbn/discover-shared-plugin/public';
 import { getStacktraceFields, LogDocument } from '@kbn/discover-utils/src';
+import { StreamsFeatureRenderDeps } from '@kbn/discover-shared-plugin/public/services/discover_features';
 import { LogsOverviewHeader } from './logs_overview_header';
 import { LogsOverviewHighlights } from './logs_overview_highlights';
 import { FieldActionsProvider } from '../../hooks/use_field_actions';
@@ -22,6 +23,7 @@ import { LogsOverviewStacktraceSection } from './logs_overview_stacktrace_sectio
 
 export type LogsOverviewProps = DocViewRenderProps & {
   renderAIAssistant?: (deps: ObservabilityLogsAIAssistantFeatureRenderDeps) => JSX.Element;
+  renderStreamsField?: (deps: StreamsFeatureRenderDeps) => JSX.Element;
 };
 
 export function LogsOverview({
@@ -32,6 +34,7 @@ export function LogsOverview({
   onAddColumn,
   onRemoveColumn,
   renderAIAssistant,
+  renderStreamsField,
 }: LogsOverviewProps) {
   const { fieldFormats } = getUnifiedDocViewerServices();
   const parsedDoc = getLogDocumentOverview(hit, { dataView, fieldFormats });
@@ -49,7 +52,11 @@ export function LogsOverview({
       <EuiSpacer size="m" />
       <LogsOverviewHeader doc={parsedDoc} />
       <EuiHorizontalRule margin="xs" />
-      <LogsOverviewHighlights formattedDoc={parsedDoc} flattenedDoc={hit.flattened} />
+      <LogsOverviewHighlights
+        formattedDoc={parsedDoc}
+        doc={hit}
+        renderStreamsField={renderStreamsField}
+      />
       <LogsOverviewDegradedFields rawDoc={hit.raw} />
       {isStacktraceAvailable && <LogsOverviewStacktraceSection hit={hit} dataView={dataView} />}
       {LogsOverviewAIAssistant && <LogsOverviewAIAssistant doc={hit} />}
diff --git a/src/platform/plugins/shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview_highlights.tsx b/src/platform/plugins/shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview_highlights.tsx
@@ -12,6 +12,7 @@ import { CloudProvider, CloudProviderIcon } from '@kbn/custom-icons';
 import { first } from 'lodash';
 import { i18n } from '@kbn/i18n';
 import { DataTableRecord, LogDocumentOverview, fieldConstants } from '@kbn/discover-utils';
+import { StreamsFeature } from '@kbn/discover-shared-plugin/public/services/discover_features';
 import { HighlightField } from './sub_components/highlight_field';
 import { HighlightSection } from './sub_components/highlight_section';
 import { getUnifiedDocViewerServices } from '../../plugin';
@@ -20,11 +21,14 @@ import { TraceIdHighlightField } from './sub_components/trace_id_highlight_field
 
 export function LogsOverviewHighlights({
   formattedDoc,
-  flattenedDoc,
+  doc,
+  renderStreamsField,
 }: {
   formattedDoc: LogDocumentOverview;
-  flattenedDoc: DataTableRecord['flattened'];
+  doc: DataTableRecord;
+  renderStreamsField?: StreamsFeature['renderStreamsField'];
 }) {
+  const flattenedDoc = doc.flattened;
   const {
     fieldsMetadata: { useFieldsMetadata },
   } = getUnifiedDocViewerServices();
@@ -190,6 +194,7 @@ export function LogsOverviewHighlights({
             {...getHighlightProps(fieldConstants.DATASTREAM_NAMESPACE_FIELD)}
           />
         )}
+        {renderStreamsField && renderStreamsField({ doc })}
         {shouldRenderHighlight(fieldConstants.AGENT_NAME_FIELD) && (
           <HighlightField
             data-test-subj="unifiedDocViewLogsOverviewLogShipper"
diff --git a/x-pack/platform/plugins/shared/streams/server/routes/internal/streams/crud/route.ts b/x-pack/platform/plugins/shared/streams/server/routes/internal/streams/crud/route.ts
@@ -6,7 +6,7 @@
  */
 
 import { SearchTotalHits } from '@elastic/elasticsearch/lib/api/types';
-import { isGroupStreamDefinition } from '@kbn/streams-schema';
+import { StreamDefinition, isGroupStreamDefinition } from '@kbn/streams-schema';
 import { z } from '@kbn/zod';
 import { createServerRoute } from '../../../create_server_route';
 
@@ -67,6 +67,42 @@ export const streamDetailRoute = createServerRoute({
   },
 });
 
+export const resolveIndexRoute = createServerRoute({
+  endpoint: 'GET /internal/streams/_resolve_index',
+  options: {
+    access: 'internal',
+  },
+  security: {
+    authz: {
+      enabled: false,
+      reason:
+        'This API delegates security to the currently logged in user and their Elasticsearch permissions.',
+    },
+  },
+  params: z.object({
+    query: z.object({
+      index: z.string(),
+    }),
+  }),
+  handler: async ({
+    request,
+    params,
+    getScopedClients,
+  }): Promise<{ stream?: StreamDefinition }> => {
+    const { scopedClusterClient, streamsClient } = await getScopedClients({ request });
+    const response = (
+      await scopedClusterClient.asCurrentUser.indices.get({ index: params.query.index })
+    )[params.query.index];
+    const dataStream = response.data_stream;
+    if (!dataStream) {
+      return {};
+    }
+    const stream = await streamsClient.getStream(dataStream);
+    return { stream };
+  },
+});
+
 export const internalCrudRoutes = {
   ...streamDetailRoute,
+  ...resolveIndexRoute,
 };
diff --git a/x-pack/platform/plugins/shared/streams_app/.storybook/get_mock_streams_app_context.tsx b/x-pack/platform/plugins/shared/streams_app/.storybook/get_mock_streams_app_context.tsx
@@ -16,6 +16,7 @@ import type { SavedObjectTaggingPluginStart } from '@kbn/saved-objects-tagging-p
 import { fieldsMetadataPluginPublicMock } from '@kbn/fields-metadata-plugin/public/mocks';
 import { DataStreamsStatsClient } from '@kbn/dataset-quality-plugin/public/services/data_streams_stats/data_streams_stats_client';
 import { LicensingPluginStart } from '@kbn/licensing-plugin/public';
+import { DiscoverSharedPublicStart } from '@kbn/discover-shared-plugin/public';
 import type { StreamsAppKibanaContext } from '../public/hooks/use_kibana';
 import { StreamsTelemetryService } from '../public/telemetry/service';
 
@@ -41,6 +42,7 @@ export function getMockStreamsAppContext(): StreamsAppKibanaContext {
         savedObjectsTagging: {} as unknown as SavedObjectTaggingPluginStart,
         fieldsMetadata: fieldsMetadataPluginPublicMock.createStartContract(),
         licensing: {} as unknown as LicensingPluginStart,
+        discoverShared: {} as unknown as DiscoverSharedPublicStart,
       },
     },
     services: {
diff --git a/x-pack/platform/plugins/shared/streams_app/kibana.jsonc b/x-pack/platform/plugins/shared/streams_app/kibana.jsonc
@@ -13,6 +13,7 @@
       "streams",
       "data",
       "dataViews",
+      "discoverShared",
       "unifiedSearch",
       "share",
       "savedObjectsTagging",
diff --git a/x-pack/platform/plugins/shared/streams_app/public/app_locator.ts b/x-pack/platform/plugins/shared/streams_app/public/app_locator.ts
@@ -0,0 +1,34 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { SerializableRecord } from '@kbn/utility-types';
+import type { LocatorDefinition, LocatorPublic } from '@kbn/share-plugin/public';
+
+export const STREAMS_APP_LOCATOR = 'STREAMS_APP_LOCATOR';
+
+export interface StreamsAppLocatorParams extends SerializableRecord {
+  /**
+   * Optionally set stream ID, if not given it will link to the listing page.
+   */
+  name?: string;
+}
+
+export type StreamsAppLocator = LocatorPublic<StreamsAppLocatorParams>;
+
+export class StreamsAppLocatorDefinition implements LocatorDefinition<StreamsAppLocatorParams> {
+  public readonly id = STREAMS_APP_LOCATOR;
+
+  constructor() {}
+
+  public readonly getLocation = async (params: StreamsAppLocatorParams) => {
+    return {
+      app: 'streams',
+      path: params.name ? `/${params.name}` : '/',
+      state: {},
+    };
+  };
+}
diff --git a/x-pack/platform/plugins/shared/streams_app/public/discover_streams_link/discover_streams_link.tsx b/x-pack/platform/plugins/shared/streams_app/public/discover_streams_link/discover_streams_link.tsx
@@ -0,0 +1,118 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { DataTableRecord } from '@kbn/discover-utils';
+import { StreamsRepositoryClient } from '@kbn/streams-plugin/public/api';
+import { EuiFlexGroup, EuiTitle, EuiBetaBadge, EuiLoadingSpinner, EuiLink } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
+import React, { useMemo } from 'react';
+import { CoreStart } from '@kbn/core/public';
+import { RedirectAppLinks } from '@kbn/shared-ux-link-redirect-app';
+import { useStreamsAppFetch } from '../hooks/use_streams_app_fetch';
+import { StreamsAppLocator } from '../app_locator';
+
+export interface DiscoverStreamsLinkProps {
+  doc: DataTableRecord;
+  streamsRepositoryClient: StreamsRepositoryClient;
+  coreApplication: CoreStart['application'];
+  locator: StreamsAppLocator;
+}
+
+function DiscoverStreamsLink(props: DiscoverStreamsLinkProps) {
+  return (
+    <RedirectAppLinks coreStart={{ application: props.coreApplication }}>
+      <EuiFlexGroup direction="column" gutterSize="xs" responsive={false}>
+        <EuiFlexGroup responsive={false} alignItems="center" gutterSize="xs">
+          <EuiTitle size="xxxs">
+            <span>
+              {i18n.translate('xpack.streams.discoverStreamsLink.title', {
+                defaultMessage: 'Stream',
+              })}
+            </span>
+          </EuiTitle>
+          <EuiBetaBadge
+            size="s"
+            label={i18n.translate('xpack.streams.betaBadgeLabel', {
+              defaultMessage: 'Streams is currently in tech preview',
+            })}
+            color="hollow"
+            iconType="beaker"
+          />
+        </EuiFlexGroup>
+        <EuiFlexGroup
+          responsive={false}
+          alignItems="center"
+          justifyContent="flexStart"
+          gutterSize="xs"
+        >
+          <DiscoverStreamsLinkContent {...props} />
+        </EuiFlexGroup>
+      </EuiFlexGroup>
+    </RedirectAppLinks>
+  );
+}
+
+function getFallbackStreamName(flattenedDoc: Record<string, unknown>) {
+  const wiredStreamName = flattenedDoc['stream.name'];
+  if (wiredStreamName) {
+    return String(wiredStreamName);
+  }
+  const dsnsType = flattenedDoc['data_stream.type'];
+  const dsnsDataset = flattenedDoc['data_stream.dataset'];
+  const dsnsNamespace = flattenedDoc['data_stream.namespace'];
+  if (dsnsType && dsnsDataset && dsnsNamespace) {
+    return `${dsnsType}-${dsnsDataset}-${dsnsNamespace}`;
+  }
+  return undefined;
+}
+
+function DiscoverStreamsLinkContent({
+  streamsRepositoryClient,
+  doc,
+  locator,
+}: DiscoverStreamsLinkProps) {
+  const index = doc.raw._index;
+  const flattenedDoc = doc.flattened;
+  const { value, loading, error } = useStreamsAppFetch(
+    async ({ signal }) => {
+      if (!index) {
+        return getFallbackStreamName(flattenedDoc);
+      }
+      const definition = await streamsRepositoryClient.fetch(
+        'GET /internal/streams/_resolve_index',
+        {
+          signal,
+          params: {
+            query: {
+              index,
+            },
+          },
+        }
+      );
+      return definition?.stream?.name;
+    },
+    [streamsRepositoryClient, index],
+    { disableToastOnError: true }
+  );
+  const params = useMemo(() => ({ name: value }), [value]);
+  const redirectUrl = useMemo(() => locator.getRedirectUrl(params), [locator, params]);
+  const empty = <span>-</span>;
+  if (!index && !value) {
+    return empty;
+  }
+  if (loading) {
+    return <EuiLoadingSpinner size="s" />;
+  }
+  if (error || !value) {
+    return empty;
+  }
+
+  return <EuiLink href={redirectUrl}>{value}</EuiLink>;
+}
+
+// eslint-disable-next-line import/no-default-export
+export default DiscoverStreamsLink;
diff --git a/x-pack/platform/plugins/shared/streams_app/public/discover_streams_link/index.tsx b/x-pack/platform/plugins/shared/streams_app/public/discover_streams_link/index.tsx
@@ -0,0 +1,17 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { StreamsFeatureRenderDeps } from '@kbn/discover-shared-plugin/public/services/discover_features';
+import { dynamic } from '@kbn/shared-ux-utility';
+import React from 'react';
+import { DiscoverStreamsLinkProps } from './discover_streams_link';
+
+export const DiscoverStreamsLink = dynamic(() => import('./discover_streams_link'));
+
+export function createDiscoverStreamsLink(services: Omit<DiscoverStreamsLinkProps, 'doc'>) {
+  return (props: StreamsFeatureRenderDeps) => <DiscoverStreamsLink {...services} {...props} />;
+}
diff --git a/x-pack/platform/plugins/shared/streams_app/public/plugin.tsx b/x-pack/platform/plugins/shared/streams_app/public/plugin.tsx
@@ -19,6 +19,8 @@ import type {
   StreamsApplicationProps,
 } from './types';
 import { StreamsAppServices } from './services/types';
+import { createDiscoverStreamsLink } from './discover_streams_link';
+import { StreamsAppLocatorDefinition } from './app_locator';
 import { StreamsTelemetryService } from './telemetry/service';
 
 const StreamsApplication = dynamic(() =>
@@ -46,6 +48,19 @@ export class StreamsAppPlugin
   }
 
   start(coreStart: CoreStart, pluginsStart: StreamsAppStartDependencies): StreamsAppPublicStart {
+    const locator = new StreamsAppLocatorDefinition();
+    pluginsStart.share.url.locators.create(locator);
+    pluginsStart.streams.status$.subscribe((status) => {
+      if (status.status !== 'enabled') return;
+      pluginsStart.discoverShared.features.registry.register({
+        id: 'streams',
+        renderStreamsField: createDiscoverStreamsLink({
+          streamsRepositoryClient: pluginsStart.streams.streamsRepositoryClient,
+          locator: pluginsStart.share.url.locators.get(locator.id)!,
+          coreApplication: coreStart.application,
+        }),
+      });
+    });
     return {
       createStreamsApplicationComponent: () => {
         return ({ appMountParameters, PageTemplate }: StreamsApplicationProps) => {
diff --git a/x-pack/platform/plugins/shared/streams_app/public/types.ts b/x-pack/platform/plugins/shared/streams_app/public/types.ts
diff --git a/x-pack/platform/plugins/shared/streams_app/tsconfig.json b/x-pack/platform/plugins/shared/streams_app/tsconfig.json
diff --git a/x-pack/test/api_integration/deployment_agnostic/apis/observability/streams/discover.ts b/x-pack/test/api_integration/deployment_agnostic/apis/observability/streams/discover.ts
diff --git a/x-pack/test/api_integration/deployment_agnostic/apis/observability/streams/index.ts b/x-pack/test/api_integration/deployment_agnostic/apis/observability/streams/index.ts
