[ECO][Inventory] Redirect ECS k8s entities to dashboards (elastic#197222

) closes [elastic#196142](elastic#196142) ## Summary Links kubernetes ECS entities to their corresponding dashboards > [!IMPORTANT] > ECS `replicaset` doesn't have a dedicated dashboard. `container` will be handled in a separate ticket > Semconv won't link to any dashboard/page <img width="800" alt="image" src="https://github.com/user-attachments/assets/711dbd28-f0ef-4af0-a658-afe7f1595697"> ![redirect](https://github.com/user-attachments/assets/77d5d2e1-7ec4-40cd-b7d8-419e07e6b760) ### How to test - While elastic#196916 is not merged, change `ENTITIES_LATEST_ALIAS` constant to `'.entities.v1.latest*'` - Start a local kibana and es instances - Run ` node scripts/synthtrace k8s_entities.ts --live --clean ` - Run `PUT kbn:/internal/entities/managed/enablement` on the devtools - Install the kubernetes integration package to have the dashboards installed. - Navigate to `Inventory` and click through the k8s entities --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
rshen91 · Nov 4, 2024 · 8145cb7 · 8145cb7
1 parent b12e7d0
commit 8145cb7
Show file tree

Hide file tree

Showing 28 changed files with 715 additions and 369 deletions.
diff --git a/packages/kbn-apm-synthtrace-client/src/lib/entities/kubernetes/index.ts b/packages/kbn-apm-synthtrace-client/src/lib/entities/kubernetes/index.ts
@@ -55,9 +55,9 @@ export class K8sEntity extends Serializable<EntityFields> {
     super({
       ...fields,
       'entity.type': entityTypeWithSchema,
-      'entity.definitionId': `builtin_${entityTypeWithSchema}`,
-      'entity.identityFields': identityFields,
-      'entity.displayName': getDisplayName({ identityFields, fields }),
+      'entity.definition_id': `builtin_${entityTypeWithSchema}`,
+      'entity.identity_fields': identityFields,
+      'entity.display_name': getDisplayName({ identityFields, fields }),
     });
   }
 }

