[ResponseOps][Rules] Move APM rule types params to the @kbn/response-ops-rule-params package

packages/response-ops/rule_params/apm_anomaly/index.ts

@@ -0,0 +1,14 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { anomalyParamsSchema } from './latest';
+export { anomalyParamsSchema as anomalyParamsSchemaV1 } from './v1';
+
+export type { AnomalyRuleParams } from './latest';
+export type { AnomalyRuleParams as AnomalyRuleParamsV1 } from './v1';

packages/response-ops/rule_params/apm_anomaly/latest.ts

@@ -0,0 +1,10 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export * from './v1';

packages/response-ops/rule_params/apm_anomaly/v1.ts

@@ -0,0 +1,40 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { TypeOf, schema } from '@kbn/config-schema';
+import { ML_ANOMALY_SEVERITY } from '@kbn/ml-anomaly-utils/anomaly_severity';
+
+export enum AnomalyDetectorType {
+  txLatency = 'txLatency',
+  txThroughput = 'txThroughput',
+  txFailureRate = 'txFailureRate',
+}
+
+const detectorsSchema = schema.oneOf([
+  schema.literal(AnomalyDetectorType.txLatency),
+  schema.literal(AnomalyDetectorType.txThroughput),
+  schema.literal(AnomalyDetectorType.txFailureRate),
+]);
+
+export const anomalyParamsSchema = schema.object({
+  serviceName: schema.maybe(schema.string()),
+  transactionType: schema.maybe(schema.string()),
+  windowSize: schema.number(),
+  windowUnit: schema.string(),
+  environment: schema.string(),
+  anomalySeverityType: schema.oneOf([
+    schema.literal(ML_ANOMALY_SEVERITY.CRITICAL),
+    schema.literal(ML_ANOMALY_SEVERITY.MAJOR),
+    schema.literal(ML_ANOMALY_SEVERITY.MINOR),
+    schema.literal(ML_ANOMALY_SEVERITY.WARNING),
+  ]),
+  anomalyDetectorTypes: schema.maybe(schema.arrayOf(detectorsSchema, { minSize: 1 })),
+});
+
+export type AnomalyRuleParams = TypeOf<typeof anomalyParamsSchema>;

packages/response-ops/rule_params/common/index.ts

@@ -0,0 +1,10 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export * from './search_configuration_schema';

packages/response-ops/rule_params/common/search_configuration_schema.ts

@@ -0,0 +1,19 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { TypeOf, schema } from '@kbn/config-schema';
+
+export const searchConfigurationSchema = schema.object({
+  query: schema.object({
+    query: schema.oneOf([schema.string(), schema.recordOf(schema.string(), schema.any())]),
+    language: schema.string(),
+  }),
+});
+
+export type SearchConfigurationType = TypeOf<typeof searchConfigurationSchema>;

packages/response-ops/rule_params/error_count/index.ts

@@ -0,0 +1,14 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { errorCountParamsSchema } from './latest';
+export { errorCountParamsSchema as errorCountParamsSchemaV1 } from './v1';
+
+export type { ErrorCountRuleParams } from './latest';
+export type { ErrorCountRuleParams as ErrorCountRuleParamsV1 } from './v1';

packages/response-ops/rule_params/error_count/latest.ts

@@ -0,0 +1,10 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export * from './v1';

packages/response-ops/rule_params/error_count/v1.ts

@@ -0,0 +1,25 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { TypeOf, schema } from '@kbn/config-schema';
+import { searchConfigurationSchema } from '../common/search_configuration_schema';
+
+export const errorCountParamsSchema = schema.object({
+  windowSize: schema.number(),
+  windowUnit: schema.string(),
+  threshold: schema.number(),
+  serviceName: schema.maybe(schema.string()),
+  environment: schema.string(),
+  groupBy: schema.maybe(schema.arrayOf(schema.string())),
+  errorGroupingKey: schema.maybe(schema.string()),
+  useKqlFilter: schema.maybe(schema.boolean()),
+  searchConfiguration: schema.maybe(searchConfigurationSchema),
+});
+
+export type ErrorCountRuleParams = TypeOf<typeof errorCountParamsSchema>;

