[SecuritySolution] Entity Engine status tab

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/common.gen.ts

@@ -39,6 +39,37 @@ export const EngineDescriptor = z.object({
   error: z.object({}).optional(),
 });
 
+export type EngineComponentResource = z.infer<typeof EngineComponentResource>;
+export const EngineComponentResource = z.enum([
+  'entity_engine',
+  'entity_definition',
+  'index',
+  'component_template',
+  'index_template',
+  'ingest_pipeline',
+  'enrich_policy',
+  'task',
+  'transform',
+]);
+export type EngineComponentResourceEnum = typeof EngineComponentResource.enum;
+export const EngineComponentResourceEnum = EngineComponentResource.enum;
+
+export type EngineComponentStatus = z.infer<typeof EngineComponentStatus>;
+export const EngineComponentStatus = z.object({
+  id: z.string(),
+  installed: z.boolean(),
+  resource: EngineComponentResource,
+  health: z.enum(['green', 'yellow', 'red', 'unknown']).optional(),
+  errors: z
+    .array(
+      z.object({
+        title: z.string().optional(),
+        message: z.string().optional(),
+      })
+    )
+    .optional(),
+});
+
 export type StoreStatus = z.infer<typeof StoreStatus>;
 export const StoreStatus = z.enum(['not_installed', 'installing', 'running', 'stopped', 'error']);
 export type StoreStatusEnum = typeof StoreStatus.enum;

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/common.schema.yaml

@@ -42,6 +42,49 @@ components:
         - updating
         - error
 
+    EngineComponentStatus:
+      type: object
+      required:
+          - id
+          - installed
+          - resource
+      properties:
+        id: 
+          type: string
+        installed: 
+          type: boolean
+        resource:
+          $ref: '#/components/schemas/EngineComponentResource'
+        health: 
+          type: string
+          enum:
+            - green
+            - yellow
+            - red
+            - unknown
+        errors:
+          type: array
+          items:
+            type: object
+            properties:
+              title:
+                type: string
+              message:
+                type: string
+
+    EngineComponentResource:
+      type: string
+      enum:
+        - entity_engine
+        - entity_definition
+        - index
+        - component_template
+        - index_template
+        - ingest_pipeline
+        - enrich_policy
+        - task
+        - transform
+
     StoreStatus:
       type: string
       enum:

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/enablement.gen.ts → x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/enable.gen.ts

@@ -16,13 +16,7 @@
 
 import { z } from '@kbn/zod';
 
