[7.x] [RAC] Rule registry plugin (#95903) (#96689)

Co-authored-by: Kibana Machine <[email protected]>

Co-authored-by: Kibana Machine <[email protected]>

docs/developer/plugin-list.asciidoc

@@ -485,6 +485,10 @@ Elastic.
 |Welcome to the Kibana rollup plugin! This plugin provides Kibana support for Elasticsearch's rollup feature. Please refer to the Elasticsearch documentation to understand rollup indices and how to create rollup jobs.
 
 
+|{kib-repo}blob/{branch}/x-pack/plugins/rule_registry/README.md[ruleRegistry]
+|The rule registry plugin aims to make it easy for rule type producers to have their rules produce the data that they need to build rich experiences on top of a unified experience, without the risk of mapping conflicts.
+
+
 |{kib-repo}blob/{branch}/x-pack/plugins/runtime_fields/README.md[runtimeFields]
 |Welcome to the home of the runtime field editor and everything related to runtime fields!
 

typings/elasticsearch/search.d.ts

@@ -370,6 +370,16 @@ export type AggregateOf<
   missing: {
     doc_count: number;
   } & SubAggregateOf<TAggregationContainer, TDocument>;
+  multi_terms: {
+    doc_count_error_upper_bound: number;
+    sum_other_doc_count: number;
+    buckets: Array<
+      {
+        doc_count: number;
+        key: string[];
+      } & SubAggregateOf<TAggregationContainer, TDocument>
+    >;
+  };
   nested: {
     doc_count: number;
   } & SubAggregateOf<TAggregationContainer, TDocument>;

x-pack/plugins/apm/common/environment_filter_values.ts

@@ -22,11 +22,13 @@ const environmentLabels: Record<string, string> = {
 };
 
 export const ENVIRONMENT_ALL = {
+  esFieldValue: undefined,
   value: ENVIRONMENT_ALL_VALUE,
   text: environmentLabels[ENVIRONMENT_ALL_VALUE],
 };
 
 export const ENVIRONMENT_NOT_DEFINED = {
+  esFieldValue: undefined,
   value: ENVIRONMENT_NOT_DEFINED_VALUE,
   text: environmentLabels[ENVIRONMENT_NOT_DEFINED_VALUE],
 };
@@ -35,6 +37,22 @@ export function getEnvironmentLabel(environment: string) {
   return environmentLabels[environment] || environment;
 }
 
+export function parseEnvironmentUrlParam(environment: string) {
+  if (environment === ENVIRONMENT_ALL_VALUE) {
+    return ENVIRONMENT_ALL;
+  }
+
+  if (environment === ENVIRONMENT_NOT_DEFINED_VALUE) {
+    return ENVIRONMENT_NOT_DEFINED;
+  }
+
+  return {
+    esFieldValue: environment,
+    value: environment,
+    text: environment,
+  };
+}
+
 // returns the environment url param that should be used
 // based on the requested environment. If the requested
 // environment is different from the URL parameter, we'll

x-pack/plugins/apm/kibana.json

@@ -9,7 +9,8 @@
     "licensing",
     "triggersActionsUi",
     "embeddable",
-    "infra"
+    "infra",
+    "observability"
   ],
   "optionalPlugins": [
     "spaces",
@@ -18,7 +19,6 @@
     "taskManager",
     "actions",
     "alerting",
-    "observability",
     "security",
     "ml",
     "home",

x-pack/plugins/apm/scripts/optimize-tsconfig/tsconfig.json

@@ -2,6 +2,7 @@
   "include": [
     "./x-pack/plugins/apm/**/*",
     "./x-pack/plugins/observability/**/*",
+    "./x-pack/plugins/rule_registry/**/*",
     "./typings/**/*"
   ],
   "exclude": [

x-pack/plugins/apm/server/lib/alerts/action_variables.ts

@@ -13,28 +13,28 @@ export const apmActionVariables = {
       'xpack.apm.alerts.action_variables.serviceName',
       { defaultMessage: 'The service the alert is created for' }
     ),
-    name: 'serviceName',
+    name: 'serviceName' as const,
   },
   transactionType: {
     description: i18n.translate(
       'xpack.apm.alerts.action_variables.transactionType',
       { defaultMessage: 'The transaction type the alert is created for' }
     ),
-    name: 'transactionType',
+    name: 'transactionType' as const,
   },
   environment: {
     description: i18n.translate(
       'xpack.apm.alerts.action_variables.environment',
       { defaultMessage: 'The transaction type the alert is created for' }
     ),
-    name: 'environment',
+    name: 'environment' as const,
   },
   threshold: {
     description: i18n.translate('xpack.apm.alerts.action_variables.threshold', {
       defaultMessage:
         'Any trigger value above this value will cause the alert to fire',
     }),
-    name: 'threshold',
+    name: 'threshold' as const,
   },
   triggerValue: {
     description: i18n.translate(
@@ -44,7 +44,7 @@ export const apmActionVariables = {
           'The value that breached the threshold and triggered the alert',
       }
     ),
-    name: 'triggerValue',
+    name: 'triggerValue' as const,
   },
   interval: {
     description: i18n.translate(
@@ -54,6 +54,6 @@ export const apmActionVariables = {
           'The length and unit of the time period where the alert conditions were met',
       }
     ),
-    name: 'interval',
+    name: 'interval' as const,
   },
 };

