[8.x] [Inventory] Typing entities (#194431) (#194462)

# Backport This will backport the following commits from `main` to `8.x`: - [[Inventory] Typing entities (#194431)](https://github.com/elastic/kibana/pull/194431)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Cauê Marcondes <55978943+cauemarcondes@users.noreply.github.com>
2025-04-23 09:19:04 -04:00 · 2024-10-01 04:53:17 +10:00 · 2024-10-01 04:53:17 +10:00 · f026cdd57d
commit f026cdd57d
parent ec90e85b1a
6 changed files with 50 additions and 19 deletions
--- a/x-pack/plugins/observability_solution/inventory/common/entities.ts
+++ b/x-pack/plugins/observability_solution/inventory/common/entities.ts
@ -7,6 +7,19 @@
 import * as t from 'io-ts';
 import { ENTITY_LATEST, entitiesAliasPattern } from '@kbn/entities-schema';
 import { isRight } from 'fp-ts/lib/Either';
+import {
+  SERVICE_ENVIRONMENT,
+  SERVICE_NAME,
+  CONTAINER_ID,
+  HOST_NAME,
+} from '@kbn/observability-shared-plugin/common';
+import {
+  ENTITY_DEFINITION_ID,
+  ENTITY_DISPLAY_NAME,
+  ENTITY_ID,
+  ENTITY_LAST_SEEN,
+  ENTITY_TYPE,
+} from './es_fields/entities';

 export const entityTypeRt = t.union([
  t.literal('service'),
@ -57,3 +70,32 @@ export const entityTypesRt = new t.Type<EntityType[], string, unknown>(
  },
  (arr) => arr.join()
 );
+
+interface BaseEntity {
+  [ENTITY_LAST_SEEN]: string;
+  [ENTITY_ID]: string;
+  [ENTITY_TYPE]: EntityType;
+  [ENTITY_DISPLAY_NAME]: string;
+  [ENTITY_DEFINITION_ID]: string;
+}
+
+/**
+ * These types are based on service, host and container from the built in definition.
+ */
+interface ServiceEntity extends BaseEntity {
+  [ENTITY_TYPE]: 'service';
+  [SERVICE_NAME]: string;
+  [SERVICE_ENVIRONMENT]?: string | null;
+}
+
+interface HostEntity extends BaseEntity {
+  [ENTITY_TYPE]: 'host';
+  [HOST_NAME]: string;
+}
+
+interface ContainerEntity extends BaseEntity {
+  [ENTITY_TYPE]: 'container';
+  [CONTAINER_ID]: string;
+}
+
+export type Entity = ServiceEntity | HostEntity | ContainerEntity;
--- a/x-pack/plugins/observability_solution/inventory/public/components/entities_grid/entities_grid.stories.tsx
+++ b/x-pack/plugins/observability_solution/inventory/public/components/entities_grid/entities_grid.stories.tsx
@ -40,7 +40,7 @@ export const Example: Story<{}> = () => {
  );

  return (
-    <EuiFlexGroup>
+    <EuiFlexGroup direction="column">
      <EuiFlexItem grow={false}>
        {`Entity filter: ${selectedEntityType || 'N/A'}`}
        <EuiLink
--- a/x-pack/plugins/observability_solution/inventory/public/components/entities_grid/mock/entities_mock.ts
+++ b/x-pack/plugins/observability_solution/inventory/public/components/entities_grid/mock/entities_mock.ts
@ -9,7 +9,7 @@ import { APIReturnType } from '../../../api';

 type InventoryEntitiesAPIReturnType = APIReturnType<'GET /internal/inventory/entities'>;

-export const entitiesMock: InventoryEntitiesAPIReturnType['entities'] = [
+export const entitiesMock = [
  {
    'entity.lastSeenTimestamp': '2023-08-20T10:50:06.384Z',
    'entity.type': 'host',
@ -3011,4 +3011,4 @@ export const entitiesMock: InventoryEntitiesAPIReturnType['entities'] = [
    'entity.displayName': 'Troy McClure',
    'entity.id': '499',
  },
-];
+] as unknown as InventoryEntitiesAPIReturnType['entities'];
--- a/x-pack/plugins/observability_solution/inventory/server/routes/entities/get_latest_entities.ts
+++ b/x-pack/plugins/observability_solution/inventory/server/routes/entities/get_latest_entities.ts
@ -12,22 +12,10 @@ import {
  ENTITIES_LATEST_ALIAS,
  MAX_NUMBER_OF_ENTITIES,
  type EntityType,
+  Entity,
 } from '../../../common/entities';
-import {
-  ENTITY_DISPLAY_NAME,
-  ENTITY_ID,
-  ENTITY_LAST_SEEN,
-  ENTITY_TYPE,
-} from '../../../common/es_fields/entities';
 import { getEntityDefinitionIdWhereClause, getEntityTypesWhereClause } from './query_helper';

-export interface LatestEntity {
-  [ENTITY_LAST_SEEN]: string;
-  [ENTITY_TYPE]: string;
-  [ENTITY_DISPLAY_NAME]: string;
-  [ENTITY_ID]: string;
-}
-
 export async function getLatestEntities({
  inventoryEsClient,
  sortDirection,
@ -47,8 +35,7 @@ export async function getLatestEntities({
     | ${getEntityDefinitionIdWhereClause()}
     | SORT ${sortField} ${sortDirection}
     | LIMIT ${MAX_NUMBER_OF_ENTITIES}
-     | KEEP ${ENTITY_LAST_SEEN}, ${ENTITY_TYPE}, ${ENTITY_DISPLAY_NAME}, ${ENTITY_ID}
-    `,
+     `,
    filter: {
      bool: {
        filter: [...kqlQuery(kuery)],
@ -56,5 +43,5 @@ export async function getLatestEntities({
    },
  });

-  return esqlResultToPlainObjects<LatestEntity>(latestEntitiesEsqlResponse);
+  return esqlResultToPlainObjects<Entity>(latestEntitiesEsqlResponse);
 }
--- a/x-pack/plugins/observability_solution/observability_shared/common/field_names/elasticsearch.ts
+++ b/x-pack/plugins/observability_solution/observability_shared/common/field_names/elasticsearch.ts
@ -107,6 +107,7 @@ export const LABEL_NAME = 'labels.name';

 export const HOST = 'host';
 export const HOST_HOSTNAME = 'host.hostname';
+export const HOST_NAME = 'host.name';
 export const HOST_OS_PLATFORM = 'host.os.platform';
 export const CONTAINER_ID = 'container.id';
 export const KUBERNETES = 'kubernetes';
--- a/x-pack/plugins/observability_solution/observability_shared/common/index.ts
+++ b/x-pack/plugins/observability_solution/observability_shared/common/index.ts
@ -98,6 +98,7 @@ export {
  LABEL_NAME,
  HOST,
  HOST_HOSTNAME,
+  HOST_NAME,
  HOST_OS_PLATFORM,
  CONTAINER_ID,
  KUBERNETES,