[ML] Nodes overview for the Model Management page (#116361)

* [ML] Nodes overview for the Model Management page  (#115772)

* [ML] trained models tab

* [ML] wip nodes list

* [ML] add types

* [ML] add types

* [ML] node expanded row

* [ML] wip show memory usage

* [ML] refactor, use model_memory_limit for dfa jobs

* [ML] fix refresh button

* [ML] add process memory overhead

* [ML] trained models memory overview

* [ML] add jvm size, remove node props from the response

* [ML] fix tab name

* [ML] custom colors for the bar chart

* [ML] sub jvm size

* [ML] updates for the model list

* [ML] apply native process overhead

* [ML]add adjusted_total_in_bytes

* [ML] start and stop deployment

* [ML] fix default sorting

* [ML] fix types issues

* [ML] fix const

* [ML] remove unused i18n strings

* [ML] fix lint

* [ML] extra custom URLs test

* [ML] update tests for model provider

* [ML] add node routing state info

* [ML] fix functional tests

* [ML] update for es response

* [ML] GetTrainedModelDeploymentStats

* [ML] add deployment stats

* [ML] add spacer

* [ML] disable stop allocation for models with pipelines

* [ML] fix type

* [ML] add beta label

* [ML] move beta label

* [ML] rename model_size prop

* [ML] update tooltip header

* [ML] update text

* [ML] remove ts ignore

* [ML] update types

* remove commented code

* replace toast notification service

* remove ts-ignore

* remove empty panel

* add comments, update test subjects

* fix ts error

* update comment

* fix applying memory overhead

* Revert "fix applying memory overhead"

This reverts commit 0cf38fb.

* fix type, remove ts-ignore

* add todo comment

(cherry picked from commit 605e9e2)

* updates for the latest elasticsearch client

* hide allocated models when missing

* [ML] Update jest test mock

Co-authored-by: Quynh Nguyen <quynh.nguyen@elastic.co>

x-pack/plugins/ml/common/constants/locator.ts

@@ -13,7 +13,8 @@ export const ML_PAGES = {
   SINGLE_METRIC_VIEWER: 'timeseriesexplorer',
   DATA_FRAME_ANALYTICS_JOBS_MANAGE: 'data_frame_analytics',
   DATA_FRAME_ANALYTICS_CREATE_JOB: 'data_frame_analytics/new_job',
-  DATA_FRAME_ANALYTICS_MODELS_MANAGE: 'data_frame_analytics/models',
+  TRAINED_MODELS_MANAGE: 'trained_models',
+  TRAINED_MODELS_NODES: 'trained_models/nodes',
   DATA_FRAME_ANALYTICS_EXPLORATION: 'data_frame_analytics/exploration',
   DATA_FRAME_ANALYTICS_MAP: 'data_frame_analytics/map',
   /**

x-pack/plugins/ml/common/types/locator.ts

@@ -184,6 +184,10 @@ export interface DataFrameAnalyticsQueryState {
   globalState?: MlCommonGlobalState;
 }
 
+export interface TrainedModelsQueryState {
+  modelId?: string;
+}
+
 export type DataFrameAnalyticsUrlState = MLPageState<
   | typeof ML_PAGES.DATA_FRAME_ANALYTICS_JOBS_MANAGE
   | typeof ML_PAGES.DATA_FRAME_ANALYTICS_MAP
@@ -250,8 +254,14 @@ export type MlLocatorState =
   | DataFrameAnalyticsExplorationUrlState
   | CalendarEditUrlState
   | FilterEditUrlState
-  | MlGenericUrlState;
+  | MlGenericUrlState
+  | TrainedModelsUrlState;
 
 export type MlLocatorParams = MlLocatorState & SerializableRecord;
 
 export type MlLocator = LocatorPublic<MlLocatorParams>;
+
+export type TrainedModelsUrlState = MLPageState<
+  typeof ML_PAGES.TRAINED_MODELS_MANAGE,
+  TrainedModelsQueryState | undefined
+>;

x-pack/plugins/ml/common/types/trained_models.ts

@@ -44,6 +44,7 @@ export interface TrainedModelStat {
       }
     >;
   };
+  deployment_stats?: Omit<TrainedModelDeploymentStatsResponse, 'model_id'>;
 }
 
 type TreeNode = object;
@@ -95,6 +96,7 @@ export interface TrainedModelConfigResponse {
     model_aliases?: string[];
   } & Record<string, unknown>;
   model_id: string;
+  model_type: 'tree_ensemble' | 'pytorch' | 'lang_ident';
   tags: string[];
   version: string;
   inference_config?: Record<string, any>;
@@ -117,3 +119,82 @@ export interface ModelPipelines {
 export interface InferenceConfigResponse {
   trained_model_configs: TrainedModelConfigResponse[];
 }
+
+export interface TrainedModelDeploymentStatsResponse {
+  model_id: string;
+  model_size_bytes: number;
+  inference_threads: number;
+  model_threads: number;
+  state: string;
+  allocation_status: { target_allocation_count: number; state: string; allocation_count: number };
+  nodes: Array<{
+    node: Record<
+      string,
+      {
+        transport_address: string;
+        roles: string[];
+        name: string;
+        attributes: {
+          'ml.machine_memory': string;
+          'xpack.installed': string;
+          'ml.max_open_jobs': string;
+          'ml.max_jvm_size': string;
+        };
+        ephemeral_id: string;
+      }
+    >;
+    inference_count: number;
+    routing_state: { routing_state: string };
+    average_inference_time_ms: number;
+    last_access: number;
+  }>;
+}
+
+export interface NodeDeploymentStatsResponse {
+  id: string;
+  name: string;
+  transport_address: string;
+  attributes: Record<string, string>;
+  roles: string[];
+  allocated_models: Array<{
+    inference_threads: number;
+    allocation_status: {
+      target_allocation_count: number;
+      state: string;
+      allocation_count: number;
+    };
+    model_id: string;
+    state: string;
+    model_threads: number;
+    model_size_bytes: number;
+  }>;
+  memory_overview: {
+    machine_memory: {
+      /** Total machine memory in bytes */
+      total: number;
+      jvm: number;
+    };
+    /** Open anomaly detection jobs + hardcoded overhead */
+    anomaly_detection: {
+      /** Total size in bytes */
+      total: number;
+    };
+    /** DFA jobs currently in training + hardcoded overhead */
+    dfa_training: {
+      total: number;
+    };
+    /** Allocated trained models */
+    trained_models: {
+      total: number;
+      by_model: Array<{
+        model_id: string;
+        model_size: number;
+      }>;
+    };
+  };
+}
+
+export interface NodesOverviewResponse {
+  count: number;
+  nodes: NodeDeploymentStatsResponse[];
+}