x-pack/plugins/apm/server/lib/alerts/alerting_es_client.ts

@@ -5,28 +5,24 @@
  * 2.0.
  */
 
-import { ApiResponse } from '@elastic/elasticsearch';
-import { ThresholdMetActionGroupId } from '../../../common/alert_types';
 import {
   ESSearchRequest,
   ESSearchResponse,
 } from '../../../../../../typings/elasticsearch';
-import {
-  AlertInstanceContext,
-  AlertInstanceState,
-  AlertServices,
-} from '../../../../alerting/server';
+import { AlertServices } from '../../../../alerting/server';
 
-export function alertingEsClient<TParams extends ESSearchRequest>(
-  services: AlertServices<
-    AlertInstanceState,
-    AlertInstanceContext,
-    ThresholdMetActionGroupId
-  >,
+export async function alertingEsClient<TParams extends ESSearchRequest>(
+  scopedClusterClient: AlertServices<
+    never,
+    never,
+    never
+  >['scopedClusterClient'],
   params: TParams
-): Promise<ApiResponse<ESSearchResponse<unknown, TParams>>> {
-  return (services.scopedClusterClient.asCurrentUser.search({
+): Promise<ESSearchResponse<unknown, TParams>> {
+  const response = await scopedClusterClient.asCurrentUser.search({
     ...params,
     ignore_unavailable: true,
-  }) as unknown) as Promise<ApiResponse<ESSearchResponse<unknown, TParams>>>;
+  });
+
+  return (response.body as unknown) as ESSearchResponse<unknown, TParams>;
 }

x-pack/plugins/apm/server/lib/alerts/create_apm_lifecycle_rule_type.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 { createLifecycleRuleTypeFactory } from '../../../../rule_registry/server';
+import { APMRuleRegistry } from '../../plugin';
+
+export const createAPMLifecycleRuleType = createLifecycleRuleTypeFactory<APMRuleRegistry>();

x-pack/plugins/apm/server/lib/alerts/register_apm_alerts.ts

@@ -6,38 +6,25 @@
  */
 
 import { Observable } from 'rxjs';
-import { AlertingPlugin } from '../../../../alerting/server';
-import { ActionsPlugin } from '../../../../actions/server';
+import { Logger } from 'kibana/server';
 import { registerTransactionDurationAlertType } from './register_transaction_duration_alert_type';
 import { registerTransactionDurationAnomalyAlertType } from './register_transaction_duration_anomaly_alert_type';
 import { registerErrorCountAlertType } from './register_error_count_alert_type';
 import { APMConfig } from '../..';
 import { MlPluginSetup } from '../../../../ml/server';
 import { registerTransactionErrorRateAlertType } from './register_transaction_error_rate_alert_type';
+import { APMRuleRegistry } from '../../plugin';
 
-interface Params {
-  alerting: AlertingPlugin['setup'];
-  actions: ActionsPlugin['setup'];
+export interface RegisterRuleDependencies {
+  registry: APMRuleRegistry;
   ml?: MlPluginSetup;
   config$: Observable<APMConfig>;
+  logger: Logger;
 }
 
-export function registerApmAlerts(params: Params) {
-  registerTransactionDurationAlertType({
-    alerting: params.alerting,
-    config$: params.config$,
-  });
-  registerTransactionDurationAnomalyAlertType({
-    alerting: params.alerting,
-    ml: params.ml,
-    config$: params.config$,
-  });
-  registerErrorCountAlertType({
-    alerting: params.alerting,
-    config$: params.config$,
-  });
-  registerTransactionErrorRateAlertType({
-    alerting: params.alerting,
-    config$: params.config$,
-  });
+export function registerApmAlerts(dependencies: RegisterRuleDependencies) {
+  registerTransactionDurationAlertType(dependencies);
+  registerTransactionDurationAnomalyAlertType(dependencies);
+  registerErrorCountAlertType(dependencies);
+  registerTransactionErrorRateAlertType(dependencies);
 }