[Logs UX] Classify logs-data-access and logs-shared as platform plugi…

…ns (elastic#201263) This classifies `@kbn/logs-data-access-plugin`, `@kbn/logs-shared-plugin` and `@kbn/observability-logs-overview` as "platform/shared". --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
JoseLuisGJ · Dec 19, 2024 · ac71b83 · ac71b83
1 parent e8c3c44
commit ac71b83
Show file tree

Hide file tree

Showing 21 changed files with 233 additions and 133 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1997,9 +1997,6 @@ module.exports = {
     },
     {
       files: [
-        // logsShared depends on o11y/private plugins, but platform plugins depend on it
-        'x-pack/plugins/observability_solution/logs_shared/**',
-
         // TODO @kibana/operations
         'scripts/create_observability_rules.js', // is importing "@kbn/observability-alerting-test-data" (observability/private)
         'src/cli_setup/**', // is importing "@kbn/interactive-setup-plugin" (platform/private)

diff --git a/packages/kbn-xstate-utils/kibana.jsonc b/packages/kbn-xstate-utils/kibana.jsonc
@@ -4,6 +4,6 @@
   "owner": [
     "@elastic/obs-ux-logs-team"
   ],
-  "group": "observability",
-  "visibility": "private"
+  "group": "platform",
+  "visibility": "shared"
 }
diff --git a/src/platform/packages/shared/deeplinks/observability/locators/apm.ts b/src/platform/packages/shared/deeplinks/observability/locators/apm.ts
@@ -0,0 +1,18 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { SerializableRecord } from '@kbn/utility-types';
+
+export const TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR = 'TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR';
+
+export interface TransactionDetailsByTraceIdLocatorParams extends SerializableRecord {
+  rangeFrom?: string;
+  rangeTo?: string;
+  traceId: string;
+}
diff --git a/src/platform/packages/shared/deeplinks/observability/locators/index.ts b/src/platform/packages/shared/deeplinks/observability/locators/index.ts
@@ -7,6 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+export * from './apm';
 export * from './dataset_quality';
 export * from './dataset_quality_details';
 export * from './logs_explorer';

diff --git a/x-pack/packages/observability/logs_overview/kibana.jsonc b/x-pack/packages/observability/logs_overview/kibana.jsonc
@@ -4,6 +4,6 @@
   "owner": [
     "@elastic/obs-ux-logs-team"
   ],
-  "group": "observability",
-  "visibility": "private"
+  "group": "platform",
+  "visibility": "shared"
 }
diff --git a/x-pack/plugins/observability_solution/infra/public/plugin.ts b/x-pack/plugins/observability_solution/infra/public/plugin.ts
@@ -19,7 +19,6 @@ import { i18n } from '@kbn/i18n';
 import {
   METRICS_EXPLORER_LOCATOR_ID,
   MetricsExplorerLocatorParams,
-  ObservabilityTriggerId,
 } from '@kbn/observability-shared-plugin/common';
 import {
   BehaviorSubject,
@@ -101,10 +100,6 @@ export class Plugin implements InfraClientPluginClass {
       registerFeatures(pluginsSetup.home);
     }
 
-    pluginsSetup.uiActions.registerTrigger({
-      id: ObservabilityTriggerId.LogEntryContextMenu,
-    });
-
     const assetDetailsLocator =
       pluginsSetup.share.url.locators.get<AssetDetailsLocatorParams>(ASSET_DETAILS_LOCATOR_ID);
     const inventoryLocator =

diff --git a/x-pack/plugins/observability_solution/logs_data_access/kibana.jsonc b/x-pack/plugins/observability_solution/logs_data_access/kibana.jsonc
@@ -1,13 +1,17 @@
 {
   "type": "plugin",
   "id": "@kbn/logs-data-access-plugin",
-  "owner": ["@elastic/obs-ux-logs-team"],
+  "owner": [
+    "@elastic/obs-ux-logs-team"
+  ],
+  "group": "platform",
+  "visibility": "shared",
   "plugin": {
     "id": "logsDataAccess",
     "server": true,
     "browser": true,
     "requiredPlugins": [
-      "data", 
+      "data",
       "dataViews"
     ],
     "optionalPlugins": [],

diff --git a/x-pack/plugins/observability_solution/logs_shared/kibana.jsonc b/x-pack/plugins/observability_solution/logs_shared/kibana.jsonc
@@ -2,29 +2,39 @@
   "type": "plugin",
   "id": "@kbn/logs-shared-plugin",
   "owner": "@elastic/obs-ux-logs-team",
+  "group": "platform",
+  "visibility": "shared",
   "description": "Exposes the shared components and APIs to access and visualize logs.",
   "plugin": {
     "id": "logsShared",
     "server": true,
     "browser": true,
-    "configPath": ["xpack", "logs_shared"],
+    "configPath": [
+      "xpack",
+      "logs_shared"
+    ],
     "requiredPlugins": [
       "charts",
       "data",
       "fieldFormats",
       "dataViews",
       "discoverShared",
       "logsDataAccess",
-      "observabilityShared",
       "share",
       "spaces",
+      "uiActions",
       "usageCollection",
       "embeddable",
     ],
     "optionalPlugins": [
       "observabilityAIAssistant",
     ],
-    "requiredBundles": ["kibanaUtils", "kibanaReact"],
-    "extraPublicDirs": ["common"]
+    "requiredBundles": [
+      "kibanaUtils",
+      "kibanaReact"
+    ],
+    "extraPublicDirs": [
+      "common"
+    ]
   }
 }
diff --git a/...ck/plugins/observability_solution/logs_shared/public/components/log_stream/log_stream.tsx b/...ck/plugins/observability_solution/logs_shared/public/components/log_stream/log_stream.tsx
@@ -10,19 +10,19 @@ import type { DataPublicPluginStart } from '@kbn/data-plugin/public';
 import { buildEsQuery, Filter, Query } from '@kbn/es-query';
 import { euiStyled } from '@kbn/kibana-react-plugin/common';
 import { useKibana } from '@kbn/kibana-react-plugin/public';
+import type { LogsDataAccessPluginStart } from '@kbn/logs-data-access-plugin/public';
 import type { SharePluginStart } from '@kbn/share-plugin/public';
 import { JsonValue } from '@kbn/utility-types';
 import { noop } from 'lodash';
 import React, { useCallback, useEffect, useMemo } from 'react';
 import usePrevious from 'react-use/lib/usePrevious';
-import type { LogsDataAccessPluginStart } from '@kbn/logs-data-access-plugin/public';
-import { useKibanaQuerySettings } from '@kbn/observability-shared-plugin/public';
 import { LogEntryCursor } from '../../../common/log_entry';
 import { defaultLogViewsStaticConfig, LogViewReference } from '../../../common/log_views';
 import { BuiltEsQuery, useLogStream } from '../../containers/logs/log_stream';
 import { useLogView } from '../../hooks/use_log_view';
 import { LogViewsClient } from '../../services/log_views';
 import { LogColumnRenderConfiguration } from '../../utils/log_column_render_configuration';
+import { useKibanaQuerySettings } from '../../utils/use_kibana_query_settings';
 import { useLogEntryFlyout } from '../logging/log_entry_flyout';
 import { ScrollableLogTextStreamView, VisibleInterval } from '../logging/log_text_stream';
 import { LogStreamErrorBoundary } from './log_stream_error_boundary';

diff --git a/...on/logs_shared/public/components/logging/log_entry_flyout/log_entry_actions_menu.test.tsx b/...on/logs_shared/public/components/logging/log_entry_flyout/log_entry_actions_menu.test.tsx
@@ -7,6 +7,8 @@
 
 import { coreMock } from '@kbn/core/public/mocks';
 import {
+  TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR,
+  TransactionDetailsByTraceIdLocatorParams,
   uptimeOverviewLocatorID,
   UptimeOverviewLocatorInfraParams,
   UptimeOverviewLocatorParams,
@@ -26,17 +28,23 @@ coreStartMock.application.getUrlForApp.mockImplementation((app, options) => {
 });
 
 const emptyUrlService = new MockUrlService();
-const urlServiceWithUptimeLocator = new MockUrlService();
+const urlServiceWithMockLocators = new MockUrlService();
 // we can't use the actual locator here because its import would create a
 // forbidden ts project reference cycle
-urlServiceWithUptimeLocator.locators.create<
+urlServiceWithMockLocators.locators.create<
   UptimeOverviewLocatorInfraParams | UptimeOverviewLocatorParams
 >({
   id: uptimeOverviewLocatorID,
   getLocation: async (params) => {
     return { app: 'uptime', path: '/overview', state: {} };
   },
 });
+urlServiceWithMockLocators.locators.create<TransactionDetailsByTraceIdLocatorParams>({
+  id: TRANSACTION_DETAILS_BY_TRACE_ID_LOCATOR,
+  getLocation: async (params) => {
+    return { app: 'apm', path: '/trace-id', state: {} };
+  },
+});
 
 const ProviderWrapper: FC<React.PropsWithChildren<{ urlService?: UrlService }>> = ({
   children,
@@ -90,7 +98,7 @@ describe('LogEntryActionsMenu component', () => {
   describe('uptime link with legacy uptime enabled', () => {
     it('renders as enabled when a host ip is present in the log entry', () => {
       const elementWrapper = mount(
-        <ProviderWrapper urlService={urlServiceWithUptimeLocator}>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [{ field: 'host.ip', value: ['HOST_IP'] }],
@@ -120,7 +128,7 @@ describe('LogEntryActionsMenu component', () => {
 
     it('renders as enabled when a container id is present in the log entry', () => {
       const elementWrapper = mount(
-        <ProviderWrapper urlService={urlServiceWithUptimeLocator}>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [{ field: 'container.id', value: ['CONTAINER_ID'] }],
@@ -150,7 +158,7 @@ describe('LogEntryActionsMenu component', () => {
 
     it('renders as enabled when a pod uid is present in the log entry', () => {
       const elementWrapper = mount(
-        <ProviderWrapper urlService={urlServiceWithUptimeLocator}>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [{ field: 'kubernetes.pod.uid', value: ['POD_UID'] }],
@@ -180,7 +188,7 @@ describe('LogEntryActionsMenu component', () => {
 
     it('renders as disabled when no supported field is present in the log entry', () => {
       const elementWrapper = mount(
-        <ProviderWrapper urlService={urlServiceWithUptimeLocator}>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [],
@@ -215,7 +223,7 @@ describe('LogEntryActionsMenu component', () => {
   describe('apm link', () => {
     it('renders with a trace id filter when present in log entry', () => {
       const elementWrapper = mount(
-        <ProviderWrapper>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [{ field: 'trace.id', value: ['1234567'] }],
@@ -246,7 +254,7 @@ describe('LogEntryActionsMenu component', () => {
     it('renders with a trace id filter and timestamp when present in log entry', () => {
       const timestamp = '2019-06-27T17:44:08.693Z';
       const elementWrapper = mount(
-        <ProviderWrapper>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [
@@ -279,7 +287,7 @@ describe('LogEntryActionsMenu component', () => {
 
     it('renders as disabled when no supported field is present in log entry', () => {
       const elementWrapper = mount(
-        <ProviderWrapper>
+        <ProviderWrapper urlService={urlServiceWithMockLocators}>
           <LogEntryActionsMenu
             logEntry={{
               fields: [],
@@ -303,7 +311,10 @@ describe('LogEntryActionsMenu component', () => {
       elementWrapper.update();
 
       expect(
-        elementWrapper.find(`button${testSubject('~apmLogEntryActionsMenuItem')}`).prop('disabled')
+        elementWrapper
+          .find(`${testSubject('~apmLogEntryActionsMenuItem')}`)
+          .first()
+          .prop('disabled')
       ).toEqual(true);
     });
   });