diff --git a/.../packages/observability/observability_utils/es/utils/esql_result_to_plain_objects.test.ts b/.../packages/observability/observability_utils/es/utils/esql_result_to_plain_objects.test.ts
@@ -0,0 +1,66 @@
+/*
+ * 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';
+import { esqlResultToPlainObjects } from './esql_result_to_plain_objects';
+
+describe('esqlResultToPlainObjects', () => {
+  it('should return an empty array for an empty result', () => {
+    const result: ESQLSearchResponse = {
+      columns: [],
+      values: [],
+    };
+    const output = esqlResultToPlainObjects(result);
+    expect(output).toEqual([]);
+  });
+
+  it('should return plain objects', () => {
+    const result: ESQLSearchResponse = {
+      columns: [{ name: 'name', type: 'keyword' }],
+      values: [['Foo Bar']],
+    };
+    const output = esqlResultToPlainObjects(result);
+    expect(output).toEqual([{ name: 'Foo Bar' }]);
+  });
+
+  it('should return columns without "text" or "keyword" in their names', () => {
+    const result: ESQLSearchResponse = {
+      columns: [
+        { name: 'name.text', type: 'text' },
+        { name: 'age', type: 'keyword' },
+      ],
+      values: [
+        ['Foo Bar', 30],
+        ['Foo Qux', 25],
+      ],
+    };
+    const output = esqlResultToPlainObjects(result);
+    expect(output).toEqual([
+      { name: 'Foo Bar', age: 30 },
+      { name: 'Foo Qux', age: 25 },
+    ]);
+  });
+
+  it('should handle mixed columns correctly', () => {
+    const result: ESQLSearchResponse = {
+      columns: [
+        { name: 'name', type: 'text' },
+        { name: 'name.text', type: 'text' },
+        { name: 'age', type: 'keyword' },
+      ],
+      values: [
+        ['Foo Bar', 'Foo Bar', 30],
+        ['Foo Qux', 'Foo Qux', 25],
+      ],
+    };
+    const output = esqlResultToPlainObjects(result);
+    expect(output).toEqual([
+      { name: 'Foo Bar', age: 30 },
+      { name: 'Foo Qux', age: 25 },
+    ]);
+  });
+});
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
@@ -13,7 +13,17 @@ export function esqlResultToPlainObjects<T extends Record<string, any>>(
   return result.values.map((row) => {
     return row.reduce<Record<string, unknown>>((acc, value, index) => {
       const column = result.columns[index];
-      acc[column.name] = value;
+
+      if (!column) {
+        return acc;
+      }
+
+      // Removes the type suffix from the column name
+      const name = column.name.replace(/\.(text|keyword)$/, '');
+      if (!acc[name]) {
+        acc[name] = value;
+      }
+
       return acc;
     }, {});
   }) as T[];

diff --git a/x-pack/plugins/entity_manager/public/lib/entity_client.test.ts b/x-pack/plugins/entity_manager/public/lib/entity_client.test.ts
@@ -0,0 +1,139 @@
+/*
+ * 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 { EntityClient, EnitityInstance } from './entity_client';
+import { coreMock } from '@kbn/core/public/mocks';
+
+const commonEntityFields: EnitityInstance = {
+  entity: {
+    last_seen_timestamp: '2023-10-09T00:00:00Z',
+    id: '1',
+    display_name: 'entity_name',
+    definition_id: 'entity_definition_id',
+  } as EnitityInstance['entity'],
+};
+
+describe('EntityClient', () => {
+  let entityClient: EntityClient;
+
+  beforeEach(() => {
+    entityClient = new EntityClient(coreMock.createStart());
+  });
+
+  describe('asKqlFilter', () => {
+    it('should return the kql filter', () => {
+      const entityLatest: EnitityInstance = {
+        entity: {
+          ...commonEntityFields.entity,
+          identity_fields: ['service.name', 'service.environment'],
+          type: 'service',
+        },
+        service: {
+          name: 'my-service',
+        },
+      };
+
+      const result = entityClient.asKqlFilter(entityLatest);
+      expect(result).toEqual('service.name: my-service');
+    });
+
+    it('should return the kql filter when indentity_fields is composed by multiple fields', () => {
+      const entityLatest: EnitityInstance = {
+        entity: {
+          ...commonEntityFields.entity,
+          identity_fields: ['service.name', 'service.environment'],
+          type: 'service',
+        },
+        service: {
+          name: 'my-service',
+          environment: 'staging',
+        },
+      };
+
+      const result = entityClient.asKqlFilter(entityLatest);
+      expect(result).toEqual('(service.name: my-service AND service.environment: staging)');
+    });
+
+    it('should ignore fields that are not present in the entity', () => {
+      const entityLatest: EnitityInstance = {
+        entity: {
+          ...commonEntityFields.entity,
+          identity_fields: ['host.name', 'foo.bar'],
+        },
+        host: {
+          name: 'my-host',
+        },
+      };
+
+      const result = entityClient.asKqlFilter(entityLatest);
+      expect(result).toEqual('host.name: my-host');
+    });
+  });
+
+  describe('getIdentityFieldsValue', () => {
+    it('should return identity fields values', () => {
+      const entityLatest: EnitityInstance = {
+        entity: {
+          ...commonEntityFields.entity,
+          identity_fields: ['service.name', 'service.environment'],
+          type: 'service',
+        },
+        service: {
+          name: 'my-service',
+        },
+      };
+
+      expect(entityClient.getIdentityFieldsValue(entityLatest)).toEqual({
+        'service.name': 'my-service',
+      });
+    });
+
+    it('should return identity fields values when indentity_fields is composed by multiple fields', () => {
+      const entityLatest: EnitityInstance = {
+        entity: {
+          ...commonEntityFields.entity,
+          identity_fields: ['service.name', 'service.environment'],
+          type: 'service',
+        },
+        service: {
+          name: 'my-service',
+          environment: 'staging',
+        },
+      };
+
+      expect(entityClient.getIdentityFieldsValue(entityLatest)).toEqual({
+        'service.name': 'my-service',
+        'service.environment': 'staging',
+      });
+    });
+
+    it('should return identity fields when field is in the root', () => {
+      const entityLatest: EnitityInstance = {
+        entity: {
+          ...commonEntityFields.entity,
+          identity_fields: ['name'],
+          type: 'service',
+        },
+        name: 'foo',
+      };
+
+      expect(entityClient.getIdentityFieldsValue(entityLatest)).toEqual({
+        name: 'foo',
+      });
+    });
+
+    it('should throw an error when identity fields are missing', () => {
+      const entityLatest: EnitityInstance = {
+        ...commonEntityFields,
+      };
+
+      expect(() => entityClient.getIdentityFieldsValue(entityLatest)).toThrow(
+        'Identity fields are missing'
+      );
+    });
+  });
+});
diff --git a/x-pack/plugins/entity_manager/public/lib/entity_client.ts b/x-pack/plugins/entity_manager/public/lib/entity_client.ts
@@ -5,13 +5,17 @@
  * 2.0.
  */
 
+import { z } from '@kbn/zod';
 import { CoreSetup, CoreStart } from '@kbn/core/public';
 import {
   ClientRequestParamsOf,
   RouteRepositoryClient,
   createRepositoryClient,
   isHttpFetchError,
 } from '@kbn/server-route-repository-client';
