[Monitoring] JVM memory usage alert (#79039)

* Memory usage first draft * Fixed tests * CR feedback * Feedback and tests * Added size to optimize query * Removed scheduled check * Removed globalstate date Co-authored-by: Kibana Machine <[email protected]>
elastic · Oct 5, 2020 · f490268 · f490268
1 parent 14e58fb
commit f490268
Show file tree

Hide file tree

Showing 20 changed files with 594 additions and 59 deletions.
diff --git a/x-pack/plugins/monitoring/common/constants.ts b/x-pack/plugins/monitoring/common/constants.ts
@@ -236,6 +236,7 @@ export const ALERT_NODES_CHANGED = `${ALERT_PREFIX}alert_nodes_changed`;
 export const ALERT_ELASTICSEARCH_VERSION_MISMATCH = `${ALERT_PREFIX}alert_elasticsearch_version_mismatch`;
 export const ALERT_KIBANA_VERSION_MISMATCH = `${ALERT_PREFIX}alert_kibana_version_mismatch`;
 export const ALERT_LOGSTASH_VERSION_MISMATCH = `${ALERT_PREFIX}alert_logstash_version_mismatch`;
+export const ALERT_MEMORY_USAGE = `${ALERT_PREFIX}alert_jvm_memory_usage`;
 export const ALERT_MISSING_MONITORING_DATA = `${ALERT_PREFIX}alert_missing_monitoring_data`;
 
 /**
@@ -250,6 +251,7 @@ export const ALERTS = [
   ALERT_ELASTICSEARCH_VERSION_MISMATCH,
   ALERT_KIBANA_VERSION_MISMATCH,
   ALERT_LOGSTASH_VERSION_MISMATCH,
+  ALERT_MEMORY_USAGE,
   ALERT_MISSING_MONITORING_DATA,
 ];
 

diff --git a/x-pack/plugins/monitoring/public/alerts/memory_usage_alert/index.tsx b/x-pack/plugins/monitoring/public/alerts/memory_usage_alert/index.tsx
@@ -0,0 +1,29 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React from 'react';
+import { validate } from '../components/duration/validation';
+import { Expression, Props } from '../components/duration/expression';
+
+// eslint-disable-next-line @kbn/eslint/no-restricted-paths
+import { AlertTypeModel } from '../../../../triggers_actions_ui/public/types';
+
+// eslint-disable-next-line @kbn/eslint/no-restricted-paths
+import { MemoryUsageAlert } from '../../../server/alerts';
+
+export function createMemoryUsageAlertType(): AlertTypeModel {
+  return {
+    id: MemoryUsageAlert.TYPE,
+    name: MemoryUsageAlert.LABEL,
+    iconClass: 'bell',
+    alertParamsExpression: (props: Props) => (
+      <Expression {...props} paramDetails={MemoryUsageAlert.PARAM_DETAILS} />
+    ),
+    validate,
+    defaultActionMessage: '{{context.internalFullMessage}}',
+    requiresAppContext: true,
+  };
+}
diff --git a/x-pack/plugins/monitoring/public/components/cluster/overview/elasticsearch_panel.js b/x-pack/plugins/monitoring/public/components/cluster/overview/elasticsearch_panel.js
@@ -41,6 +41,7 @@ import {
   ALERT_CLUSTER_HEALTH,
   ALERT_CPU_USAGE,
   ALERT_DISK_USAGE,
+  ALERT_MEMORY_USAGE,
   ALERT_NODES_CHANGED,
   ALERT_ELASTICSEARCH_VERSION_MISMATCH,
   ALERT_MISSING_MONITORING_DATA,
@@ -160,6 +161,7 @@ const OVERVIEW_PANEL_ALERTS = [ALERT_CLUSTER_HEALTH, ALERT_LICENSE_EXPIRATION];
 const NODES_PANEL_ALERTS = [
   ALERT_CPU_USAGE,
   ALERT_DISK_USAGE,
+  ALERT_MEMORY_USAGE,
   ALERT_NODES_CHANGED,
   ALERT_ELASTICSEARCH_VERSION_MISMATCH,
   ALERT_MISSING_MONITORING_DATA,

diff --git a/x-pack/plugins/monitoring/public/plugin.ts b/x-pack/plugins/monitoring/public/plugin.ts
@@ -26,6 +26,7 @@ import { createCpuUsageAlertType } from './alerts/cpu_usage_alert';
 import { createMissingMonitoringDataAlertType } from './alerts/missing_monitoring_data_alert';
 import { createLegacyAlertTypes } from './alerts/legacy_alert';
 import { createDiskUsageAlertType } from './alerts/disk_usage_alert';
+import { createMemoryUsageAlertType } from './alerts/memory_usage_alert';
 
 interface MonitoringSetupPluginDependencies {
   home?: HomePublicPluginSetup;
@@ -72,12 +73,15 @@ export class MonitoringPlugin
       });
     }
 
-    plugins.triggers_actions_ui.alertTypeRegistry.register(createCpuUsageAlertType());
-    plugins.triggers_actions_ui.alertTypeRegistry.register(createMissingMonitoringDataAlertType());
-    plugins.triggers_actions_ui.alertTypeRegistry.register(createDiskUsageAlertType());
+    const { alertTypeRegistry } = plugins.triggers_actions_ui;
+    alertTypeRegistry.register(createCpuUsageAlertType());
+    alertTypeRegistry.register(createDiskUsageAlertType());
+    alertTypeRegistry.register(createMemoryUsageAlertType());
+    alertTypeRegistry.register(createMissingMonitoringDataAlertType());
+
     const legacyAlertTypes = createLegacyAlertTypes();
     for (const legacyAlertType of legacyAlertTypes) {
-      plugins.triggers_actions_ui.alertTypeRegistry.register(legacyAlertType);
+      alertTypeRegistry.register(legacyAlertType);
     }
 
     const app: App = {

diff --git a/x-pack/plugins/monitoring/public/views/elasticsearch/node/advanced/index.js b/x-pack/plugins/monitoring/public/views/elasticsearch/node/advanced/index.js
@@ -22,6 +22,7 @@ import {
   ALERT_CPU_USAGE,
   ALERT_MISSING_MONITORING_DATA,
   ALERT_DISK_USAGE,
+  ALERT_MEMORY_USAGE,
 } from '../../../../../common/constants';
 
 function getPageData($injector) {
@@ -72,7 +73,12 @@ uiRoutes.when('/elasticsearch/nodes/:node/advanced', {
         alerts: {
           shouldFetch: true,
           options: {
-            alertTypeIds: [ALERT_CPU_USAGE, ALERT_DISK_USAGE, ALERT_MISSING_MONITORING_DATA],
+            alertTypeIds: [
+              ALERT_CPU_USAGE,
+              ALERT_DISK_USAGE,
+              ALERT_MEMORY_USAGE,
+              ALERT_MISSING_MONITORING_DATA,
+            ],
             filters: [
               {
                 nodeUuid: nodeName,

diff --git a/x-pack/plugins/monitoring/public/views/elasticsearch/node/index.js b/x-pack/plugins/monitoring/public/views/elasticsearch/node/index.js
@@ -23,6 +23,7 @@ import {
   ALERT_CPU_USAGE,
   ALERT_MISSING_MONITORING_DATA,
   ALERT_DISK_USAGE,
+  ALERT_MEMORY_USAGE,
 } from '../../../../common/constants';
 
 uiRoutes.when('/elasticsearch/nodes/:node', {
@@ -56,7 +57,12 @@ uiRoutes.when('/elasticsearch/nodes/:node', {
         alerts: {
           shouldFetch: true,
           options: {
-            alertTypeIds: [ALERT_CPU_USAGE, ALERT_DISK_USAGE, ALERT_MISSING_MONITORING_DATA],
+            alertTypeIds: [
+              ALERT_CPU_USAGE,
+              ALERT_DISK_USAGE,
+              ALERT_MEMORY_USAGE,
+              ALERT_MISSING_MONITORING_DATA,
+            ],
             filters: [
               {
                 nodeUuid: nodeName,

diff --git a/x-pack/plugins/monitoring/public/views/elasticsearch/nodes/index.js b/x-pack/plugins/monitoring/public/views/elasticsearch/nodes/index.js
@@ -21,6 +21,7 @@ import {
   ALERT_CPU_USAGE,
   ALERT_MISSING_MONITORING_DATA,
   ALERT_DISK_USAGE,
+  ALERT_MEMORY_USAGE,
 } from '../../../../common/constants';
 
 uiRoutes.when('/elasticsearch/nodes', {
@@ -88,7 +89,12 @@ uiRoutes.when('/elasticsearch/nodes', {
         alerts: {
           shouldFetch: true,
           options: {
-            alertTypeIds: [ALERT_CPU_USAGE, ALERT_DISK_USAGE, ALERT_MISSING_MONITORING_DATA],
+            alertTypeIds: [
+              ALERT_CPU_USAGE,
+              ALERT_DISK_USAGE,
+              ALERT_MEMORY_USAGE,
+              ALERT_MISSING_MONITORING_DATA,
+            ],
             filters: [
               {
                 stackProduct: ELASTICSEARCH_SYSTEM_ID,

diff --git a/x-pack/plugins/monitoring/server/alerts/alerts_factory.test.ts b/x-pack/plugins/monitoring/server/alerts/alerts_factory.test.ts
@@ -63,6 +63,6 @@ describe('AlertsFactory', () => {
 
   it('should get all', () => {
     const alerts = AlertsFactory.getAll();
-    expect(alerts.length).toBe(9);
+    expect(alerts.length).toBe(10);
   });
 });
diff --git a/x-pack/plugins/monitoring/server/alerts/alerts_factory.ts b/x-pack/plugins/monitoring/server/alerts/alerts_factory.ts
@@ -8,6 +8,7 @@ import {
   CpuUsageAlert,
   MissingMonitoringDataAlert,
   DiskUsageAlert,
+  MemoryUsageAlert,
   NodesChangedAlert,
   ClusterHealthAlert,
   LicenseExpirationAlert,
@@ -22,6 +23,7 @@ import {
   ALERT_CPU_USAGE,
   ALERT_MISSING_MONITORING_DATA,
   ALERT_DISK_USAGE,
+  ALERT_MEMORY_USAGE,
   ALERT_NODES_CHANGED,
   ALERT_LOGSTASH_VERSION_MISMATCH,
   ALERT_KIBANA_VERSION_MISMATCH,
@@ -35,6 +37,7 @@ export const BY_TYPE = {
   [ALERT_CPU_USAGE]: CpuUsageAlert,
   [ALERT_MISSING_MONITORING_DATA]: MissingMonitoringDataAlert,
   [ALERT_DISK_USAGE]: DiskUsageAlert,
+  [ALERT_MEMORY_USAGE]: MemoryUsageAlert,
   [ALERT_NODES_CHANGED]: NodesChangedAlert,
   [ALERT_LOGSTASH_VERSION_MISMATCH]: LogstashVersionMismatchAlert,
   [ALERT_KIBANA_VERSION_MISMATCH]: KibanaVersionMismatchAlert,

diff --git a/x-pack/plugins/monitoring/server/alerts/base_alert.ts b/x-pack/plugins/monitoring/server/alerts/base_alert.ts
@@ -377,4 +377,12 @@ export class BaseAlert {
   ) {
     throw new Error('Child classes must implement `executeActions`');
   }
+
+  protected createGlobalStateLink(link: string, clusterUuid: string, ccs?: string) {
+    const globalState = [`cluster_uuid:${clusterUuid}`];
+    if (ccs) {
+      globalState.push(`ccs:${ccs}`);
+    }
+    return `${this.kibanaUrl}/app/monitoring#/${link}?_g=(${globalState.toString()})`;
+  }
 }
diff --git a/x-pack/plugins/monitoring/server/alerts/cpu_usage_alert.test.ts b/x-pack/plugins/monitoring/server/alerts/cpu_usage_alert.test.ts
@@ -78,7 +78,6 @@ describe('CpuUsageAlert', () => {
     };
     const kibanaUrl = 'http://localhost:5601';
 
-    const hasScheduledActions = jest.fn();
     const replaceState = jest.fn();
     const scheduleActions = jest.fn();
     const getState = jest.fn();
@@ -87,7 +86,6 @@ describe('CpuUsageAlert', () => {
         callCluster: jest.fn(),
         alertInstanceFactory: jest.fn().mockImplementation(() => {
           return {
-            hasScheduledActions,
             replaceState,
             scheduleActions,
             getState,
@@ -154,7 +152,7 @@ describe('CpuUsageAlert', () => {
                         endToken: '#end_link',
                         type: 'docLink',
                         partialUrl:
-                          '{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/cluster-nodes-hot-threads.html',
+                          '{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/cluster-nodes-hot-threads.html',
                       },
                     ],
                   },
@@ -166,7 +164,7 @@ describe('CpuUsageAlert', () => {
                         endToken: '#end_link',
                         type: 'docLink',
                         partialUrl:
-                          '{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/tasks.html',
+                          '{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/tasks.html',
                       },
                     ],
                   },
@@ -506,7 +504,7 @@ describe('CpuUsageAlert', () => {
                         endToken: '#end_link',
                         type: 'docLink',
                         partialUrl:
-                          '{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/cluster-nodes-hot-threads.html',
+                          '{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/cluster-nodes-hot-threads.html',
                       },
                     ],
                   },
@@ -518,7 +516,7 @@ describe('CpuUsageAlert', () => {
                         endToken: '#end_link',
                         type: 'docLink',
                         partialUrl:
-                          '{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/tasks.html',
+                          '{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/tasks.html',
                       },
                     ],
                   },

diff --git a/x-pack/plugins/monitoring/server/alerts/cpu_usage_alert.ts b/x-pack/plugins/monitoring/server/alerts/cpu_usage_alert.ts
@@ -193,13 +193,13 @@ export class CpuUsageAlert extends BaseAlert {
           i18n.translate('xpack.monitoring.alerts.cpuUsage.ui.nextSteps.hotThreads', {
             defaultMessage: '#start_linkCheck hot threads#end_link',
           }),
-          `{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/cluster-nodes-hot-threads.html`
+          `{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/cluster-nodes-hot-threads.html`
         ),
         createLink(
           i18n.translate('xpack.monitoring.alerts.cpuUsage.ui.nextSteps.runningTasks', {
             defaultMessage: '#start_linkCheck long running tasks#end_link',
           }),
-          `{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/tasks.html`
+          `{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/tasks.html`
         ),
       ],
       tokens: [

diff --git a/x-pack/plugins/monitoring/server/alerts/disk_usage_alert.test.ts b/x-pack/plugins/monitoring/server/alerts/disk_usage_alert.test.ts
@@ -89,7 +89,6 @@ describe('DiskUsageAlert', () => {
     };
     const kibanaUrl = 'http://localhost:5601';
 
-    const hasScheduledActions = jest.fn();
     const replaceState = jest.fn();
     const scheduleActions = jest.fn();
     const getState = jest.fn();
@@ -98,7 +97,6 @@ describe('DiskUsageAlert', () => {
         callCluster: jest.fn(),
         alertInstanceFactory: jest.fn().mockImplementation(() => {
           return {
-            hasScheduledActions,
             replaceState,
             scheduleActions,
             getState,

diff --git a/x-pack/plugins/monitoring/server/alerts/disk_usage_alert.ts b/x-pack/plugins/monitoring/server/alerts/disk_usage_alert.ts
@@ -109,13 +109,13 @@ export class DiskUsageAlert extends BaseAlert {
 
   protected filterAlertInstance(alertInstance: RawAlertInstance, filters: CommonAlertFilter[]) {
     const alertInstanceStates = alertInstance.state?.alertStates as AlertDiskUsageState[];
-    const nodeUuid = filters?.find((filter) => filter.nodeUuid);
+    const nodeFilter = filters?.find((filter) => filter.nodeUuid);
 
-    if (!filters || !filters.length || !alertInstanceStates?.length || !nodeUuid) {
+    if (!filters || !filters.length || !alertInstanceStates?.length || !nodeFilter?.nodeUuid) {
       return true;
     }
 
-    const nodeAlerts = alertInstanceStates.filter(({ nodeId }) => nodeId === nodeUuid);
+    const nodeAlerts = alertInstanceStates.filter(({ nodeId }) => nodeId === nodeFilter.nodeUuid);
     return Boolean(nodeAlerts.length);
   }
 
@@ -160,7 +160,7 @@ export class DiskUsageAlert extends BaseAlert {
           i18n.translate('xpack.monitoring.alerts.diskUsage.ui.nextSteps.tuneDisk', {
             defaultMessage: '#start_linkTune for disk usage#end_link',
           }),
-          `{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/tune-for-disk-usage.html`
+          `{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/tune-for-disk-usage.html`
         ),
         createLink(
           i18n.translate('xpack.monitoring.alerts.diskUsage.ui.nextSteps.identifyIndices', {
@@ -173,19 +173,19 @@ export class DiskUsageAlert extends BaseAlert {
           i18n.translate('xpack.monitoring.alerts.diskUsage.ui.nextSteps.ilmPolicies', {
             defaultMessage: '#start_linkImplement ILM policies#end_link',
           }),
-          `{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/index-lifecycle-management.html`
+          `{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/index-lifecycle-management.html`
         ),
         createLink(
           i18n.translate('xpack.monitoring.alerts.diskUsage.ui.nextSteps.addMoreNodes', {
             defaultMessage: '#start_linkAdd more data nodes#end_link',
           }),
-          `{elasticWebsiteUrl}/guide/en/elasticsearch/reference/{docLinkVersion}/add-elasticsearch-nodes.html`
+          `{elasticWebsiteUrl}guide/en/elasticsearch/reference/{docLinkVersion}/add-elasticsearch-nodes.html`
         ),
         createLink(
           i18n.translate('xpack.monitoring.alerts.diskUsage.ui.nextSteps.resizeYourDeployment', {
             defaultMessage: '#start_linkResize your deployment (ECE)#end_link',
           }),
-          `{elasticWebsiteUrl}/guide/en/cloud-enterprise/current/ece-resize-deployment.html`
+          `{elasticWebsiteUrl}guide/en/cloud-enterprise/current/ece-resize-deployment.html`
         ),
       ],
       tokens: [
@@ -331,7 +331,7 @@ export class DiskUsageAlert extends BaseAlert {
 
       const alertInstanceState = { alertStates: newAlertStates };
       instance.replaceState(alertInstanceState);
-      if (newAlertStates.length && !instance.hasScheduledActions()) {
+      if (newAlertStates.length) {
         this.executeActions(instance, alertInstanceState, null, cluster);
         state.lastExecutedAction = currentUTC;
       }

diff --git a/x-pack/plugins/monitoring/server/alerts/index.ts b/x-pack/plugins/monitoring/server/alerts/index.ts
@@ -8,6 +8,7 @@ export { BaseAlert } from './base_alert';
 export { CpuUsageAlert } from './cpu_usage_alert';
 export { MissingMonitoringDataAlert } from './missing_monitoring_data_alert';
 export { DiskUsageAlert } from './disk_usage_alert';
+export { MemoryUsageAlert } from './memory_usage_alert';
 export { ClusterHealthAlert } from './cluster_health_alert';
 export { LicenseExpirationAlert } from './license_expiration_alert';
 export { NodesChangedAlert } from './nodes_changed_alert';