x-pack/plugins/ml/public/application/app.tsx

@@ -27,7 +27,11 @@ import { MlRouter } from './routing';
 import { mlApiServicesProvider } from './services/ml_api_service';
 import { HttpService } from './services/http_service';
 import { ML_APP_LOCATOR, ML_PAGES } from '../../common/constants/locator';
-export type MlDependencies = Omit<MlSetupDependencies, 'share' | 'indexPatternManagement'> &
+
+export type MlDependencies = Omit<
+  MlSetupDependencies,
+  'share' | 'indexPatternManagement' | 'fieldFormats'
+> &
   MlStartDependencies;
 
 interface AppProps {
@@ -84,6 +88,7 @@ const App: FC<AppProps> = ({ coreStart, deps, appMountParams }) => {
     triggersActionsUi: deps.triggersActionsUi,
     dataVisualizer: deps.dataVisualizer,
     usageCollection: deps.usageCollection,
+    fieldFormats: deps.fieldFormats,
     ...coreStart,
   };
 

x-pack/plugins/ml/public/application/components/navigation_menu/main_tabs.tsx

@@ -7,7 +7,7 @@
 
 import React, { FC, useState, useEffect } from 'react';
 
-import { EuiPageHeader } from '@elastic/eui';
+import { EuiPageHeader, EuiBetaBadge } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
 import { TabId } from './navigation_menu';
 import { useMlKibana, useMlLocator, useNavigateToPath } from '../../contexts/kibana';
@@ -20,6 +20,7 @@ export interface Tab {
   id: TabId;
   name: any;
   disabled: boolean;
+  betaTag?: JSX.Element;
 }
 
 interface Props {
@@ -50,6 +51,27 @@ function getTabs(disableLinks: boolean): Tab[] {
       }),
       disabled: disableLinks,
     },