-import { IndexPattern, EngineDescriptor, StoreStatus } from './common.gen';
-
-export type GetEntityStoreStatusResponse = z.infer<typeof GetEntityStoreStatusResponse>;
-export const GetEntityStoreStatusResponse = z.object({
-  status: StoreStatus.optional(),
-  engines: z.array(EngineDescriptor).optional(),
-});
+import { IndexPattern, EngineDescriptor } from './common.gen';
 
 export type InitEntityStoreRequestBody = z.infer<typeof InitEntityStoreRequestBody>;
 export const InitEntityStoreRequestBody = z.object({

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/enablement.schema.yaml → x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/enable.schema.yaml

@@ -41,24 +41,3 @@ paths:
                     type: array
                     items:
                       $ref: './common.schema.yaml#/components/schemas/EngineDescriptor'
-
-  /api/entity_store/status:
-    get:
-      x-labels: [ess, serverless]
-      x-codegen-enabled: true
-      operationId: GetEntityStoreStatus
-      summary: Get the status of the Entity Store
-      responses:
-        '200':
-          description: Successful response
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  status: 
-                    $ref: './common.schema.yaml#/components/schemas/StoreStatus'
-                  engines:
-                    type: array
-                    items:
-                      $ref: './common.schema.yaml#/components/schemas/EngineDescriptor'

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/engine/index.ts

@@ -10,6 +10,5 @@ export * from './get.gen';
 export * from './init.gen';
 export * from './list.gen';
 export * from './start.gen';
-export * from './stats.gen';
 export * from './stop.gen';
 export * from './apply_dataview_indices.gen';

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/status.gen.ts

@@ -0,0 +1,43 @@
+/*
+ * 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.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Enable Entity Store
+ *   version: 2023-10-31
+ */
+
+import { z } from '@kbn/zod';
+import { BooleanFromString } from '@kbn/zod-helpers';
+
+import { StoreStatus, EngineDescriptor, EngineComponentStatus } from './common.gen';
+
+export type GetEntityStoreStatusRequestQuery = z.infer<typeof GetEntityStoreStatusRequestQuery>;
+export const GetEntityStoreStatusRequestQuery = z.object({
+  /**
+   * If true returns a detailed status of the engine including all it's components
+   */
+  withComponents: BooleanFromString.optional(),
+});
+export type GetEntityStoreStatusRequestQueryInput = z.input<
+  typeof GetEntityStoreStatusRequestQuery
+>;
+
+export type GetEntityStoreStatusResponse = z.infer<typeof GetEntityStoreStatusResponse>;
+export const GetEntityStoreStatusResponse = z.object({
+  status: StoreStatus,
+  engines: z.array(
+    EngineDescriptor.merge(
+      z.object({
+        components: z.array(EngineComponentStatus).optional(),
+      })
+    )
+  ),
+});

x-pack/plugins/security_solution/common/api/entity_analytics/entity_store/status.schema.yaml

@@ -0,0 +1,44 @@
+openapi: 3.0.0
+
+info:
+  title: Enable Entity Store
+  version: '2023-10-31'
+paths:
+  /api/entity_store/status:
+    get:
+      x-labels: [ess, serverless]
+      x-codegen-enabled: true
+      operationId: GetEntityStoreStatus
+      summary: Get the status of the Entity Store
+
+      parameters:
+        - name: withComponents          
+          in: query  
+          schema:
+            type: boolean
+          description: If true returns a detailed status of the engine including all it's components
+
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - status
+                  - engines
+                properties:
+                  status: 
+                    $ref: './common.schema.yaml#/components/schemas/StoreStatus'
+                  engines:
+                    type: array
+                    items:
+                      allOf:
+                        - $ref: './common.schema.yaml#/components/schemas/EngineDescriptor'
+                        - type: object
+                          properties:
+                            components:
+                              type: array
+                              items:
+                                $ref: './common.schema.yaml#/components/schemas/EngineComponentStatus'

x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts

@@ -232,10 +232,9 @@ import type {
   UploadAssetCriticalityRecordsResponse,
 } from './entity_analytics/asset_criticality/upload_asset_criticality_csv.gen';
 import type {
-  GetEntityStoreStatusResponse,
   InitEntityStoreRequestBodyInput,
   InitEntityStoreResponse,
-} from './entity_analytics/entity_store/enablement.gen';
+} from './entity_analytics/entity_store/enable.gen';
 import type { ApplyEntityEngineDataviewIndicesResponse } from './entity_analytics/entity_store/engine/apply_dataview_indices.gen';
 import type {
   DeleteEntityEngineRequestQueryInput,
@@ -269,6 +268,10 @@ import type {
   ListEntitiesRequestQueryInput,
   ListEntitiesResponse,
 } from './entity_analytics/entity_store/entities/list_entities.gen';
+import type {
+  GetEntityStoreStatusRequestQueryInput,
+  GetEntityStoreStatusResponse,
+} from './entity_analytics/entity_store/status.gen';
 import type { CleanUpRiskEngineResponse } from './entity_analytics/risk_engine/engine_cleanup_route.gen';
 import type { DisableRiskEngineResponse } from './entity_analytics/risk_engine/engine_disable_route.gen';
 import type { EnableRiskEngineResponse } from './entity_analytics/risk_engine/engine_enable_route.gen';
@@ -1302,7 +1305,7 @@ finalize it.
       })
       .catch(catchAxiosErrorFormatAndThrow);
   }
-  async getEntityStoreStatus() {
+  async getEntityStoreStatus(props: GetEntityStoreStatusProps) {
     this.log.info(`${new Date().toISOString()} Calling API GetEntityStoreStatus`);
     return this.kbnClient
       .request<GetEntityStoreStatusResponse>({
@@ -1311,6 +1314,8 @@ finalize it.
           [ELASTIC_HTTP_VERSION_HEADER]: '2023-10-31',
         },
         method: 'GET',
+
+        query: props.query,
       })
       .catch(catchAxiosErrorFormatAndThrow);
   }
@@ -2288,6 +2293,9 @@ export interface GetEntityEngineProps {
 export interface GetEntityEngineStatsProps {
   params: GetEntityEngineStatsRequestParamsInput;
 }
+export interface GetEntityStoreStatusProps {
+  query: GetEntityStoreStatusRequestQueryInput;
+}
 export interface GetNotesProps {
   query: GetNotesRequestQueryInput;
 }