[8.x] [ECO][Infra] Add callout for ingesting metrics data in Host and…

… Container views (#195378) (#196158) # Backport This will backport the following commits from `main` to `8.x`: - [[ECO][Infra] Add callout for ingesting metrics data in Host and Container views (#195378)](#195378)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Irene Blanco <[email protected]>
elastic · Oct 16, 2024 · e6392b2 · e6392b2
1 parent d216933
commit e6392b2
Show file tree

Hide file tree

Showing 38 changed files with 1,508 additions and 226 deletions.
diff --git a/.buildkite/scripts/steps/storybooks/build_and_upload.ts b/.buildkite/scripts/steps/storybooks/build_and_upload.ts
@@ -43,6 +43,7 @@ const STORYBOOKS = [
   'lists',
   'observability',
   'observability_ai_assistant',
+  'observability_shared',
   'presentation',
   'security_solution',
   'security_solution_packages',

diff --git a/src/dev/storybook/aliases.ts b/src/dev/storybook/aliases.ts
@@ -56,6 +56,7 @@ export const storybookAliases = {
     'x-pack/plugins/observability_solution/observability_ai_assistant/.storybook',
   observability_ai_assistant_app:
     'x-pack/plugins/observability_solution/observability_ai_assistant_app/.storybook',
+  observability_shared: 'x-pack/plugins/observability_solution/observability_shared/.storybook',
   observability_slo: 'x-pack/plugins/observability_solution/slo/.storybook',
   presentation: 'src/plugins/presentation_util/storybook',
   random_sampling: 'x-pack/packages/kbn-random-sampling/.storybook',

diff --git a/...vability_solution/apm/public/components/app/service_overview/service_overview.stories.tsx b/...vability_solution/apm/public/components/app/service_overview/service_overview.stories.tsx
@@ -7,12 +7,12 @@
 
 import { Meta, Story } from '@storybook/react';
 import React from 'react';
+import { EntityDataStreamType } from '@kbn/observability-shared-plugin/common';
 import { ServiceOverview } from '.';
 import { MockApmPluginStorybook } from '../../../context/apm_plugin/mock_apm_plugin_storybook';
 import { APMServiceContextValue } from '../../../context/apm_service/apm_service_context';
 import { FETCH_STATUS } from '../../../hooks/use_fetcher';
 import { mockApmApiCallResponse } from '../../../services/rest/call_apm_api_spy';
-import { EntityDataStreamType } from '../../../../common/entities/types';
 
 const stories: Meta<{}> = {
   title: 'app/ServiceOverview',

diff --git a/x-pack/plugins/observability_solution/apm/public/utils/get_signal_type.ts b/x-pack/plugins/observability_solution/apm/public/utils/get_signal_type.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { EntityDataStreamType } from '../../common/entities/types';
+import { EntityDataStreamType } from '@kbn/observability-shared-plugin/common';
 
 export function isApmSignal(dataStreamTypes: EntityDataStreamType[]) {
   return (

diff --git a/x-pack/plugins/observability_solution/apm/server/routes/entities/utils/merge_entities.ts b/x-pack/plugins/observability_solution/apm/server/routes/entities/utils/merge_entities.ts
@@ -6,9 +6,9 @@
  */
 
 import { compact, uniq } from 'lodash';
+import { EntityDataStreamType } from '@kbn/observability-shared-plugin/common';
 import type { EntityLatestServiceRaw } from '../types';
 import type { AgentName } from '../../../../typings/es_schemas/ui/fields/agent';
-import type { EntityDataStreamType } from '../../../../common/entities/types';
 
 export interface MergedServiceEntity {
   serviceName: string;

diff --git a/...rvability_solution/infra/public/components/asset_details/add_metrics_callout/constants.ts b/...rvability_solution/infra/public/components/asset_details/add_metrics_callout/constants.ts
@@ -0,0 +1,111 @@
+/*
+ * 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 { ObservabilityOnboardingLocatorParams } from '@kbn/deeplinks-observability';
+import { i18n } from '@kbn/i18n';
+import { AddDataPanelProps } from '@kbn/observability-shared-plugin/public';
+import { LocatorPublic } from '@kbn/share-plugin/common';
+import { OnboardingFlow } from '../../shared/templates/no_data_config';
+
+export type AddMetricsCalloutKey =
+  | 'hostOverview'
+  | 'hostMetrics'
+  | 'hostProcesses'
+  | 'containerOverview'
+  | 'containerMetrics';
+
+const defaultPrimaryActionLabel = i18n.translate(
+  'xpack.infra.addDataCallout.hostOverviewPrimaryActionLabel',
+  {
+    defaultMessage: 'Add Metrics',
+  }
+);
+
+const defaultContent = {
+  content: {
+    title: i18n.translate('xpack.infra.addDataCallout.defaultTitle', {
+      defaultMessage: 'View core metrics to understand your host performance',
+    }),
+    content: i18n.translate('xpack.infra.addDataCallout.defaultContent', {
+      defaultMessage:
+        'Collect metrics such as CPU and memory usage to identify performance bottlenecks that could be affecting your users.',
+    }),
+  },
+};
+
+const hostDefaultActions = (
+  locator: LocatorPublic<ObservabilityOnboardingLocatorParams> | undefined
+) => {
+  return {
+    actions: {
+      primary: {
+        href: locator?.getRedirectUrl({ category: OnboardingFlow.Hosts }),
+        label: defaultPrimaryActionLabel,
+      },
+      secondary: {
+        href: 'https://ela.st/demo-cluster-hosts',
+      },
+      link: {
+        href: 'https://ela.st/docs-hosts-add-metrics',
+      },
+    },
+  };
+};
+
+const containerDefaultActions = (
+  locator: LocatorPublic<ObservabilityOnboardingLocatorParams> | undefined
+) => {
+  return {
+    actions: {
+      primary: {
+        href: locator?.getRedirectUrl({ category: OnboardingFlow.Infra }),
+        label: defaultPrimaryActionLabel,
+      },
+      link: {
+        href: 'https://ela.st/docs-containers-add-metrics',
+      },
+    },
+  };
+};
+
+export const addMetricsCalloutDefinitions = (
+  locator: LocatorPublic<ObservabilityOnboardingLocatorParams> | undefined
+): Record<
+  AddMetricsCalloutKey,
+  Omit<AddDataPanelProps, 'onDismiss' | 'onAddData' | 'onLearnMore' | 'onTryIt'>
+> => {
+  return {
+    hostOverview: {
+      ...defaultContent,
+      ...hostDefaultActions(locator),
+    },
+    hostMetrics: {
+      ...defaultContent,
+      ...hostDefaultActions(locator),
+    },
+    hostProcesses: {
+      content: {
+        title: i18n.translate('xpack.infra.addDataCallout.hostProcessesTitle', {
+          defaultMessage: 'View host processes to identify performance bottlenecks',
+        }),
+        content: i18n.translate('xpack.infra.addDataCallout.hostProcessesContent', {
+          defaultMessage:
+            'Collect process data to understand what is consuming resource on your hosts.',
+        }),
+      },
+      ...hostDefaultActions(locator),
+    },
+    containerOverview: {
+      ...defaultContent,
+      ...containerDefaultActions(locator),
+    },
+    containerMetrics: {
+      ...defaultContent,
+      ...containerDefaultActions(locator),
+    },
+  };
+};
diff --git a/...bservability_solution/infra/public/components/asset_details/add_metrics_callout/index.tsx b/...bservability_solution/infra/public/components/asset_details/add_metrics_callout/index.tsx
@@ -0,0 +1,62 @@
+/*
+ * 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 React from 'react';
+import { AddDataPanel } from '@kbn/observability-shared-plugin/public';
+import {
+  OBSERVABILITY_ONBOARDING_LOCATOR,
+  ObservabilityOnboardingLocatorParams,
+} from '@kbn/deeplinks-observability';
+import { AddMetricsCalloutEventParams } from '../../../services/telemetry';
+import { addMetricsCalloutDefinitions, AddMetricsCalloutKey } from './constants';
+import { useKibanaContextForPlugin } from '../../../hooks/use_kibana';
+
+export interface AddMetricsCalloutProps {
+  id: AddMetricsCalloutKey;
+  onDismiss?: () => void;
+}
+
+const defaultEventParams: AddMetricsCalloutEventParams = { view: 'add_metrics_cta' };
+
+export function AddMetricsCallout({ id, onDismiss }: AddMetricsCalloutProps) {
+  const {
+    services: { telemetry, share },
+  } = useKibanaContextForPlugin();
+
+  const onboardingLocator = share.url.locators.get<ObservabilityOnboardingLocatorParams>(
+    OBSERVABILITY_ONBOARDING_LOCATOR
+  );
+
+  function handleAddMetricsClick() {
+    telemetry.reportAddMetricsCalloutAddMetricsClicked(defaultEventParams);
+  }
+
+  function handleTryItClick() {
+    telemetry.reportAddMetricsCalloutTryItClicked(defaultEventParams);
+  }
+
+  function handleLearnMoreClick() {
+    telemetry.reportAddMetricsCalloutLearnMoreClicked(defaultEventParams);
+  }
+
+  function handleDismiss() {
+    telemetry.reportAddMetricsCalloutDismissed(defaultEventParams);
+    onDismiss?.();
+  }
+
+  return (
+    <AddDataPanel
+      data-test-subj="infraAddMetricsCallout"
+      content={addMetricsCalloutDefinitions(onboardingLocator)[id].content}
+      actions={addMetricsCalloutDefinitions(onboardingLocator)[id].actions}
+      onAddData={handleAddMetricsClick}
+      onTryIt={handleTryItClick}
+      onLearnMore={handleLearnMoreClick}
+      onDissmiss={onDismiss && handleDismiss}
+    />
+  );
+}
diff --git a/.../observability_solution/infra/public/components/asset_details/hooks/use_entity_summary.ts b/.../observability_solution/infra/public/components/asset_details/hooks/use_entity_summary.ts
@@ -0,0 +1,49 @@
+/*
+ * 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 * as z from '@kbn/zod';
+import { EntityDataStreamType, EntityType } from '@kbn/observability-shared-plugin/common';
+import { useFetcher } from '../../../hooks/use_fetcher';
+
+const EntityTypeSchema = z.union([z.literal(EntityType.HOST), z.literal(EntityType.CONTAINER)]);
+const EntityDataStreamSchema = z.union([
+  z.literal(EntityDataStreamType.METRICS),
+  z.literal(EntityDataStreamType.LOGS),
+]);
+
+const EntitySummarySchema = z.object({
+  entityType: EntityTypeSchema,
+  entityId: z.string(),
+  sourceDataStreams: z.array(EntityDataStreamSchema),
+});
+
+export type EntitySummary = z.infer<typeof EntitySummarySchema>;
+
+export function useEntitySummary({
+  entityType,
+  entityId,
+}: {
+  entityType: string;
+  entityId: string;
+}) {
+  const { data, status } = useFetcher(
+    async (callApi) => {
+      if (!entityType || !entityId) {
+        return undefined;
+      }
+
+      const response = await callApi(`/api/infra/entities/${entityType}/${entityId}/summary`, {
+        method: 'GET',
+      });
+
+      return EntitySummarySchema.parse(response);
+    },
+    [entityType, entityId]
+  );
+
+  return { dataStreams: data?.sourceDataStreams ?? [], status };
+}