+    {
+      id: 'trained_models',
+      name: i18n.translate('xpack.ml.navMenu.trainedModelsTabLinkText', {
+        defaultMessage: 'Model Management',
+      }),
+      disabled: disableLinks,
+      betaTag: (
+        <EuiBetaBadge
+          label={i18n.translate('xpack.ml.navMenu.trainedModelsTabBetaLabel', {
+            defaultMessage: 'Experimental',
+          })}
+          size="m"
+          color="hollow"
+          iconType="beaker"
+          tooltipContent={i18n.translate('xpack.ml.navMenu.trainedModelsTabBetaTooltipContent', {
+            defaultMessage:
+              "Model Management is an experimental feature and subject to change. We'd love to hear your feedback.",
+          })}
+        />
+      ),
+    },
     {
       id: 'datavisualizer',
       name: i18n.translate('xpack.ml.navMenu.dataVisualizerTabLinkText', {
@@ -93,6 +115,12 @@ const TAB_DATA: Record<TabId, TabData> = {
       defaultMessage: 'Data Frame Analytics',
     }),
   },
+  trained_models: {
+    testSubject: 'mlMainTab modelManagement',
+    name: i18n.translate('xpack.ml.trainedModelsTabLabel', {
+      defaultMessage: 'Trained Models',
+    }),
+  },
   datavisualizer: {
     testSubject: 'mlMainTab dataVisualizer',
     name: i18n.translate('xpack.ml.dataVisualizerTabLabel', {
@@ -173,6 +201,7 @@ export const MainTabs: FC<Props> = ({ tabId, disableLinks }) => {
           },
           'data-test-subj': testSubject + (id === selectedTabId ? ' selected' : ''),
           isSelected: id === selectedTabId,
+          append: tab.betaTag,
         };
       })}
     />

x-pack/plugins/ml/public/application/components/navigation_menu/navigation_menu.tsx

@@ -15,6 +15,7 @@ export type TabId =
   | 'access-denied'
   | 'anomaly_detection'
   | 'data_frame_analytics'
+  | 'trained_models'
   | 'datavisualizer'
   | 'overview'
   | 'settings';

x-pack/plugins/ml/public/application/contexts/kibana/kibana_context.ts

@@ -21,6 +21,7 @@ import type { EmbeddableStart } from '../../../../../../../src/plugins/embeddabl
 import type { MapsStartApi } from '../../../../../maps/public';
 import type { DataVisualizerPluginStart } from '../../../../../data_visualizer/public';
 import type { TriggersAndActionsUIPublicPluginStart } from '../../../../../triggers_actions_ui/public';
