[Transform] Transforms health alerting rule type

src/core/public/doc_links/doc_links_service.ts

@@ -270,6 +270,8 @@ export class DocLinksService {
         },
         transforms: {
           guide: `${ELASTICSEARCH_DOCS}transforms.html`,
+          // TODO add valid docs URL
+          alertingRules: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-configuring-alerts.html`,
         },
         visualize: {
           guide: `${KIBANA_DOCS}dashboard.html`,

x-pack/plugins/monitoring/common/constants.ts

@@ -8,6 +8,7 @@
 import { i18n } from '@kbn/i18n';
 import { CommonAlertParamDetail } from './types/alerts';
 import { AlertParamType } from './enums';
+import { TRANSFORM_RULE_TYPE } from '../../transform/common';
 
 /**
  * Helper string to add as a tag in every logging call
@@ -538,7 +539,8 @@ export const RULES = [
   RULE_THREAD_POOL_WRITE_REJECTIONS,
   RULE_CCR_READ_EXCEPTIONS,
   RULE_LARGE_SHARD_SIZE,
-];
+  TRANSFORM_RULE_TYPE.TRANSFORM_HEALTH,
+] as const;
 
 /**
  * A list of all legacy rules, which means they are powered by watcher

x-pack/plugins/monitoring/kibana.json

@@ -27,5 +27,5 @@
   ],
   "server": true,
   "ui": true,
-  "requiredBundles": ["kibanaUtils", "home", "alerting", "kibanaReact", "licenseManagement"]
+  "requiredBundles": ["kibanaUtils", "home", "alerting", "kibanaReact", "licenseManagement", "transform"]
 }

x-pack/plugins/monitoring/public/plugin.ts

@@ -37,6 +37,7 @@ import { createMemoryUsageAlertType } from './alerts/memory_usage_alert';
 import { createCCRReadExceptionsAlertType } from './alerts/ccr_read_exceptions_alert';
 import { createLargeShardSizeAlertType } from './alerts/large_shard_size_alert';
 import { setConfig } from './external_config';
+import { createTransformHealthRuleType } from '../../transform/public';
 
 interface MonitoringSetupPluginDependencies {
   home?: HomePublicPluginSetup;
@@ -213,6 +214,7 @@ export class MonitoringPlugin
     );
     ruleTypeRegistry.register(createCCRReadExceptionsAlertType());
     ruleTypeRegistry.register(createLargeShardSizeAlertType());
+    ruleTypeRegistry.register(createTransformHealthRuleType());
     const legacyAlertTypes = createLegacyAlertTypes();
     for (const legacyAlertType of legacyAlertTypes) {
       ruleTypeRegistry.register(legacyAlertType);

x-pack/plugins/monitoring/server/plugin.test.ts

@@ -7,7 +7,6 @@
 
 import { coreMock } from 'src/core/server/mocks';
 import { MonitoringPlugin } from './plugin';
-import { AlertsFactory } from './alerts';
 
 jest.mock('./es_client/instantiate_client', () => ({
   instantiateClient: jest.fn().mockImplementation(() => ({
@@ -72,9 +71,8 @@ describe('Monitoring plugin', () => {
   });
 
   it('should register all alerts', async () => {
-    const alerts = AlertsFactory.getAll();
     const plugin = new MonitoringPlugin(initializerContext as any);
     await plugin.setup(coreSetup as any, setupPlugins as any);
-    expect(setupPlugins.alerting.registerType).toHaveBeenCalledTimes(alerts.length);
+    expect(setupPlugins.alerting.registerType).toHaveBeenCalledTimes(16);
   });
 });

x-pack/plugins/monitoring/server/plugin.ts

@@ -51,6 +51,7 @@ import {
   PluginsStart,
   RequestHandlerContextMonitoringPlugin,
 } from './types';
+import { getTransformHealthRuleType } from '../../transform/server';
 
 // This is used to test the version of kibana
 const snapshotRegex = /-snapshot/i;
@@ -127,6 +128,8 @@ export class MonitoringPlugin
     for (const alert of alerts) {
       plugins.alerting?.registerType(alert.getRuleType());
     }
+    plugins.alerting?.registerType(getTransformHealthRuleType());
+
     const config = createConfig(this.initializerContext.config.get<TypeOf<typeof configSchema>>());
 
     // Register collector objects for stats to show up in the APIs

x-pack/plugins/monitoring/tsconfig.json

@@ -31,5 +31,6 @@
     { "path": "../observability/tsconfig.json" },
     { "path": "../telemetry_collection_xpack/tsconfig.json" },
     { "path": "../triggers_actions_ui/tsconfig.json" },
+    { "path": "../transform/tsconfig.json" },
   ]
 }

x-pack/plugins/transform/common/constants.ts

@@ -8,6 +8,7 @@
 import { i18n } from '@kbn/i18n';
 
 import { LicenseType } from '../../licensing/common/types';
+import { TransformHealthTests } from './types/alerting';
 
 export const DEFAULT_REFRESH_INTERVAL_MS = 30000;
 export const MINIMUM_REFRESH_INTERVAL_MS = 1000;
@@ -105,3 +106,26 @@ export const TRANSFORM_FUNCTION = {
 } as const;
 
 export type TransformFunction = typeof TRANSFORM_FUNCTION[keyof typeof TRANSFORM_FUNCTION];
+
+export const TRANSFORM_RULE_TYPE = {
+  TRANSFORM_HEALTH: 'transform_health',
+} as const;
+
+export const ALL_TRANSFORMS_SELECTION = '*';
+
+export const TRANSFORM_HEALTH_CHECK_NAMES: Record<
+  TransformHealthTests,
+  { name: string; description: string }
+> = {
+  notStarted: {
+    name: i18n.translate('xpack.transform.alertTypes.transformHealth.notStartedCheckName', {
+      defaultMessage: 'Transform is not started',
+    }),
+    description: i18n.translate(
+      'xpack.transform.alertTypes.transformHealth.notStartedCheckDescription',
+      {
+        defaultMessage: 'Get alerted if the transform is not started or indexing any data.',
+      }
+    ),
+  },
+};

x-pack/plugins/transform/common/index.ts

@@ -0,0 +1,8 @@
+/*
+ * 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 { TRANSFORM_RULE_TYPE } from './constants';

x-pack/plugins/transform/common/types/alerting.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { AlertTypeParams } from '../../../alerting/common';
+
+export type TransformHealthRuleParams = {
+  includeTransforms?: string[];
+  excludeTransforms?: string[] | null;
+  testsConfig?: {
+    notStarted?: {
+      enabled: boolean;
+    } | null;
+  } | null;
+} & AlertTypeParams;
+
+export type TransformHealthRuleTestsConfig = TransformHealthRuleParams['testsConfig'];
+
+export type TransformHealthTests = keyof Exclude<TransformHealthRuleTestsConfig, null | undefined>;

x-pack/plugins/transform/common/types/common.ts

@@ -20,3 +20,7 @@ export function dictionaryToArray<TValue>(dict: Dictionary<TValue>): TValue[] {
 export type DeepPartial<T> = {
   [P in keyof T]?: DeepPartial<T[P]>;
 };
+
+export function isDefined<T>(argument: T | undefined | null): argument is T {
+  return argument !== undefined && argument !== null;
+}

x-pack/plugins/transform/common/utils/alerts.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 { TransformHealthRuleTestsConfig } from '../types/alerting';
+
+export function getResultTestConfig(config: TransformHealthRuleTestsConfig) {
+  return {
+    notStarted: {
+      enabled: config?.notStarted?.enabled ?? true,
+    },
+  };
+}

x-pack/plugins/transform/kibana.json

@@ -10,11 +10,14 @@
     "management",
     "features",
     "savedObjects",
-    "share"
+    "share",
+    "triggersActionsUi",
+    "fieldFormats"
   ],
   "optionalPlugins": [
     "security",
-    "usageCollection"
+    "usageCollection",
+    "alerting"
   ],
   "configPath": ["xpack", "transform"],
   "requiredBundles": [
@@ -24,6 +27,9 @@
     "kibanaReact",
     "ml"
   ],
+  "extraPublicDirs": [
+    "common"
+  ],
   "owner": {
     "name": "Machine Learning UI",
     "githubTeam": "ml-ui"

x-pack/plugins/transform/public/alerting/index.ts

@@ -0,0 +1,8 @@
+/*
+ * 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 { createTransformHealthRuleType } from './transform_health_rule_type';

x-pack/plugins/transform/public/alerting/transform_health_rule_type/index.ts

@@ -0,0 +1,8 @@
+/*
+ * 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 { createTransformHealthRuleType } from './register_transform_health_rule';

x-pack/plugins/transform/public/alerting/transform_health_rule_type/register_transform_health_rule.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 { lazy } from 'react';
+import { i18n } from '@kbn/i18n';
+import { TRANSFORM_RULE_TYPE } from '../../../common';
+import type { TransformHealthRuleParams } from '../../../common/types/alerting';
+import type { AlertTypeModel } from '../../../../triggers_actions_ui/public';
+
+export function createTransformHealthRuleType(): AlertTypeModel<TransformHealthRuleParams> {
+  return {
+    id: TRANSFORM_RULE_TYPE.TRANSFORM_HEALTH,
+    description: i18n.translate('xpack.transform.alertingRuleTypes.transformHealth.description', {
+      defaultMessage: 'Alert when transform jobs experience operational issues.',
+    }),
+    iconClass: 'bell',
+    documentationUrl(docLinks) {
+      return docLinks.links.transforms.alertingRules;
+    },
+    alertParamsExpression: lazy(() => import('./transform_health_rule_trigger')),
+    validate: (alertParams: TransformHealthRuleParams) => {
+      const validationResult = {
+        errors: {
+          includeTransforms: new Array<string>(),
+        } as Record<keyof TransformHealthRuleParams, string[]>,
+      };
+
+      return validationResult;
+    },
+    requiresAppContext: false,
+    defaultActionMessage: i18n.translate(
+      'xpack.transform.alertTypes.transformHealth.defaultActionMessage',
+      {
+        defaultMessage: `[\\{\\{rule.name\\}\\}] Transforms health check result:
+\\{\\{context.message\\}\\}
+\\{\\{#context.results\\}\\}
+  Transform ID: \\{\\{transform_id\\}\\}
+  \\{\\{#description\\}\\}Transform description: \\{\\{description\\}\\}
+  \\{\\{/description\\}\\}\\{\\{#transform_state\\}\\}Transform state: \\{\\{transform_state\\}\\}
+  \\{\\{/transform_state\\}\\}\\{\\{#failure_reason\\}\\}Failure reason: \\{\\{failure_reason\\}\\}
+  \\{\\{/failure_reason\\}\\}\\{\\{#notification_message\\}\\}Notification message: \\{\\{notification_message\\}\\}
+  \\{\\{/notification_message\\}\\}\\{\\{#node_name\\}\\}Node name: \\{\\{node_name\\}\\}
+  \\{\\{/node_name\\}\\}\\{\\{#timestamp\\}\\}Timestamp: \\{\\{timestamp\\}\\}
+  \\{\\{/timestamp\\}\\}
+\\{\\{/context.results\\}\\}
+`,
+      }
+    ),
+  };
+}

x-pack/plugins/transform/public/alerting/transform_health_rule_type/tests_selection_control.tsx

@@ -0,0 +1,78 @@
+/*
+ * 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 React, { FC, useCallback } from 'react';
+import { EuiDescribedFormGroup, EuiForm, EuiFormRow, EuiSpacer, EuiSwitch } from '@elastic/eui';
+import { FormattedMessage } from '@kbn/i18n/react';
+
+import {
+  TransformHealthRuleTestsConfig,
+  TransformHealthTests,
+} from '../../../common/types/alerting';
+import { getResultTestConfig } from '../../../common/utils/alerts';
+import { TRANSFORM_HEALTH_CHECK_NAMES } from '../../../common/constants';
+
+interface TestsSelectionControlProps {
+  config: TransformHealthRuleTestsConfig;
+  onChange: (update: TransformHealthRuleTestsConfig) => void;
+  errors?: string[];
+}
+
+export const TestsSelectionControl: FC<TestsSelectionControlProps> = React.memo(
+  ({ config, onChange, errors }) => {
+    const uiConfig = getResultTestConfig(config);
+
+    const updateCallback = useCallback(
+      (update: Partial<Exclude<TransformHealthRuleTestsConfig, undefined>>) => {
+        onChange({
+          ...(config ?? {}),
+          ...update,
+        });
+      },
+      [onChange, config]
+    );
+
+    return (
+      <>
+        <EuiForm component="div" isInvalid={!!errors?.length} error={errors}>
+          {(Object.entries(uiConfig) as Array<
+            [TransformHealthTests, typeof uiConfig[TransformHealthTests]]
+          >).map(([name, conf], i) => {
+            return (
+              <EuiDescribedFormGroup
+                key={name}
+                title={<h4>{TRANSFORM_HEALTH_CHECK_NAMES[name]?.name}</h4>}
+                description={TRANSFORM_HEALTH_CHECK_NAMES[name]?.description}
+                fullWidth
+                gutterSize={'s'}
+              >
+                <EuiFormRow>
+                  <EuiSwitch
+                    label={
+                      <FormattedMessage
+                        id="xpack.transform.alertTypes.transformHealth.testsSelection.enableTestLabel"
+                        defaultMessage="Enable"
+                      />
+                    }
+                    onChange={updateCallback.bind(null, {
+                      [name]: {
+                        ...uiConfig[name],
+                        enabled: !uiConfig[name].enabled,
+                      },
+                    })}
+                    checked={uiConfig[name].enabled}
+                  />
+                </EuiFormRow>
+              </EuiDescribedFormGroup>
+            );
+          })}
+        </EuiForm>
+        <EuiSpacer size="l" />
+      </>
+    );
+  }
+);