[8.x] [Inventory][ECO] Entities table (#193272) (#193327)

# Backport This will backport the following commits from `main` to `8.x`: - [[Inventory][ECO] Entities table (#193272)](#193272)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Cauê Marcondes <55978943+cauemarcondes@users.noreply.github.com>
elastic · Sep 18, 2024 · b5e09d1 · b5e09d1
1 parent aea6345
commit b5e09d1
Show file tree

Hide file tree

Showing 13 changed files with 3,501 additions and 77 deletions.
diff --git a/...ck/packages/observability/observability_utils/es/client/create_observability_es_client.ts b/...ck/packages/observability/observability_utils/es/client/create_observability_es_client.ts
@@ -6,8 +6,9 @@
  */
 
 import type { ElasticsearchClient, Logger } from '@kbn/core/server';
-import type { ESSearchRequest, InferSearchResponseOf } from '@kbn/es-types';
+import type { ESQLSearchResponse, ESSearchRequest, InferSearchResponseOf } from '@kbn/es-types';
 import { withSpan } from '@kbn/apm-utils';
+import type { EsqlQueryRequest } from '@elastic/elasticsearch/lib/api/types';
 
 type SearchRequest = ESSearchRequest & {
   index: string | string[];
@@ -24,6 +25,7 @@ export interface ObservabilityElasticsearchClient {
     operationName: string,
     parameters: TSearchRequest
   ): Promise<InferSearchResponseOf<TDocument, TSearchRequest>>;
+  esql(operationName: string, parameters: EsqlQueryRequest): Promise<ESQLSearchResponse>;
   client: ElasticsearchClient;
 }
 
@@ -38,6 +40,26 @@ export function createObservabilityEsClient({
 }): ObservabilityElasticsearchClient {
   return {
     client,
+    esql(operationName: string, parameters: EsqlQueryRequest) {
+      logger.trace(() => `Request (${operationName}):\n${JSON.stringify(parameters, null, 2)}`);
+      return withSpan({ name: operationName, labels: { plugin } }, () => {
+        return client.esql.query(
+          { ...parameters },
+          {
+            querystring: {
+              drop_null_columns: true,
+            },
+          }
+        );
+      })
+        .then((response) => {
+          logger.trace(() => `Response (${operationName}):\n${JSON.stringify(response, null, 2)}`);
+          return response as unknown as ESQLSearchResponse;
+        })
+        .catch((error) => {
+          throw error;
+        });
+    },
     search<TDocument = unknown, TSearchRequest extends SearchRequest = SearchRequest>(
       operationName: string,
       parameters: SearchRequest

diff --git a/x-pack/packages/observability/observability_utils/es/utils/esql_result_to_plain_objects.ts b/x-pack/packages/observability/observability_utils/es/utils/esql_result_to_plain_objects.ts
@@ -0,0 +1,20 @@
+/*
+ * 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 { ESQLSearchResponse } from '@kbn/es-types';
+
+export function esqlResultToPlainObjects<T extends Record<string, any>>(
+  result: ESQLSearchResponse
+): T[] {
+  return result.values.map((row) => {
+    return row.reduce<Record<string, unknown>>((acc, value, index) => {
+      const column = result.columns[index];
+      acc[column.name] = value;
+      return acc;
+    }, {});
+  }) as T[];
+}
diff --git a/x-pack/plugins/observability_solution/inventory/common/entities.ts b/x-pack/plugins/observability_solution/inventory/common/entities.ts
@@ -4,23 +4,14 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
+import * as t from 'io-ts';
 
-export interface LatestEntity {
-  agent: {
-    name: string[];
-  };
-  data_stream: {
-    type: string[];
-  };
-  cloud: {
-    availability_zone: string[];
-  };
-  entity: {
-    firstSeenTimestamp: string;
-    lastSeenTimestamp: string;
-    type: string;
-    displayName: string;
-    id: string;
-    identityFields: string[];
-  };
-}
+export const entityTypeRt = t.union([
+  t.literal('service'),
+  t.literal('host'),
+  t.literal('container'),
+]);
+
+export type EntityType = t.TypeOf<typeof entityTypeRt>;
+
+export const MAX_NUMBER_OF_ENTITIES = 500;
diff --git a/x-pack/plugins/observability_solution/inventory/common/es_fields/entities.ts b/x-pack/plugins/observability_solution/inventory/common/es_fields/entities.ts
@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export const ENTITY_LAST_SEEN = 'entity.lastSeenTimestamp';
+export const ENTITY_ID = 'entity.id';
+export const ENTITY_TYPE = 'entity.type';
+export const ENTITY_DISPLAY_NAME = 'entity.displayName';
+export const ENTITY_DEFINITION_ID = 'entity.definitionId';
diff --git a/...bservability_solution/inventory/public/components/entities_grid/entities_grid.stories.tsx b/...bservability_solution/inventory/public/components/entities_grid/entities_grid.stories.tsx
@@ -0,0 +1,65 @@
+/*
+ * 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 { EuiDataGridSorting } from '@elastic/eui';
+import { Meta, Story } from '@storybook/react';
+import React, { useMemo, useState } from 'react';
+import { orderBy } from 'lodash';
+import { EntitiesGrid } from '.';
+import { ENTITY_LAST_SEEN } from '../../../common/es_fields/entities';
+import { entitiesMock } from './mock/entities_mock';
+
+const stories: Meta<{}> = {
+  title: 'app/inventory/entities_grid',
+  component: EntitiesGrid,
+};
+export default stories;
+
+export const Example: Story<{}> = () => {
+  const [pageIndex, setPageIndex] = useState(0);
+  const [sort, setSort] = useState<EuiDataGridSorting['columns'][0]>({
+    id: ENTITY_LAST_SEEN,
+    direction: 'desc',
+  });
+
+  const sortedItems = useMemo(
+    () => orderBy(entitiesMock, sort.id, sort.direction),
+    [sort.direction, sort.id]
+  );
+
+  return (
+    <EntitiesGrid
+      entities={sortedItems}
+      loading={false}
+      sortDirection={sort.direction}
+      sortField={sort.id}
+      onChangePage={setPageIndex}
+      onChangeSort={setSort}
+      pageIndex={pageIndex}
+    />
+  );
+};
+
+export const EmptyGridExample: Story<{}> = () => {
+  const [pageIndex, setPageIndex] = useState(0);
+  const [sort, setSort] = useState<EuiDataGridSorting['columns'][0]>({
+    id: ENTITY_LAST_SEEN,
+    direction: 'desc',
+  });
+
+  return (
+    <EntitiesGrid
+      entities={[]}
+      loading={false}
+      sortDirection={sort.direction}
+      sortField={sort.id}
+      onChangePage={setPageIndex}
+      onChangeSort={setSort}
+      pageIndex={pageIndex}
+    />
+  );
+};