[8.x] [ResponseOps][Rules] Move APM rule types params to the @kbn/response-ops-rule-params package (#204637)

.github/CODEOWNERS

@@ -750,7 +750,7 @@ examples/resizable_layout_examples @elastic/kibana-data-discovery
 x-pack/test/plugin_functional/plugins/resolver_test @elastic/security-solution
 packages/response-ops/feature_flag_service @elastic/response-ops
 packages/response-ops/rule_form @elastic/response-ops
-src/platform/packages/private/response-ops/rule_params @elastic/response-ops
+src/platform/packages/shared/response-ops/rule_params @elastic/response-ops
 examples/response_stream @elastic/ml-ui
 src/platform/packages/shared/kbn-rison @elastic/kibana-operations
 x-pack/platform/packages/private/rollup @elastic/kibana-management

package.json

@@ -762,7 +762,7 @@
     "@kbn/resolver-test-plugin": "link:x-pack/test/plugin_functional/plugins/resolver_test",
     "@kbn/response-ops-feature-flag-service": "link:packages/response-ops/feature_flag_service",
     "@kbn/response-ops-rule-form": "link:packages/response-ops/rule_form",
-    "@kbn/response-ops-rule-params": "link:src/platform/packages/private/response-ops/rule_params",
+    "@kbn/response-ops-rule-params": "link:src/platform/packages/shared/response-ops/rule_params",
     "@kbn/response-stream-plugin": "link:examples/response_stream",
     "@kbn/rison": "link:src/platform/packages/shared/kbn-rison",
     "@kbn/rollup": "link:x-pack/platform/packages/private/rollup",

src/platform/packages/shared/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';

src/platform/packages/shared/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>;

src/platform/packages/shared/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';

src/platform/packages/shared/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>;

src/platform/packages/shared/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';

src/platform/packages/shared/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';

src/platform/packages/shared/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>;

src/platform/packages/private/response-ops/rule_params/jest.config.js → src/platform/packages/shared/response-ops/rule_params/jest.config.js

@@ -10,5 +10,5 @@
 module.exports = {
   preset: '@kbn/test/jest_node',
   rootDir: '../../../../../..',
-  roots: ['<rootDir>/src/platform/packages/private/response-ops/rule_params'],
+  roots: ['<rootDir>/src/platform/packages/shared/response-ops/rule_params'],
 };

src/platform/packages/private/response-ops/rule_params/kibana.jsonc → src/platform/packages/shared/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"
+}

src/platform/packages/shared/response-ops/rule_params/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';

src/platform/packages/shared/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';

src/platform/packages/shared/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';

src/platform/packages/shared/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>;

src/platform/packages/shared/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';

src/platform/packages/shared/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';

src/platform/packages/shared/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>;

src/platform/packages/shared/response-ops/rule_params/tsconfig.json

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

tsconfig.base.json

@@ -1494,8 +1494,8 @@
       "@kbn/response-ops-feature-flag-service/*": ["packages/response-ops/feature_flag_service/*"],
       "@kbn/response-ops-rule-form": ["packages/response-ops/rule_form"],
       "@kbn/response-ops-rule-form/*": ["packages/response-ops/rule_form/*"],
-      "@kbn/response-ops-rule-params": ["src/platform/packages/private/response-ops/rule_params"],
-      "@kbn/response-ops-rule-params/*": ["src/platform/packages/private/response-ops/rule_params/*"],
+      "@kbn/response-ops-rule-params": ["src/platform/packages/shared/response-ops/rule_params"],
+      "@kbn/response-ops-rule-params/*": ["src/platform/packages/shared/response-ops/rule_params/*"],
       "@kbn/response-stream-plugin": ["examples/response_stream"],
       "@kbn/response-stream-plugin/*": ["examples/response_stream/*"],
       "@kbn/rison": ["src/platform/packages/shared/kbn-rison"],

x-pack/platform/plugins/shared/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/solutions/observability/plugins/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 type { ErrorCountRuleParams } from '@kbn/response-ops-rule-params/error_count';
+import type { TransactionDurationRuleParams } from '@kbn/response-ops-rule-params/transaction_duration';
+import type { AnomalyRuleParams } from '@kbn/response-ops-rule-params/apm_anomaly';
+import type { 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> = {

x-pack/solutions/observability/plugins/apm/public/components/alerting/rule_types/transaction_duration_rule_type/index.tsx

@@ -15,7 +15,7 @@ import { ForLastExpression, TIME_UNITS } from '@kbn/triggers-actions-ui-plugin/p
 import { EuiFormRow } from '@elastic/eui';
 import { EuiSpacer } from '@elastic/eui';
 import { EuiSwitchEvent } from '@elastic/eui';
-import { SearchConfigurationType } from '../../../../../common/rules/schema';
+import { SearchConfigurationType } from '@kbn/response-ops-rule-params/common';
 import { AggregationType } from '../../../../../common/rules/apm_rule_types';
 import { ENVIRONMENT_ALL } from '../../../../../common/environment_filter_values';
 import { getDurationFormatter } from '../../../../../common/utils/formatters';

x-pack/solutions/observability/plugins/apm/public/components/alerting/rule_types/transaction_error_rate_rule_type/index.tsx

@@ -14,7 +14,7 @@ import { ForLastExpression, TIME_UNITS } from '@kbn/triggers-actions-ui-plugin/p
 import { EuiFormRow } from '@elastic/eui';
 import { EuiSpacer } from '@elastic/eui';
 import { EuiSwitchEvent } from '@elastic/eui';
-import { SearchConfigurationType } from '../../../../../common/rules/schema';
+import { SearchConfigurationType } from '@kbn/response-ops-rule-params/common';
 import { ENVIRONMENT_ALL } from '../../../../../common/environment_filter_values';
 import { asPercent } from '../../../../../common/utils/formatters';
 import { FETCH_STATUS, isPending, useFetcher } from '../../../../hooks/use_fetcher';