[8.x] [Response Ops][Alerting] Creating global service for fetching a…

…nd caching rules settings (elastic#192404) (elastic#193011) # Backport This will backport the following commits from `main` to `8.x`: - [[Response Ops][Alerting] Creating global service for fetching and caching rules settings (elastic#192404)](elastic#192404)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Ying Mao <[email protected]>
mikecote · Sep 16, 2024 · 7939f22 · 7939f22
1 parent 02f8d09
commit 7939f22
Show file tree

Hide file tree

Showing 38 changed files with 563 additions and 157 deletions.
diff --git a/x-pack/plugins/alerting/server/config.test.ts b/x-pack/plugins/alerting/server/config.test.ts
@@ -37,6 +37,9 @@ describe('config validation', () => {
             },
           },
         },
+        "rulesSettings": Object {
+          "cacheInterval": 60000,
+        },
       }
     `);
   });

diff --git a/x-pack/plugins/alerting/server/config.ts b/x-pack/plugins/alerting/server/config.ts
@@ -7,6 +7,7 @@
 
 import { schema, TypeOf } from '@kbn/config-schema';
 import { validateDurationSchema, parseDuration } from './lib';
+import { DEFAULT_CACHE_INTERVAL_MS } from './rules_settings';
 
 export const DEFAULT_MAX_ALERTS = 1000;
 const ONE_DAY_IN_MS = 24 * 60 * 60 * 1000;
@@ -74,6 +75,9 @@ export const configSchema = schema.object({
   enableFrameworkAlerts: schema.boolean({ defaultValue: true }),
   cancelAlertsOnRuleTimeout: schema.boolean({ defaultValue: true }),
   rules: rulesSchema,
+  rulesSettings: schema.object({
+    cacheInterval: schema.number({ defaultValue: DEFAULT_CACHE_INTERVAL_MS }),
+  }),
 });
 
 export type AlertingConfig = TypeOf<typeof configSchema>;

diff --git a/x-pack/plugins/alerting/server/plugin.ts b/x-pack/plugins/alerting/server/plugin.ts
@@ -66,7 +66,11 @@ import { ServerlessPluginSetup } from '@kbn/serverless/server';
 import { RuleTypeRegistry } from './rule_type_registry';
 import { TaskRunnerFactory } from './task_runner';
 import { RulesClientFactory } from './rules_client_factory';
-import { RulesSettingsClientFactory } from './rules_settings_client_factory';
+import {
+  RulesSettingsClientFactory,
+  RulesSettingsService,
+  getRulesSettingsFeature,
+} from './rules_settings';
 import { MaintenanceWindowClientFactory } from './maintenance_window_client_factory';
 import { ILicenseState, LicenseState } from './lib/license_state';
 import { AlertingRequestHandlerContext, ALERTING_FEATURE_ID, RuleAlertData } from './types';
@@ -106,7 +110,6 @@ import {
   type InitializationPromise,
   errorResult,
 } from './alerts_service';
-import { getRulesSettingsFeature } from './rules_settings_feature';
 import { maintenanceWindowFeature } from './maintenance_window_feature';
 import { ConnectorAdapterRegistry } from './connector_adapters/connector_adapter_registry';
 import { ConnectorAdapter, ConnectorAdapterParams } from './connector_adapters/types';
@@ -588,33 +591,38 @@ export class AlertingPlugin {
     };
 
     taskRunnerFactory.initialize({
-      logger,
+      actionsConfigMap: getActionsConfigMap(this.config.rules.run.actions),
+      actionsPlugin: plugins.actions,
+      alertsService: this.alertsService,
+      backfillClient: this.backfillClient!,
+      basePathService: core.http.basePath,
+      cancelAlertsOnRuleTimeout: this.config.cancelAlertsOnRuleTimeout,
+      connectorAdapterRegistry: this.connectorAdapterRegistry,
       data: plugins.data,
-      share: plugins.share,
       dataViews: plugins.dataViews,
-      savedObjects: core.savedObjects,
-      uiSettings: core.uiSettings,
       elasticsearch: core.elasticsearch,
-      getRulesClientWithRequest,
-      spaceIdToNamespace,
-      actionsPlugin: plugins.actions,
       encryptedSavedObjectsClient,
-      basePathService: core.http.basePath,
       eventLogger: this.eventLogger!,
       executionContext: core.executionContext,
-      ruleTypeRegistry: this.ruleTypeRegistry!,
-      alertsService: this.alertsService,
+      getMaintenanceWindowClientWithRequest,
+      getRulesClientWithRequest,
       kibanaBaseUrl: this.kibanaBaseUrl,
-      supportsEphemeralTasks: plugins.taskManager.supportsEphemeralTasks(),
-      maxEphemeralActionsPerRule: this.config.maxEphemeralActionsPerAlert,
-      cancelAlertsOnRuleTimeout: this.config.cancelAlertsOnRuleTimeout,
+      logger,
       maxAlerts: this.config.rules.run.alerts.max,
-      actionsConfigMap: getActionsConfigMap(this.config.rules.run.actions),
+      maxEphemeralActionsPerRule: this.config.maxEphemeralActionsPerAlert,
+      ruleTypeRegistry: this.ruleTypeRegistry!,
+      rulesSettingsService: new RulesSettingsService({
+        cacheInterval: this.config.rulesSettings.cacheInterval,
+        getRulesSettingsClientWithRequest,
+        isServerless: !!plugins.serverless,
+        logger,
+      }),
+      savedObjects: core.savedObjects,
+      share: plugins.share,
+      spaceIdToNamespace,
+      supportsEphemeralTasks: plugins.taskManager.supportsEphemeralTasks(),
+      uiSettings: core.uiSettings,
       usageCounter: this.usageCounter,
-      getRulesSettingsClientWithRequest,
-      getMaintenanceWindowClientWithRequest,
-      backfillClient: this.backfillClient!,
-      connectorAdapterRegistry: this.connectorAdapterRegistry,
     });
 
     this.eventLogService!.registerSavedObjectProvider(RULE_SAVED_OBJECT_TYPE, (request) => {

diff --git a/x-pack/plugins/alerting/server/routes/_mock_handler_arguments.ts b/x-pack/plugins/alerting/server/routes/_mock_handler_arguments.ts
@@ -12,7 +12,10 @@ import { httpServerMock } from '@kbn/core/server/mocks';
 import { actionsClientMock } from '@kbn/actions-plugin/server/mocks';
 import type { ActionsClientMock } from '@kbn/actions-plugin/server/mocks';
 import { rulesClientMock, RulesClientMock } from '../rules_client.mock';
-import { rulesSettingsClientMock, RulesSettingsClientMock } from '../rules_settings_client.mock';
+import {
+  rulesSettingsClientMock,
+  RulesSettingsClientMock,
+} from '../rules_settings/rules_settings_client.mock';
 import {
   maintenanceWindowClientMock,
   MaintenanceWindowClientMock,

diff --git a/x-pack/plugins/alerting/server/routes/get_flapping_settings.test.ts b/x-pack/plugins/alerting/server/routes/get_flapping_settings.test.ts
@@ -8,7 +8,10 @@
 import { httpServiceMock } from '@kbn/core/server/mocks';
 import { licenseStateMock } from '../lib/license_state.mock';
 import { mockHandlerArguments } from './_mock_handler_arguments';
-import { rulesSettingsClientMock, RulesSettingsClientMock } from '../rules_settings_client.mock';
+import {
+  rulesSettingsClientMock,
+  RulesSettingsClientMock,
+} from '../rules_settings/rules_settings_client.mock';
 import { getFlappingSettingsRoute } from './get_flapping_settings';
 
 let rulesSettingsClient: RulesSettingsClientMock;

diff --git a/...k/plugins/alerting/server/routes/rules_settings/apis/get/get_query_delay_settings.test.ts b/...k/plugins/alerting/server/routes/rules_settings/apis/get/get_query_delay_settings.test.ts
@@ -11,7 +11,7 @@ import { mockHandlerArguments } from '../../../_mock_handler_arguments';
 import {
   rulesSettingsClientMock,
   RulesSettingsClientMock,
-} from '../../../../rules_settings_client.mock';
+} from '../../../../rules_settings/rules_settings_client.mock';
 import { getQueryDelaySettingsRoute } from './get_query_delay_settings';
 
 let rulesSettingsClient: RulesSettingsClientMock;

diff --git a/...ins/alerting/server/routes/rules_settings/apis/update/update_query_delay_settings.test.ts b/...ins/alerting/server/routes/rules_settings/apis/update/update_query_delay_settings.test.ts
@@ -11,7 +11,7 @@ import { mockHandlerArguments } from '../../../_mock_handler_arguments';
 import {
   rulesSettingsClientMock,
   RulesSettingsClientMock,
-} from '../../../../rules_settings_client.mock';
+} from '../../../../rules_settings/rules_settings_client.mock';
 import { updateQueryDelaySettingsRoute } from './update_query_delay_settings';
 
 let rulesSettingsClient: RulesSettingsClientMock;

diff --git a/x-pack/plugins/alerting/server/routes/update_flapping_settings.test.ts b/x-pack/plugins/alerting/server/routes/update_flapping_settings.test.ts
@@ -8,7 +8,10 @@
 import { httpServiceMock } from '@kbn/core/server/mocks';
 import { licenseStateMock } from '../lib/license_state.mock';
 import { mockHandlerArguments } from './_mock_handler_arguments';
-import { rulesSettingsClientMock, RulesSettingsClientMock } from '../rules_settings_client.mock';
+import {
+  rulesSettingsClientMock,
+  RulesSettingsClientMock,
+} from '../rules_settings/rules_settings_client.mock';
 import { updateFlappingSettingsRoute } from './update_flapping_settings';
 
 let rulesSettingsClient: RulesSettingsClientMock;

diff --git a/...ng/rules_settings_flapping_client.test.ts → ...ng/rules_settings_flapping_client.test.ts b/...ng/rules_settings_flapping_client.test.ts → ...ng/rules_settings_flapping_client.test.ts
diff --git a/...lapping/rules_settings_flapping_client.ts → ...lapping/rules_settings_flapping_client.ts b/...lapping/rules_settings_flapping_client.ts → ...lapping/rules_settings_flapping_client.ts
diff --git a/...ing/server/rules_settings_client/index.ts → ...s/alerting/server/rules_settings/index.ts b/...ing/server/rules_settings_client/index.ts → ...s/alerting/server/rules_settings/index.ts
@@ -8,3 +8,6 @@
 export * from './rules_settings_client';
 export * from './flapping/rules_settings_flapping_client';
 export * from './query_delay/rules_settings_query_delay_client';
+export * from './rules_settings_client_factory';
+export * from './rules_settings_feature';
+export * from './rules_settings_service';
diff --git a/...rules_settings_query_delay_client.test.ts → ...rules_settings_query_delay_client.test.ts b/...rules_settings_query_delay_client.test.ts → ...rules_settings_query_delay_client.test.ts
diff --git a/...elay/rules_settings_query_delay_client.ts → ...elay/rules_settings_query_delay_client.ts b/...elay/rules_settings_query_delay_client.ts → ...elay/rules_settings_query_delay_client.ts
diff --git a/...ting/server/rules_settings_client.mock.ts → ...es_settings/rules_settings_client.mock.ts b/...ting/server/rules_settings_client.mock.ts → ...es_settings/rules_settings_client.mock.ts
@@ -11,7 +11,7 @@ import {
   RulesSettingsQueryDelayClientApi,
   DEFAULT_FLAPPING_SETTINGS,
   DEFAULT_QUERY_DELAY_SETTINGS,
-} from './types';
+} from '../types';
 
 export type RulesSettingsClientMock = jest.Mocked<RulesSettingsClientApi>;
 export type RulesSettingsFlappingClientMock = jest.Mocked<RulesSettingsFlappingClientApi>;

diff --git a/...ings_client/rules_settings_client.test.ts → ...es_settings/rules_settings_client.test.ts b/...ings_client/rules_settings_client.test.ts → ...es_settings/rules_settings_client.test.ts
diff --git a/..._settings_client/rules_settings_client.ts → ...r/rules_settings/rules_settings_client.ts b/..._settings_client/rules_settings_client.ts → ...r/rules_settings/rules_settings_client.ts
diff --git a/...ver/rules_settings_client_factory.test.ts → ...ngs/rules_settings_client_factory.test.ts b/...ver/rules_settings_client_factory.test.ts → ...ngs/rules_settings_client_factory.test.ts
@@ -18,7 +18,7 @@ import {
 } from '@kbn/core/server/mocks';
 import { AuthenticatedUser } from '@kbn/security-plugin/common';
 import { SECURITY_EXTENSION_ID } from '@kbn/core-saved-objects-server';
-import { RULES_SETTINGS_SAVED_OBJECT_TYPE } from '../common';
+import { RULES_SETTINGS_SAVED_OBJECT_TYPE } from '../../common';
 
 jest.mock('./rules_settings_client');
 

diff --git a/...g/server/rules_settings_client_factory.ts → ...settings/rules_settings_client_factory.ts b/...g/server/rules_settings_client_factory.ts → ...settings/rules_settings_client_factory.ts
@@ -13,7 +13,7 @@ import {
   SecurityServiceStart,
 } from '@kbn/core/server';
 import { RulesSettingsClient } from './rules_settings_client';
-import { RULES_SETTINGS_SAVED_OBJECT_TYPE } from '../common';
+import { RULES_SETTINGS_SAVED_OBJECT_TYPE } from '../../common';
 
 export interface RulesSettingsClientFactoryOpts {
   logger: Logger;

diff --git a/...ing/server/rules_settings_feature.test.ts → ...s_settings/rules_settings_feature.test.ts b/...ing/server/rules_settings_feature.test.ts → ...s_settings/rules_settings_feature.test.ts
diff --git a/...alerting/server/rules_settings_feature.ts → .../rules_settings/rules_settings_feature.ts b/...alerting/server/rules_settings_feature.ts → .../rules_settings/rules_settings_feature.ts
@@ -16,7 +16,7 @@ import {
   RULES_SETTINGS_SAVED_OBJECT_TYPE,
   ALL_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID,
   READ_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID,
-} from '../common';
+} from '../../common';
 
 export function getRulesSettingsFeature(isServerless: boolean): KibanaFeatureConfig {
   const settings = {

diff --git a/x-pack/plugins/alerting/server/rules_settings/rules_settings_service.mock.ts b/x-pack/plugins/alerting/server/rules_settings/rules_settings_service.mock.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 { DEFAULT_FLAPPING_SETTINGS, DEFAULT_QUERY_DELAY_SETTINGS } from '../types';
+
+const createRulesSettingsServiceMock = () => {
+  return jest.fn().mockImplementation(() => {
+    return {
+      getSettings: jest.fn().mockReturnValue({
+        queryDelaySettings: DEFAULT_QUERY_DELAY_SETTINGS,
+        flappingSettings: DEFAULT_FLAPPING_SETTINGS,
+      }),
+    };
+  });
+};
+
+export const rulesSettingsServiceMock = {
+  create: createRulesSettingsServiceMock(),
+};
-Original file line number
+Diff line change
@@ Expand Up / @@ -37,6 +37,9 @@ describe('config validation', () => { @@
                 },
               },
             },
+            "rulesSettings": Object {
+              "cacheInterval": 60000,
+            },
           }
         `);
       });
@@ Expand Down @@