packages/response-ops/rule_params/kibana.jsonc

@@ -1,9 +1,7 @@
 {
   "type": "shared-common",
   "id": "@kbn/response-ops-rule-params",
-  "owner": [
-    "@elastic/response-ops"
-  ],
+  "owner": ["@elastic/response-ops"],
   "group": "platform",
-  "visibility": "private"
-}
+  "visibility": "shared"
+}

packages/response-ops/rule_params/transaction_duration/index.ts

@@ -0,0 +1,14 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { transactionDurationParamsSchema } from './latest';
+export { transactionDurationParamsSchema as transactionDurationParamsSchemaV1 } from './v1';
+
+export type { TransactionDurationRuleParams } from './latest';
+export type { TransactionDurationRuleParams as TransactionDurationRuleParamsV1 } from './v1';

packages/response-ops/rule_params/transaction_duration/latest.ts

@@ -0,0 +1,10 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export * from './v1';

packages/response-ops/rule_params/transaction_duration/v1.ts

@@ -0,0 +1,37 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { TypeOf, schema } from '@kbn/config-schema';
+import { searchConfigurationSchema } from '../common/search_configuration_schema';
+
+export enum AggregationType {
+  Avg = 'avg',
+  P95 = '95th',
+  P99 = '99th',
+}
+
+export const transactionDurationParamsSchema = schema.object({
+  serviceName: schema.maybe(schema.string()),
+  transactionType: schema.maybe(schema.string()),
+  transactionName: schema.maybe(schema.string()),
+  windowSize: schema.number(),
+  windowUnit: schema.string(),
+  threshold: schema.number(),
+  aggregationType: schema.oneOf([
+    schema.literal(AggregationType.Avg),
+    schema.literal(AggregationType.P95),
+    schema.literal(AggregationType.P99),
+  ]),
+  environment: schema.string(),
+  groupBy: schema.maybe(schema.arrayOf(schema.string())),
+  useKqlFilter: schema.maybe(schema.boolean()),
+  searchConfiguration: schema.maybe(searchConfigurationSchema),
+});
+
+export type TransactionDurationRuleParams = TypeOf<typeof transactionDurationParamsSchema>;

packages/response-ops/rule_params/transaction_error_rate/index.ts

@@ -0,0 +1,14 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export { transactionErrorRateParamsSchema } from './latest';
+export { transactionErrorRateParamsSchema as transactionErrorRateParamsSchemaV1 } from './v1';
+
+export type { TransactionErrorRateRuleParams } from './latest';
+export type { TransactionErrorRateRuleParams as TransactionErrorRateRuleParamsV1 } from './v1';

packages/response-ops/rule_params/transaction_error_rate/latest.ts

@@ -0,0 +1,10 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export * from './v1';

packages/response-ops/rule_params/transaction_error_rate/v1.ts

@@ -0,0 +1,26 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { TypeOf, schema } from '@kbn/config-schema';
+import { searchConfigurationSchema } from '../common/search_configuration_schema';
+
+export const transactionErrorRateParamsSchema = schema.object({
+  windowSize: schema.number(),
+  windowUnit: schema.string(),
+  threshold: schema.number(),
+  transactionType: schema.maybe(schema.string()),
+  transactionName: schema.maybe(schema.string()),
+  serviceName: schema.maybe(schema.string()),
+  environment: schema.string(),
+  groupBy: schema.maybe(schema.arrayOf(schema.string())),
+  useKqlFilter: schema.maybe(schema.boolean()),
+  searchConfiguration: schema.maybe(searchConfigurationSchema),
+});
+
+export type TransactionErrorRateRuleParams = TypeOf<typeof transactionErrorRateParamsSchema>;

packages/response-ops/rule_params/tsconfig.json

@@ -2,18 +2,9 @@
   "extends": "../../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "target/types",
-    "types": [
-      "jest",
-      "node"
-    ]
+    "types": ["jest", "node"]
   },