+import { type KueryNode, nodeTypes, toKqlExpression } from '@kbn/es-query';
+import { entityLatestSchema } from '@kbn/entities-schema';
+import { castArray } from 'lodash';
 import {
   DisableManagedEntityResponse,
   EnableManagedEntityResponse,
@@ -35,6 +39,8 @@ type CreateEntityDefinitionQuery = QueryParamOf<
   ClientRequestParamsOf<EntityManagerRouteRepository, 'PUT /internal/entities/managed/enablement'>
 >;
 
+export type EnitityInstance = z.infer<typeof entityLatestSchema>;
+
 export class EntityClient {
   public readonly repositoryClient: EntityManagerRepositoryClient['fetch'];
 
@@ -83,4 +89,38 @@ export class EntityClient {
       throw err;
     }
   }
+
+  asKqlFilter(entityLatest: EnitityInstance) {
+    const identityFieldsValue = this.getIdentityFieldsValue(entityLatest);
+
+    const nodes: KueryNode[] = Object.entries(identityFieldsValue).map(([identityField, value]) => {
+      return nodeTypes.function.buildNode('is', identityField, value);
+    });
+
+    if (nodes.length === 0) return '';
+
+    const kqlExpression = nodes.length > 1 ? nodeTypes.function.buildNode('and', nodes) : nodes[0];
+
+    return toKqlExpression(kqlExpression);
+  }
+
+  getIdentityFieldsValue(entityLatest: EnitityInstance) {
+    const { identity_fields: identityFields } = entityLatest.entity;
+
+    if (!identityFields) {
+      throw new Error('Identity fields are missing');
+    }
+
+    return castArray(identityFields).reduce((acc, field) => {
+      const value = field.split('.').reduce((obj: any, part: string) => {
+        return obj && typeof obj === 'object' ? (obj as Record<string, any>)[part] : undefined;
+      }, entityLatest);
+
+      if (value) {
+        acc[field] = value;
+      }
+
+      return acc;
+    }, {} as Record<string, string>);
+  }
 }
diff --git a/x-pack/plugins/observability_solution/apm/common/entities/types.ts b/x-pack/plugins/observability_solution/apm/common/entities/types.ts
diff --git a/x-pack/plugins/observability_solution/apm/common/es_fields/entities.ts b/x-pack/plugins/observability_solution/apm/common/es_fields/entities.ts
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
@@ -6,10 +6,10 @@
  */
 
 import * as z from '@kbn/zod';
-import { EntityDataStreamType, EntityType } from '@kbn/observability-shared-plugin/common';
+import { EntityDataStreamType, ENTITY_TYPES } 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 EntityTypeSchema = z.union([z.literal(ENTITY_TYPES.HOST), z.literal(ENTITY_TYPES.CONTAINER)]);
 const EntityDataStreamSchema = z.union([
   z.literal(EntityDataStreamType.METRICS),
   z.literal(EntityDataStreamType.LOGS),

diff --git a/...observability_solution/infra/public/components/asset_details/tabs/processes/processes.tsx b/...observability_solution/infra/public/components/asset_details/tabs/processes/processes.tsx
@@ -22,8 +22,8 @@ import {
 import { FormattedMessage } from '@kbn/i18n-react';
 import { getFieldByType } from '@kbn/metrics-data-access-plugin/common';
 import { decodeOrThrow } from '@kbn/io-ts-utils';
-import { EntityType } from '@kbn/observability-shared-plugin/common';
 import useLocalStorage from 'react-use/lib/useLocalStorage';
+import { ENTITY_TYPES } from '@kbn/observability-shared-plugin/common';
 import { useSourceContext } from '../../../../containers/metrics_source';
 import { isPending, useFetcher } from '../../../../hooks/use_fetcher';
 import { parseSearchString } from './parse_search_string';
@@ -58,7 +58,7 @@ export const Processes = () => {
   const { request$ } = useRequestObservable();
   const { isActiveTab } = useTabSwitcherContext();
   const { dataStreams, status: dataStreamsStatus } = useEntitySummary({
-    entityType: EntityType.HOST,
+    entityType: ENTITY_TYPES.HOST,
     entityId: asset.name,
   });
   const addMetricsCalloutId: AddMetricsCalloutKey = 'hostProcesses';

diff --git a/x-pack/plugins/observability_solution/infra/server/routes/entities/index.ts b/x-pack/plugins/observability_solution/infra/server/routes/entities/index.ts
@@ -9,6 +9,7 @@ import { schema } from '@kbn/config-schema';
 import { METRICS_APP_ID } from '@kbn/deeplinks-observability/constants';
 import { entityCentricExperience } from '@kbn/observability-plugin/common';
 import { createObservabilityEsClient } from '@kbn/observability-utils/es/client/create_observability_es_client';
+import { ENTITY_TYPES } from '@kbn/observability-shared-plugin/common';
 import { getInfraMetricsClient } from '../../lib/helpers/get_infra_metrics_client';
 import { InfraBackendLibs } from '../../lib/infra_types';
 import { getDataStreamTypes } from './get_data_stream_types';
@@ -22,7 +23,10 @@ export const initEntitiesConfigurationRoutes = (libs: InfraBackendLibs) => {
       path: '/api/infra/entities/{entityType}/{entityId}/summary',
       validate: {
         params: schema.object({
-          entityType: schema.oneOf([schema.literal('host'), schema.literal('container')]),
+          entityType: schema.oneOf([
+            schema.literal(ENTITY_TYPES.HOST),
+            schema.literal(ENTITY_TYPES.CONTAINER),
+          ]),
           entityId: schema.string(),
         }),
       },