[RAM] [Flapping] Add Flapping Rules Settings

src/core/server/integration_tests/saved_objects/migrations/check_registered_types.test.ts

@@ -124,6 +124,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "osquery-pack-asset": "de8783298eb33a577bf1fa0caacd42121dcfae91",
         "osquery-saved-query": "7b213b4b7a3e59350e99c50e8df9948662ed493a",
         "query": "4640ef356321500a678869f24117b7091a911cb6",
+        "rules-settings": "1af4c9abd4b40a154e233c2af4867df7aab7ac24",
         "sample-data-telemetry": "8b10336d9efae6f3d5593c4cc89fb4abcdf84e04",
         "search": "c48f5ab5d94545780ea98de1bff9e39f17f3606b",
         "search-session": "ba383309da68a15be3765977f7a44c84f0ec7964",

src/core/server/integration_tests/saved_objects/migrations/type_registrations.test.ts

@@ -92,6 +92,7 @@ const previouslyRegisteredTypes = [
   'osquery-usage-metric',
   'osquery-manager-usage-metric',
   'query',
+  'rules-settings',
   'sample-data-telemetry',
   'search',
   'search-session',

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

@@ -11,6 +11,7 @@
 import { AlertsHealth } from './rule';
 
 export * from './rule';
+export * from './rules_settings';
 export * from './rule_type';
 export * from './rule_task_instance';
 export * from './rule_navigation';

x-pack/plugins/alerting/common/rules_settings.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 interface RulesSettingsModificationMetadata {
+  createdBy: string | null;
+  updatedBy: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface RulesSettingsFlappingProperties {
+  enabled: boolean;
+  lookBackWindow: number;
+  statusChangeThreshold: number;
+}
+
+export type RulesSettingsFlapping = RulesSettingsFlappingProperties &
+  RulesSettingsModificationMetadata;
+
+export interface RulesSettings {
+  flapping: RulesSettingsFlapping;
+}
+
+export const MIN_LOOK_BACK_WINDOW = 2;
+export const MAX_LOOK_BACK_WINDOW = 20;
+export const MIN_STATUS_CHANGE_THRESHOLD = 2;
+export const MAX_STATUS_CHANGE_THRESHOLD = 20;
+
+export const RULES_SETTINGS_FEATURE_ID = 'rulesSettings';
+export const ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID = 'allFlappingSettings';
+export const READ_FLAPPING_SETTINGS_SUB_FEATURE_ID = 'readFlappingSettings';
+
+export const API_PRIVILEGES = {
+  READ_FLAPPING_SETTINGS: 'read-flapping-settings',
+  WRITE_FLAPPING_SETTINGS: 'write-flapping-settings',
+};
+
+export const RULES_SETTINGS_SAVED_OBJECT_TYPE = 'rules-settings';
+export const RULES_SETTINGS_SAVED_OBJECT_ID = 'rules-settings';
+
+export const DEFAULT_LOOK_BACK_WINDOW = 20;
+export const DEFAULT_STATUS_CHANGE_THRESHOLD = 4;
+
+export const DEFAULT_FLAPPING_SETTINGS = {
+  enabled: true,
+  lookBackWindow: 20,
+  statusChangeThreshold: 4,
+};

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

@@ -78,6 +78,7 @@ describe('Alerting Plugin', () => {
       statusService: statusServiceMock.createSetupContract(),
       monitoringCollection: monitoringCollectionMock.createSetup(),
       data: dataPluginMock.createSetupContract() as unknown as DataPluginSetup,
+      features: featuresPluginMock.createSetup(),
     };
 
     let plugin: AlertingPlugin;
@@ -221,6 +222,7 @@ describe('Alerting Plugin', () => {
           statusService: statusServiceMock.createSetupContract(),
           monitoringCollection: monitoringCollectionMock.createSetup(),
           data: dataPluginMock.createSetupContract() as unknown as DataPluginSetup,
+          features: featuresPluginMock.createSetup(),
         });
 
         const startContract = plugin.start(coreMock.createStart(), {
@@ -267,6 +269,7 @@ describe('Alerting Plugin', () => {
           statusService: statusServiceMock.createSetupContract(),
           monitoringCollection: monitoringCollectionMock.createSetup(),
           data: dataPluginMock.createSetupContract() as unknown as DataPluginSetup,
+          features: featuresPluginMock.createSetup(),
         });
 
         const startContract = plugin.start(coreMock.createStart(), {
@@ -324,6 +327,7 @@ describe('Alerting Plugin', () => {
         statusService: statusServiceMock.createSetupContract(),
         monitoringCollection: monitoringCollectionMock.createSetup(),
         data: dataPluginMock.createSetupContract() as unknown as DataPluginSetup,
+        features: featuresPluginMock.createSetup(),
       });
 
       const startContract = plugin.start(coreMock.createStart(), {

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

@@ -47,13 +47,17 @@ import {
   IEventLogService,
   IEventLogClientService,
 } from '@kbn/event-log-plugin/server';
-import { PluginStartContract as FeaturesPluginStart } from '@kbn/features-plugin/server';
+import {
+  PluginStartContract as FeaturesPluginStart,
+  PluginSetupContract as FeaturesPluginSetup,
+} from '@kbn/features-plugin/server';
 import { PluginStart as DataPluginStart } from '@kbn/data-plugin/server';
 import { MonitoringCollectionSetup } from '@kbn/monitoring-collection-plugin/server';
 import { SharePluginStart } from '@kbn/share-plugin/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 { ILicenseState, LicenseState } from './lib/license_state';
 import { AlertingRequestHandlerContext, ALERTS_FEATURE_ID } from './types';
 import { defineRoutes } from './routes';
@@ -82,6 +86,7 @@ import { getSecurityHealth, SecurityHealth } from './lib/get_security_health';
 import { registerNodeCollector, registerClusterCollector, InMemoryMetrics } from './monitoring';
 import { getRuleTaskTimeout } from './lib/get_rule_task_timeout';
 import { getActionsConfigMap } from './lib/get_actions_config_map';
+import { rulesSettingsFeature } from './rules_settings_feature';
 
 export const EVENT_LOG_PROVIDER = 'alerting';
 export const EVENT_LOG_ACTIONS = {
@@ -146,6 +151,7 @@ export interface AlertingPluginsSetup {
   statusService: StatusServiceSetup;
   monitoringCollection: MonitoringCollectionSetup;
   data: DataPluginSetup;
+  features: FeaturesPluginSetup;
 }
 
 export interface AlertingPluginsStart {
@@ -172,6 +178,7 @@ export class AlertingPlugin {
   private security?: SecurityPluginSetup;
   private readonly rulesClientFactory: RulesClientFactory;
   private readonly alertingAuthorizationClientFactory: AlertingAuthorizationClientFactory;
+  private readonly rulesSettingsClientFactory: RulesSettingsClientFactory;
   private readonly telemetryLogger: Logger;
   private readonly kibanaVersion: PluginInitializerContext['env']['packageInfo']['version'];
   private eventLogService?: IEventLogService;
@@ -186,6 +193,7 @@ export class AlertingPlugin {
     this.taskRunnerFactory = new TaskRunnerFactory();
     this.rulesClientFactory = new RulesClientFactory();
     this.alertingAuthorizationClientFactory = new AlertingAuthorizationClientFactory();
+    this.rulesSettingsClientFactory = new RulesSettingsClientFactory();
     this.telemetryLogger = initializerContext.logger.get('usage');
     this.kibanaVersion = initializerContext.env.packageInfo.version;
     this.inMemoryMetrics = new InMemoryMetrics(initializerContext.logger.get('in_memory_metrics'));
@@ -210,6 +218,8 @@ export class AlertingPlugin {
       };
     });
 
+    plugins.features.registerKibanaFeature(rulesSettingsFeature);
+
     this.isESOCanEncrypt = plugins.encryptedSavedObjects.canEncrypt;
 
     if (!this.isESOCanEncrypt) {
@@ -368,6 +378,7 @@ export class AlertingPlugin {
       ruleTypeRegistry,
       rulesClientFactory,
       alertingAuthorizationClientFactory,
+      rulesSettingsClientFactory,
       security,
       licenseState,
     } = this;
@@ -416,6 +427,12 @@ export class AlertingPlugin {
       minimumScheduleInterval: this.config.rules.minimumScheduleInterval,
     });
 
+    rulesSettingsClientFactory.initialize({
+      logger: this.logger,
+      savedObjectsService: core.savedObjects,
+      securityPluginStart: plugins.security,
+    });
+
     const getRulesClientWithRequest = (request: KibanaRequest) => {
       if (isESOCanEncrypt !== true) {
         throw new Error(
@@ -483,13 +500,16 @@ export class AlertingPlugin {
   private createRouteHandlerContext = (
     core: CoreSetup<AlertingPluginsStart, unknown>
   ): IContextProvider<AlertingRequestHandlerContext, 'alerting'> => {
-    const { ruleTypeRegistry, rulesClientFactory } = this;
+    const { ruleTypeRegistry, rulesClientFactory, rulesSettingsClientFactory } = this;
     return async function alertsRouteHandlerContext(context, request) {
       const [{ savedObjects }] = await core.getStartServices();
       return {
         getRulesClient: () => {
           return rulesClientFactory!.create(request, savedObjects);
         },
+        getRulesSettingsClient: () => {
+          return rulesSettingsClientFactory.createWithAuthorization(request);
+        },
         listTypes: ruleTypeRegistry!.list.bind(ruleTypeRegistry!),
         getFrameworkHealth: async () =>
           await getHealth(savedObjects.createInternalRepository(['alert'])),

x-pack/plugins/alerting/server/routes/_mock_handler_arguments.ts

@@ -10,17 +10,20 @@ import { identity } from 'lodash';
 import type { MethodKeysOf } from '@kbn/utility-types';
 import { httpServerMock } from '@kbn/core/server/mocks';
 import { rulesClientMock, RulesClientMock } from '../rules_client.mock';
+import { rulesSettingsClientMock, RulesSettingsClientMock } from '../rules_settings_client.mock';
 import { AlertsHealth, RuleType } from '../../common';
 import type { AlertingRequestHandlerContext } from '../types';
 
 export function mockHandlerArguments(
   {
     rulesClient = rulesClientMock.create(),
+    rulesSettingsClient = rulesSettingsClientMock.create(),
     listTypes: listTypesRes = [],
     getFrameworkHealth,
     areApiKeysEnabled,
   }: {
     rulesClient?: RulesClientMock;
+    rulesSettingsClient?: RulesSettingsClientMock;
     listTypes?: RuleType[];
     getFrameworkHealth?: jest.MockInstance<Promise<AlertsHealth>, []> &
       (() => Promise<AlertsHealth>);
@@ -41,6 +44,9 @@ export function mockHandlerArguments(
         getRulesClient() {
           return rulesClient || rulesClientMock.create();
         },
+        getRulesSettingsClient() {
+          return rulesSettingsClient || rulesSettingsClientMock.create();
+        },
         getFrameworkHealth,
         areApiKeysEnabled: areApiKeysEnabled ? areApiKeysEnabled : () => Promise.resolve(true),
       },

x-pack/plugins/alerting/server/routes/get_flapping_settings.test.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 { 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 { getFlappingSettingsRoute } from './get_flapping_settings';
+
+let rulesSettingsClient: RulesSettingsClientMock;
+
+jest.mock('../lib/license_api_access', () => ({
+  verifyApiAccess: jest.fn(),
+}));
+
+beforeEach(() => {
+  jest.resetAllMocks();
+  rulesSettingsClient = rulesSettingsClientMock.create();
+});
+
+describe('getFlappingSettingsRoute', () => {
+  test('gets flapping settings', async () => {
+    const licenseState = licenseStateMock.create();
+    const router = httpServiceMock.createRouter();
+
+    getFlappingSettingsRoute(router, licenseState);
+
+    const [config, handler] = router.get.mock.calls[0];
+
+    expect(config).toMatchInlineSnapshot(`
+      Object {
+        "options": Object {
+          "tags": Array [
+            "access:read-flapping-settings",
+          ],
+        },
+        "path": "/internal/alerting/rules/settings/_flapping",
+        "validate": false,
+      }
+    `);
+
+    (rulesSettingsClient.flapping().get as jest.Mock).mockResolvedValue({
+      enabled: true,
+      lookBackWindow: 10,
+      statusChangeThreshold: 10,
+      createdBy: 'test name',
+      updatedBy: 'test name',
+      createdAt: new Date().toISOString(),
+      updatedAt: new Date().toISOString(),
+    });
+
+    const [context, req, res] = mockHandlerArguments({ rulesSettingsClient }, {}, ['ok']);
+
+    await handler(context, req, res);
+
+    expect(rulesSettingsClient.flapping().get).toHaveBeenCalledTimes(1);
+    expect(res.ok).toHaveBeenCalled();
+  });
+});

x-pack/plugins/alerting/server/routes/get_flapping_settings.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { IRouter } from '@kbn/core/server';
+import { ILicenseState } from '../lib';
+import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../types';
+import { verifyAccessAndContext } from './lib';
+import { API_PRIVILEGES } from '../../common';
+
+export const getFlappingSettingsRoute = (
+  router: IRouter<AlertingRequestHandlerContext>,
+  licenseState: ILicenseState
+) => {
+  router.get(
+    {
+      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/settings/_flapping`,
+      validate: false,
+      options: {
+        tags: [`access:${API_PRIVILEGES.READ_FLAPPING_SETTINGS}`],
+      },
+    },
+    router.handleLegacyErrors(
+      verifyAccessAndContext(licenseState, async function (context, req, res) {
+        const rulesSettingsClient = (await context.alerting).getRulesSettingsClient();
+        const flappingSettings = await rulesSettingsClient.flapping().get();
+        return res.ok({ body: flappingSettings });
+      })
+    )
+  );
+};

x-pack/plugins/alerting/server/routes/index.ts

@@ -42,6 +42,8 @@ import { bulkDeleteRulesRoute } from './bulk_delete_rules';
 import { bulkEnableRulesRoute } from './bulk_enable_rules';
 import { bulkDisableRulesRoute } from './bulk_disable_rules';
 import { cloneRuleRoute } from './clone_rule';
+import { getFlappingSettingsRoute } from './get_flapping_settings';
+import { updateFlappingSettingsRoute } from './update_flapping_settings';
 
 export interface RouteOptions {
   router: IRouter<AlertingRequestHandlerContext>;
@@ -87,4 +89,6 @@ export function defineRoutes(opts: RouteOptions) {
   unsnoozeRuleRoute(router, licenseState);
   runSoonRoute(router, licenseState);
   cloneRuleRoute(router, licenseState);
+  getFlappingSettingsRoute(router, licenseState);
+  updateFlappingSettingsRoute(router, licenseState);
 }