-  "include": [
-    "**/*.ts",
-  ],
-  "exclude": [
-    "target/**/*"
-  ],
-  "kbn_references": [
-    "@kbn/config-schema",
-  ]
+  "include": ["**/*.ts"],
+  "exclude": ["target/**/*"],
+  "kbn_references": ["@kbn/config-schema", "@kbn/ml-anomaly-utils"]
 }

packages/response-ops/rule_params/v1.ts

@@ -8,10 +8,20 @@
  */
 
 import { TypeOf, schema } from '@kbn/config-schema';
+import { transactionDurationParamsSchema as transactionDurationParamsSchemaV1 } from './transaction_duration/v1';
+import { anomalyParamsSchema as anomalyParamsSchemaV1 } from './apm_anomaly/v1';
+import { errorCountParamsSchema as errorCountParamsSchemaV1 } from './error_count/v1';
+import { transactionErrorRateParamsSchema as transactionErrorRateParamsSchemaV1 } from './transaction_error_rate/v1';
 
-export const ruleParamsSchema = schema.recordOf(schema.string(), schema.maybe(schema.any()), {
-  meta: { description: 'The parameters for the rule.' },
-});
+export const ruleParamsSchema = schema.oneOf([
+  transactionDurationParamsSchemaV1,
+  anomalyParamsSchemaV1,
+  errorCountParamsSchemaV1,
+  transactionErrorRateParamsSchemaV1,
+  schema.recordOf(schema.string(), schema.maybe(schema.any()), {
+    meta: { description: 'The parameters for the rule.' },
+  }),
+]);
 
 export const ruleParamsSchemaWithDefaultValue = schema.recordOf(
   schema.string(),

x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/bulk_edit_rules.ts

@@ -513,7 +513,7 @@ async function updateRuleAttributesAndParamsInMemory<Params extends RuleParams>(
 
     // Increment revision if params ended up being modified AND it wasn't already incremented as part of attribute update
     if (
-      shouldIncrementRevision(ruleParams) &&
+      shouldIncrementRevision(ruleParams as Params) &&
       !isParamsUpdateSkipped &&
       rule.attributes.revision === updatedRule.revision
     ) {

x-pack/plugins/observability_solution/apm/common/rules/apm_rule_types.ts

@@ -13,6 +13,10 @@ import { formatDurationFromTimeUnitChar } from '@kbn/observability-plugin/common
 import { ML_ANOMALY_SEVERITY } from '@kbn/ml-anomaly-utils/anomaly_severity';
 import { ML_ANOMALY_THRESHOLD } from '@kbn/ml-anomaly-utils/anomaly_threshold';
 import { ApmRuleType } from '@kbn/rule-data-utils';
+import { ErrorCountRuleParams } from '@kbn/response-ops-rule-params/error_count';
+import { TransactionDurationRuleParams } from '@kbn/response-ops-rule-params/transaction_duration';
+import { AnomalyRuleParams } from '@kbn/response-ops-rule-params/apm_anomaly';
+import { TransactionErrorRateRuleParams } from '@kbn/response-ops-rule-params/transaction_error_rate';
 import {
   ERROR_GROUP_ID,
   ERROR_GROUP_NAME,
@@ -32,6 +36,13 @@ export enum AggregationType {
   P99 = '99th',
 }
 
+export interface ApmRuleParamsType {
+  [ApmRuleType.TransactionDuration]: TransactionDurationRuleParams;
+  [ApmRuleType.ErrorCount]: ErrorCountRuleParams;
+  [ApmRuleType.Anomaly]: AnomalyRuleParams;
+  [ApmRuleType.TransactionErrorRate]: TransactionErrorRateRuleParams;
+}
+
 export const THRESHOLD_MET_GROUP_ID = 'threshold_met';
 export type ThresholdMetActionGroupId = typeof THRESHOLD_MET_GROUP_ID;
 export const THRESHOLD_MET_GROUP: ActionGroup<ThresholdMetActionGroupId> = {