[8.x] feat(rca): display investigations stats (#193069) (#193346)

# Backport This will backport the following commits from `main` to `8.x`: - [feat(rca): display investigations stats (#193069)](#193069)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Kevin Delemme <[email protected]>
elastic · Sep 18, 2024 · d00d65b · d00d65b
1 parent 7823f1c
commit d00d65b
Show file tree

Hide file tree

Showing 12 changed files with 286 additions and 8 deletions.
diff --git a/packages/kbn-investigation-shared/src/rest_specs/get_all_investigation_stats.ts b/packages/kbn-investigation-shared/src/rest_specs/get_all_investigation_stats.ts
@@ -0,0 +1,25 @@
+/*
+ * 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 { z } from '@kbn/zod';
+import { statusSchema } from '../schema';
+
+const getAllInvestigationStatsParamsSchema = z.object({
+  query: z.object({}),
+});
+
+const getAllInvestigationStatsResponseSchema = z.object({
+  count: z.record(statusSchema, z.number()),
+  total: z.number(),
+});
+
+type GetAllInvestigationStatsResponse = z.output<typeof getAllInvestigationStatsResponseSchema>;
+
+export { getAllInvestigationStatsParamsSchema, getAllInvestigationStatsResponseSchema };
+export type { GetAllInvestigationStatsResponse };
diff --git a/packages/kbn-investigation-shared/src/rest_specs/index.ts b/packages/kbn-investigation-shared/src/rest_specs/index.ts
@@ -17,6 +17,7 @@ export type * from './find';
 export type * from './get';
 export type * from './get_items';
 export type * from './get_notes';
+export type * from './get_all_investigation_stats';
 export type * from './get_all_investigation_tags';
 export type * from './investigation';
 export type * from './investigation_item';
@@ -35,6 +36,7 @@ export * from './find';
 export * from './get';
 export * from './get_items';
 export * from './get_notes';
+export * from './get_all_investigation_stats';
 export * from './get_all_investigation_tags';
 export * from './investigation';
 export * from './investigation_item';

diff --git a/packages/kbn-investigation-shared/src/schema/index.ts b/packages/kbn-investigation-shared/src/schema/index.ts
@@ -11,3 +11,5 @@ export * from './investigation';
 export * from './investigation_item';
 export * from './investigation_note';
 export * from './origin';
+
+export type * from './investigation';
diff --git a/packages/kbn-investigation-shared/src/schema/investigation.ts b/packages/kbn-investigation-shared/src/schema/investigation.ts
@@ -36,4 +36,7 @@ const investigationSchema = z.object({
   items: z.array(investigationItemSchema),
 });
 
+type Status = z.infer<typeof statusSchema>;
+
+export type { Status };
 export { investigationSchema, statusSchema };
diff --git a/x-pack/plugins/observability_solution/investigate_app/public/hooks/query_key_factory.ts b/x-pack/plugins/observability_solution/investigate_app/public/hooks/query_key_factory.ts
@@ -12,6 +12,7 @@ export const investigationKeys = {
   userProfiles: (profileIds: Set<string>) =>
     [...investigationKeys.all, 'userProfiles', ...profileIds] as const,
   tags: () => [...investigationKeys.all, 'tags'] as const,
+  stats: () => [...investigationKeys.all, 'stats'] as const,
   lists: () => [...investigationKeys.all, 'list'] as const,
   list: (params: { page: number; perPage: number; search?: string; filter?: string }) =>
     [...investigationKeys.lists(), params] as const,

diff --git a/.../observability_solution/investigate_app/public/hooks/use_fetch_all_investigation_stats.ts b/.../observability_solution/investigate_app/public/hooks/use_fetch_all_investigation_stats.ts
@@ -0,0 +1,73 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+import type { GetAllInvestigationStatsResponse, Status } from '@kbn/investigation-shared';
+import { useQuery } from '@tanstack/react-query';
+import { investigationKeys } from './query_key_factory';
+import { useKibana } from './use_kibana';
+
+export interface Response {
+  isInitialLoading: boolean;
+  isLoading: boolean;
+  isRefetching: boolean;
+  isSuccess: boolean;
+  isError: boolean;
+  data: { count: Record<Status, number>; total: number } | undefined;
+}
+
+export function useFetchAllInvestigationStats(): Response {
+  const {
+    core: {
+      http,
+      notifications: { toasts },
+    },
+  } = useKibana();
+
+  const { isInitialLoading, isLoading, isError, isSuccess, isRefetching, data } = useQuery({
+    queryKey: investigationKeys.stats(),
+    queryFn: async ({ signal }) => {
+      const response = await http.get<GetAllInvestigationStatsResponse>(
+        `/api/observability/investigations/_stats`,
+        {
+          version: '2023-10-31',
+          signal,
+        }
+      );
+
+      return {
+        count: {
+          triage: response.count.triage ?? 0,
+          active: response.count.active ?? 0,
+          mitigated: response.count.mitigated ?? 0,
+          resolved: response.count.resolved ?? 0,
+          cancelled: response.count.cancelled ?? 0,
+        },
+        total: response.total ?? 0,
+      };
+    },
+    retry: false,
+    cacheTime: 600 * 1000, // 10 minutes
+    staleTime: 0,
+    onError: (error: Error) => {
+      toasts.addError(error, {
+        title: i18n.translate('xpack.investigateApp.useFetchAllInvestigationStats.errorTitle', {
+          defaultMessage: 'Something went wrong while fetching the investigation stats',
+        }),
+      });
+    },
+  });
+
+  return {
+    data,
+    isInitialLoading,
+    isLoading,
+    isRefetching,
+    isSuccess,
+    isError,
+  };
+}
diff --git a/...bservability_solution/investigate_app/public/pages/list/components/investigation_list.tsx b/...bservability_solution/investigate_app/public/pages/list/components/investigation_list.tsx
@@ -11,6 +11,7 @@ import {
   EuiBasicTable,
   EuiBasicTableColumn,
   EuiFlexGroup,
+  EuiFlexItem,
   EuiLink,
   EuiLoadingSpinner,
   EuiText,
@@ -25,6 +26,7 @@ import { useFetchInvestigationList } from '../../../hooks/use_fetch_investigatio
 import { useFetchUserProfiles } from '../../../hooks/use_fetch_user_profiles';
 import { useKibana } from '../../../hooks/use_kibana';
 import { InvestigationListActions } from './investigation_list_actions';
+import { InvestigationStats } from './investigation_stats';
 import { InvestigationsError } from './investigations_error';
 import { SearchBar } from './search_bar/search_bar';
 
@@ -109,11 +111,15 @@ export function InvestigationList() {
         defaultMessage: 'Tags',
       }),
       render: (value: InvestigationResponse['tags']) => {
-        return value.map((tag) => (
-          <EuiBadge color={'hollow'} key="tag">
-            {tag}
-          </EuiBadge>
-        ));
+        return (
+          <EuiFlexGroup wrap gutterSize="xs">
+            {value.map((tag) => (
+              <EuiFlexItem key={tag} grow={false}>
+                <EuiBadge color="hollow">{tag}</EuiBadge>
+              </EuiFlexItem>
+            ))}
+          </EuiFlexGroup>
+        );
       },
     },
     {
@@ -180,6 +186,7 @@ export function InvestigationList() {
 
   return (
     <EuiFlexGroup direction="column" gutterSize="l">
+      <InvestigationStats />
       <SearchBar
         isLoading={isLoading}
         onSearch={(value) => setSearch(value)}

diff --git a/...servability_solution/investigate_app/public/pages/list/components/investigation_stats.tsx b/...servability_solution/investigate_app/public/pages/list/components/investigation_stats.tsx
@@ -0,0 +1,83 @@
+/*
+ * 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 numeral from '@elastic/numeral';
+import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiStat } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
+import React from 'react';
+import { useFetchAllInvestigationStats } from '../../../hooks/use_fetch_all_investigation_stats';
+import { useKibana } from '../../../hooks/use_kibana';
+
+export function InvestigationStats() {
+  const {
+    core: { uiSettings },
+  } = useKibana();
+  const { data, isLoading: isStatsLoading } = useFetchAllInvestigationStats();
+  const numberFormat = uiSettings.get('format:number:defaultPattern');
+
+  return (
+    <EuiPanel hasBorder={true}>
+      <EuiFlexGroup>
+        <EuiFlexItem>
+          <EuiStat
+            title={numeral(data?.count.triage).format(numberFormat)}
+            description={i18n.translate(
+              'xpack.investigateApp.investigationList.stats.triageLabel',
+              { defaultMessage: 'Triage' }
+            )}
+            titleSize="s"
+            isLoading={isStatsLoading}
+          />
+        </EuiFlexItem>
+        <EuiFlexItem>
+          <EuiStat
+            title={numeral(data?.count.active).format(numberFormat)}
+            description={i18n.translate(
+              'xpack.investigateApp.investigationList.stats.activeLabel',
+              { defaultMessage: 'Active' }
+            )}
+            titleSize="s"
+            isLoading={isStatsLoading}
+          />
+        </EuiFlexItem>
+        <EuiFlexItem>
+          <EuiStat
+            title={numeral(data?.count.cancelled).format(numberFormat)}
+            description={i18n.translate(
+              'xpack.investigateApp.investigationList.stats.cancelledLabel',
+              { defaultMessage: 'Cancelled' }
+            )}
+            titleSize="s"
+            isLoading={isStatsLoading}
+          />
+        </EuiFlexItem>
+        <EuiFlexItem>
+          <EuiStat
+            title={numeral(data?.count.mitigated).format(numberFormat)}
+            description={i18n.translate(
+              'xpack.investigateApp.investigationList.stats.mitigatedLabel',
+              { defaultMessage: 'Mitigated' }
+            )}
+            titleSize="s"
+            isLoading={isStatsLoading}
+          />
+        </EuiFlexItem>
+        <EuiFlexItem>
+          <EuiStat
+            title={numeral(data?.count.resolved).format(numberFormat)}
+            description={i18n.translate(
+              'xpack.investigateApp.investigationList.stats.resolvedLabel',
+              { defaultMessage: 'Resolved' }
+            )}
+            titleSize="s"
+            isLoading={isStatsLoading}
+          />
+        </EuiFlexItem>
+      </EuiFlexGroup>
+    </EuiPanel>
+  );
+}
diff --git a/...ution/investigate_app/server/routes/get_global_investigate_app_server_route_repository.ts b/...ution/investigate_app/server/routes/get_global_investigate_app_server_route_repository.ts
@@ -13,6 +13,7 @@ import {
   deleteInvestigationNoteParamsSchema,
   deleteInvestigationParamsSchema,
   findInvestigationsParamsSchema,
+  getAllInvestigationStatsParamsSchema,
   getAllInvestigationTagsParamsSchema,
   getInvestigationItemsParamsSchema,
   getInvestigationNotesParamsSchema,
@@ -37,6 +38,7 @@ import { updateInvestigation } from '../services/update_investigation';
 import { updateInvestigationItem } from '../services/update_investigation_item';
 import { updateInvestigationNote } from '../services/update_investigation_note';
 import { createInvestigateAppServerRoute } from './create_investigate_app_server_route';
+import { getAllInvestigationStats } from '../services/get_all_investigation_stats';
 
 const createInvestigationRoute = createInvestigateAppServerRoute({
   endpoint: 'POST /api/observability/investigations 2023-10-31',
@@ -154,6 +156,20 @@ const getAllInvestigationTagsRoute = createInvestigateAppServerRoute({
   },
 });
 
+const getAllInvestigationStatsRoute = createInvestigateAppServerRoute({
+  endpoint: 'GET /api/observability/investigations/_stats 2023-10-31',
+  options: {
+    tags: [],
+  },
+  params: getAllInvestigationStatsParamsSchema,
+  handler: async ({ params, context, request, logger }) => {
+    const soClient = (await context.core).savedObjects.client;
+    const repository = investigationRepositoryFactory({ soClient, logger });
+
+    return await getAllInvestigationStats(repository);
+  },
+});
+
 const getInvestigationNotesRoute = createInvestigateAppServerRoute({
   endpoint: 'GET /api/observability/investigations/{investigationId}/notes 2023-10-31',
   options: {
@@ -312,6 +328,7 @@ export function getGlobalInvestigateAppServerRouteRepository() {
     ...deleteInvestigationItemRoute,
     ...updateInvestigationItemRoute,
     ...getInvestigationItemsRoute,
+    ...getAllInvestigationStatsRoute,
     ...getAllInvestigationTagsRoute,
   };
 }

diff --git a/...ins/observability_solution/investigate_app/server/services/get_all_investigation_stats.ts b/...ins/observability_solution/investigate_app/server/services/get_all_investigation_stats.ts
@@ -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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import {
+  GetAllInvestigationStatsResponse,
+  getAllInvestigationStatsResponseSchema,
+} from '@kbn/investigation-shared';
+import { InvestigationRepository } from './investigation_repository';
+
+export async function getAllInvestigationStats(
+  repository: InvestigationRepository
+): Promise<GetAllInvestigationStatsResponse> {
+  const stats = await repository.getStats();
+  return getAllInvestigationStatsResponseSchema.parse(stats);
+}