+import type { FieldFormatsRegistry } from '../../../../../../../src/plugins/field_formats/common';
 
 interface StartPlugins {
   data: DataPublicPluginStart;
@@ -32,6 +33,7 @@ interface StartPlugins {
   triggersActionsUi?: TriggersAndActionsUIPublicPluginStart;
   dataVisualizer?: DataVisualizerPluginStart;
   usageCollection?: UsageCollectionSetup;
+  fieldFormats: FieldFormatsRegistry;
 }
 export type StartServices = CoreStart &
   StartPlugins & {

x-pack/plugins/ml/public/application/contexts/kibana/use_field_formatter.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 { useMlKibana } from './kibana_context';
+
+export function useFieldFormatter(fieldType: 'bytes') {
+  const {
+    services: { fieldFormats },
+  } = useMlKibana();
+
+  const fieldFormatter = fieldFormats.deserialize({ id: fieldType });
+  return fieldFormatter.convert.bind(fieldFormatter);
+}

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/analytics_navigation_bar/analytics_navigation_bar.tsx

@@ -33,14 +33,6 @@ export const AnalyticsNavigationBar: FC<{
         path: '/data_frame_analytics',
         testSubj: 'mlAnalyticsJobsTab',
       },
-      {
-        id: 'models',
-        name: i18n.translate('xpack.ml.dataframe.modelsTabLabel', {
-          defaultMessage: 'Models',
-        }),
-        path: '/data_frame_analytics/models',
-        testSubj: 'mlTrainedModelsTab',
-      },
     ];
     if (jobId !== undefined || modelId !== undefined) {
       navTabs.push({

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/page.tsx

@@ -31,7 +31,6 @@ import { NodeAvailableWarning } from '../../../components/node_available_warning
 import { SavedObjectsWarning } from '../../../components/saved_objects_warning';
 import { UpgradeWarning } from '../../../components/upgrade';
 import { AnalyticsNavigationBar } from './components/analytics_navigation_bar';
-import { ModelsList } from './components/models_management';
 import { JobMap } from '../job_map';
 import { usePageUrlState } from '../../../util/url_state';
 import { ListingPageUrlState } from '../../../../../common/types/common';
@@ -125,7 +124,6 @@ export const Page: FC = () => {
                 updatePageState={setDfaPageState}
               />
             )}
-            {selectedTabId === 'models' && <ModelsList />}
           </EuiPageContent>
         </EuiPageBody>
       </EuiPage>

x-pack/plugins/ml/public/application/routing/breadcrumbs.ts

@@ -41,6 +41,13 @@ export const DATA_FRAME_ANALYTICS_BREADCRUMB: ChromeBreadcrumb = Object.freeze({
   href: '/data_frame_analytics',
 });
 
+export const TRAINED_MODELS: ChromeBreadcrumb = Object.freeze({
+  text: i18n.translate('xpack.ml.trainedModelsLabel', {
+    defaultMessage: 'Trained Models',
+  }),
+  href: '/trained_models',
+});
+
 export const DATA_VISUALIZER_BREADCRUMB: ChromeBreadcrumb = Object.freeze({
   text: i18n.translate('xpack.ml.datavisualizerBreadcrumbLabel', {
     defaultMessage: 'Data Visualizer',
@@ -74,6 +81,7 @@ const breadcrumbs = {
   SETTINGS_BREADCRUMB,
   ANOMALY_DETECTION_BREADCRUMB,
   DATA_FRAME_ANALYTICS_BREADCRUMB,
+  TRAINED_MODELS,
   DATA_VISUALIZER_BREADCRUMB,
   CREATE_JOB_BREADCRUMB,
   CALENDAR_MANAGEMENT_BREADCRUMB,

x-pack/plugins/ml/public/application/routing/routes/data_frame_analytics/index.ts

@@ -8,5 +8,4 @@
 export * from './analytics_jobs_list';
 export * from './analytics_job_exploration';
 export * from './analytics_job_creation';
-export * from './models_list';
 export * from './analytics_map';

x-pack/plugins/ml/public/application/routing/routes/index.ts

@@ -14,3 +14,4 @@ export * from './data_frame_analytics';
 export { timeSeriesExplorerRouteFactory } from './timeseriesexplorer';
 export * from './explorer';
 export * from './access_denied';
+export * from './trained_models';

x-pack/plugins/ml/public/application/routing/routes/trained_models/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 * from './models_list';
+export * from './nodes_list';

x-pack/plugins/ml/public/application/routing/routes/data_frame_analytics/models_list.tsx → x-pack/plugins/ml/public/application/routing/routes/trained_models/models_list.tsx

@@ -13,20 +13,20 @@ import { NavigateToPath } from '../../../contexts/kibana';
 import { MlRoute, PageLoader, PageProps } from '../../router';
 import { useResolver } from '../../use_resolver';
 import { basicResolvers } from '../../resolvers';
-import { Page } from '../../../data_frame_analytics/pages/analytics_management';
 import { getBreadcrumbWithUrlForApp } from '../../breadcrumbs';
+import { Page } from '../../../trained_models';
 
 export const modelsListRouteFactory = (
   navigateToPath: NavigateToPath,
   basePath: string
 ): MlRoute => ({
-  path: '/data_frame_analytics/models',
+  path: '/trained_models',
   render: (props, deps) => <PageWrapper {...props} deps={deps} />,
   breadcrumbs: [
     getBreadcrumbWithUrlForApp('ML_BREADCRUMB', navigateToPath, basePath),
-    getBreadcrumbWithUrlForApp('DATA_FRAME_ANALYTICS_BREADCRUMB', navigateToPath, basePath),
+    getBreadcrumbWithUrlForApp('TRAINED_MODELS', navigateToPath, basePath),
     {
-      text: i18n.translate('xpack.ml.dataFrameAnalyticsBreadcrumbs.modelsListLabel', {
+      text: i18n.translate('xpack.ml.trainedModelsBreadcrumbs.modelsListLabel', {
         defaultMessage: 'Model Management',
       }),
       href: '',