Remove alerting feature flag from advanced settings (#97265)

* Remove alerting feature flag from advanced settings

Make it so the alerting UI in Observability can only be turned on and off in kibana.yml with `xpack.observability.enableAlertingExperience`.

We no longer:

* Allow turning this on and off for the current space in the advanced settings in Kibana
* Allow turning this on on cloud
* Send telemetry on whether or not the flag is enabled

Add some docs in READMEs as well.

src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker

@@ -229,6 +229,7 @@ kibana_vars=(
     xpack.maps.enabled
     xpack.maps.showMapVisualizationTypes
     xpack.ml.enabled
+    xpack.observability.unsafe.alertingExperience.enabled
     xpack.reporting.capture.browser.autoDownload
     xpack.reporting.capture.browser.chromium.disableSandbox
     xpack.reporting.capture.browser.chromium.inspect
@@ -273,6 +274,7 @@ kibana_vars=(
     xpack.reporting.queue.timeout
     xpack.reporting.roles.allow
     xpack.rollup.enabled
+    xpack.ruleRegistry.unsafe.write.enabled
     xpack.searchprofiler.enabled
     xpack.security.audit.enabled
     xpack.security.audit.appender.type

src/plugins/kibana_usage_collection/server/collectors/management/schema.ts

@@ -432,10 +432,6 @@ export const stackManagementSchema: MakeSchemaFrom<UsageStats> = {
     type: 'text',
     _meta: { description: 'Non-default value of setting.' },
   },
-  'observability:enableAlertingExperience': {
-    type: 'boolean',
-    _meta: { description: 'Non-default value of setting.' },
-  },
   'labs:presentation:unifiedToolbar': {
     type: 'boolean',
     _meta: { description: 'Non-default value of setting.' },

src/plugins/kibana_usage_collection/server/collectors/management/types.ts

@@ -32,7 +32,6 @@ export interface UsageStats {
   'securitySolution:rulesTableRefresh': string;
   'apm:enableSignificantTerms': boolean;
   'apm:enableServiceOverview': boolean;
-  'observability:enableAlertingExperience': boolean;
   'observability:enableInspectEsQueries': boolean;
   'visualize:enableLabs': boolean;
   'visualization:heatmap:maxBuckets': number;

src/plugins/telemetry/schema/oss_plugins.json

@@ -8200,12 +8200,6 @@
             "description": "Non-default value of setting."
           }
         },
-        "observability:enableAlertingExperience": {
-          "type": "boolean",
-          "_meta": {
-            "description": "Non-default value of setting."
-          }
-        },
         "labs:presentation:unifiedToolbar": {
           "type": "boolean",
           "_meta": {

x-pack/plugins/observability/README.md

@@ -2,6 +2,28 @@
 
 This plugin provides shared components and services for use across observability solutions, as well as the observability landing page UI.
 
+## Rules, Alerts, and Cases
+
+The Observability plugin contains experimental support for improved alerting and
+case management.
+
+If you have:
+
+```yaml
+xpack.observability.unsafe.alertingExperience.enabled: true
+```
+
+In your Kibana configuration, the Alerts and Cases pages will be available.
+
+This will only enable the UI for these pages. In order to have alert data indexed
+you'll need to enable writing in the [Rule Registry plugin](../rule_registry/README.md):
+
+```yaml
+xpack.ruleRegistry.unsafe.write.enabled: true
+```
+
+When both of the these are set to `true`, your alerts should show on the alerts page.
+
 ## Unit testing
 
 Note: Run the following commands from `kibana/x-pack/plugins/observability`.

x-pack/plugins/observability/common/ui_settings_keys.ts

@@ -5,5 +5,4 @@
  * 2.0.
  */
 
-export const enableAlertingExperience = 'observability:enableAlertingExperience';
 export const enableInspectEsQueries = 'observability:enableInspectEsQueries';

x-pack/plugins/observability/public/application/application.test.tsx

@@ -45,6 +45,7 @@ describe('renderApp', () => {
       uiSettings: { get: () => false },
       http: { basePath: { prepend: (path: string) => path } },
     } as unknown) as CoreStart;
+    const config = { unsafe: { alertingExperience: { enabled: true } } };
     const params = ({
       element: window.document.createElement('div'),
       history: createMemoryHistory(),
@@ -53,6 +54,7 @@ describe('renderApp', () => {
 
     expect(() => {
       const unmount = renderApp({
+        config,
         core,
         plugins,
         appMountParameters: params,

x-pack/plugins/observability/public/application/index.tsx

@@ -22,6 +22,7 @@ import { ObservabilityPublicPluginsStart, ObservabilityRuleRegistry } from '../p
 import { HasDataContextProvider } from '../context/has_data_context';
 import { Breadcrumbs, routes } from '../routes';
 import { Storage } from '../../../../../src/plugins/kibana_utils/public';
+import { ConfigSchema } from '..';
 
 function getTitleFromBreadCrumbs(breadcrumbs: Breadcrumbs) {
   return breadcrumbs.map(({ text }) => text).reverse();
@@ -67,11 +68,13 @@ function App() {
 }
 
 export const renderApp = ({
+  config,
   core,
   plugins,
   appMountParameters,
   observabilityRuleRegistry,
 }: {
+  config: ConfigSchema;
   core: CoreStart;
   plugins: ObservabilityPublicPluginsStart;
   observabilityRuleRegistry: ObservabilityRuleRegistry;
@@ -91,7 +94,7 @@ export const renderApp = ({
   ReactDOM.render(
     <KibanaContextProvider services={{ ...core, ...plugins, storage: new Storage(localStorage) }}>
       <PluginContext.Provider
-        value={{ appMountParameters, core, plugins, observabilityRuleRegistry }}
+        value={{ appMountParameters, config, core, plugins, observabilityRuleRegistry }}
       >
         <Router history={history}>
           <EuiThemeProvider darkMode={isDarkMode}>

x-pack/plugins/observability/public/components/app/section/alerts/index.tsx

@@ -21,7 +21,6 @@ import React, { useState } from 'react';
 import { EuiSelect } from '@elastic/eui';
 import { uniqBy } from 'lodash';
 import { Alert } from '../../../../../../alerting/common';
-import { enableAlertingExperience } from '../../../../../common/ui_settings_keys';
 import { usePluginContext } from '../../../../hooks/use_plugin_context';
 import { SectionContainer } from '..';
 
@@ -38,10 +37,9 @@ interface Props {
 }
 
 export function AlertsSection({ alerts }: Props) {
-  const { core } = usePluginContext();
+  const { config, core } = usePluginContext();
   const [filter, setFilter] = useState(ALL_TYPES);
-
+  const href = config.unsafe.alertingExperience.enabled
-  const href = core.uiSettings.get(enableAlertingExperience)
     ? '/app/observability/alerts'
     : '/app/management/insightsAndAlerting/triggersActions/alerts';
 

x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx

@@ -40,6 +40,7 @@ describe('APMSection', () => {
         http: { basePath: { prepend: jest.fn() } },
       } as unknown) as CoreStart,
       appMountParameters: {} as AppMountParameters,
+      config: { unsafe: { alertingExperience: { enabled: true } } },
       observabilityRuleRegistry: ({
         registerType: jest.fn(),
         getTypeByRuleId: jest.fn(),

x-pack/plugins/observability/public/components/app/section/ux/index.test.tsx

@@ -40,6 +40,7 @@ describe('UXSection', () => {
         http: { basePath: { prepend: jest.fn() } },
       } as unknown) as CoreStart,
       appMountParameters: {} as AppMountParameters,
+      config: { unsafe: { alertingExperience: { enabled: true } } },
       plugins: ({
         data: {
           query: {

x-pack/plugins/observability/public/context/plugin_context.tsx

@@ -8,9 +8,11 @@
 import { createContext } from 'react';
 import { AppMountParameters, CoreStart } from 'kibana/public';
 import { ObservabilityPublicPluginsStart, ObservabilityRuleRegistry } from '../plugin';
+import { ConfigSchema } from '..';
 
 export interface PluginContextValue {
   appMountParameters: AppMountParameters;
+  config: ConfigSchema;
   core: CoreStart;
   plugins: ObservabilityPublicPluginsStart;
   observabilityRuleRegistry: ObservabilityRuleRegistry;

x-pack/plugins/observability/public/hooks/use_time_range.test.ts

@@ -24,6 +24,7 @@ describe('useTimeRange', () => {
     jest.spyOn(pluginContext, 'usePluginContext').mockImplementation(() => ({
       core: {} as CoreStart,
       appMountParameters: {} as AppMountParameters,
+      config: { unsafe: { alertingExperience: { enabled: true } } },
       plugins: ({
         data: {
           query: {
@@ -65,6 +66,7 @@ describe('useTimeRange', () => {
         jest.spyOn(pluginContext, 'usePluginContext').mockImplementation(() => ({
           core: {} as CoreStart,
           appMountParameters: {} as AppMountParameters,
+          config: { unsafe: { alertingExperience: { enabled: true } } },
           plugins: ({
             data: {
               query: {

x-pack/plugins/observability/public/index.ts

@@ -21,12 +21,16 @@ export type {
 };
 export { enableInspectEsQueries } from '../common/ui_settings_keys';
 
+export interface ConfigSchema {
+  unsafe: { alertingExperience: { enabled: boolean } };
+}
+
 export const plugin: PluginInitializer<
   ObservabilityPublicSetup,
   ObservabilityPublicStart,
   ObservabilityPublicPluginsSetup,
   ObservabilityPublicPluginsStart
-> = (context: PluginInitializerContext) => {
+> = (context: PluginInitializerContext<ConfigSchema>) => {
   return new Plugin(context);
 };
 

x-pack/plugins/observability/public/pages/overview/overview.stories.tsx

@@ -45,6 +45,7 @@ const withCore = makeDecorator({
             appMountParameters: ({
               setHeaderActionMenu: () => {},
             } as unknown) as AppMountParameters,
+            config: { unsafe: { alertingExperience: { enabled: true } } },
             core: options as CoreStart,
             plugins: ({
               data: {

x-pack/plugins/observability/public/plugin.ts

@@ -32,6 +32,7 @@ import { registerDataHandler } from './data_handler';
 import { FormatterRuleRegistry } from './rules/formatter_rule_registry';
 import { createCallObservabilityApi } from './services/call_observability_api';
 import { toggleOverviewLinkInNav } from './toggle_overview_link_in_nav';
+import { ConfigSchema } from '.';
 
 export type ObservabilityPublicSetup = ReturnType<Plugin['setup']>;
 export type ObservabilityRuleRegistry = ObservabilityPublicSetup['ruleRegistry'];
@@ -60,7 +61,9 @@ export class Plugin
     > {
   private readonly appUpdater$ = new BehaviorSubject<AppUpdater>(() => ({}));
 
-  constructor(context: PluginInitializerContext) {}
+  constructor(private readonly initializerContext: PluginInitializerContext<ConfigSchema>) {
+    this.initializerContext = initializerContext;
+  }
 
   public setup(
     coreSetup: CoreSetup<ObservabilityPublicPluginsStart>,
@@ -68,6 +71,7 @@ export class Plugin
   ) {
     const category = DEFAULT_APP_CATEGORIES.observability;
     const euiIconType = 'logoObservability';
+    const config = this.initializerContext.config.get();
 
     createCallObservabilityApi(coreSetup.http);
 
@@ -84,6 +88,7 @@ export class Plugin
       const [coreStart, pluginsStart] = await coreSetup.getStartServices();
 
       return renderApp({
+        config,
         core: coreStart,
         plugins: pluginsStart,
         appMountParameters: params,
@@ -104,7 +109,7 @@ export class Plugin
       updater$,
     });
 
-    if (coreSetup.uiSettings.get('observability:enableAlertingExperience')) {
+    if (config.unsafe.alertingExperience.enabled) {
       coreSetup.application.register({
         id: 'observability-alerts',
         title: 'Alerts',

x-pack/plugins/observability/public/utils/test_helper.tsx

@@ -31,6 +31,8 @@ export const core = ({
   },
 } as unknown) as CoreStart;
 
+const config = { unsafe: { alertingExperience: { enabled: true } } };
+
 const plugins = ({
   data: { query: { timefilter: { timefilter: { setTime: jest.fn() } } } },
 } as unknown) as ObservabilityPublicPluginsStart;
@@ -42,7 +44,7 @@ export const render = (component: React.ReactNode) => {
     <IntlProvider locale="en-US" messages={translations.messages}>
       <KibanaContextProvider services={{ ...core }}>
         <PluginContext.Provider
-          value={{ appMountParameters, core, plugins, observabilityRuleRegistry }}
+          value={{ appMountParameters, config, core, plugins, observabilityRuleRegistry }}
         >
           <EuiThemeProvider>{component}</EuiThemeProvider>
         </PluginContext.Provider>

x-pack/plugins/observability/server/index.ts

@@ -16,12 +16,18 @@ export { rangeQuery, kqlQuery } from './utils/queries';
 export * from './types';
 
 export const config = {
+  exposeToBrowser: {
+    unsafe: { alertingExperience: { enabled: true } },
+  },
   schema: schema.object({
     enabled: schema.boolean({ defaultValue: true }),
     annotations: schema.object({
       enabled: schema.boolean({ defaultValue: true }),
       index: schema.string({ defaultValue: 'observability-annotations' }),
     }),
+    unsafe: schema.object({
+      alertingExperience: schema.object({ enabled: schema.boolean({ defaultValue: false }) }),
+    }),
   }),
 };
 

x-pack/plugins/observability/server/ui_settings.ts

@@ -8,27 +8,12 @@
 import { schema } from '@kbn/config-schema';
 import { i18n } from '@kbn/i18n';
 import { UiSettingsParams } from '../../../../src/core/types';
-import { enableAlertingExperience, enableInspectEsQueries } from '../common/ui_settings_keys';
+import { enableInspectEsQueries } from '../common/ui_settings_keys';
 
 /**
  * uiSettings definitions for Observability.
  */
 export const uiSettings: Record<string, UiSettingsParams<boolean>> = {
-  [enableAlertingExperience]: {
-    category: ['observability'],
-    name: i18n.translate('xpack.observability.enableAlertingExperienceExperimentName', {
-      defaultMessage: 'Observability alerting experience',
-    }),
-    value: false,
-    description: i18n.translate(
-      'xpack.observability.enableAlertingExperienceExperimentDescription',
-      {
-        defaultMessage:
-          'Enable the experimental alerting experience for Observability. Adds the Alerts and Cases pages.',
-      }
-    ),
-    schema: schema.boolean(),
-  },
   [enableInspectEsQueries]: {
     category: ['observability'],
     name: i18n.translate('xpack.observability.enableInspectEsQueriesExperimentName', {

x-pack/plugins/rule_registry/README.md

@@ -1,3 +1,5 @@
+# Rule Registry
+
 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.
 
 A rule registry creates a template, an ILM policy, and an alias. The template mappings can be configured. It also injects a client scoped to these indices.
@@ -6,7 +8,17 @@ It also supports inheritance, which means that producers can create a registry s
 
 The rule registry plugin creates a root rule registry, with the mappings defined needed to create a unified experience. Rule type producers can use the plugin to access the root rule registry, and create their own registry that branches off of the root rule registry. The rule registry client sees data from its own registry, and all registries that branches off of it. It does not see data from its parents.
 
-Creating a rule registry
+## Enabling writing
+
+Set
+
+```yaml
+xpack.ruleRegistry.unsafe.write.enabled: true
+```
+
+in your Kibana configuration to allow the Rule Registry to write events to the alert indices.
+
+## Creating a rule registry
 
 To create a rule registry, producers should add the `ruleRegistry` plugin to their dependencies. They can then use the `ruleRegistry.create` method to create a child registry, with the additional mappings that should be used by specifying `fieldMap`:
 
@@ -16,7 +28,7 @@ const observabilityRegistry = plugins.ruleRegistry.create({
   fieldMap: {
     ...pickWithPatterns(ecsFieldMap, 'host.name', 'service.name'),
   },
-})
+});
 ```
 
 `fieldMap` is a key-value map of field names and mapping options:
@@ -37,13 +49,13 @@ To pick many fields, you can use `pickWithPatterns`, which supports wildcards wi
 
 If a registry is created, it will initialise as soon as the core services needed become available. It will create a (versioned) template, alias, and ILM policy, but only if these do not exist yet.
 
-### Rule registry client
+## Rule registry client
 
 The rule registry client can either be injected in the executor, or created in the scope of a request. It exposes a `search` method and a `bulkIndex` method. When `search` is called, it first gets all the rules the current user has access to, and adds these ids to the search request that it executes. This means that the user can only see data from rules they have access to.
 
 Both `search` and `bulkIndex` are fully typed, in the sense that they reflect the mappings defined for the registry.
 
-### Schema
+## Schema
 
 The following fields are available in the root rule registry:
 
@@ -60,8 +72,8 @@ The following fields are available in the root rule registry:
 - `kibana.rac.alert.uuid`: the unique identifier for the alert during its lifespan. If an alert recovers (or closes), this identifier is re-generated when it is opened again.
 - `kibana.rac.alert.status`: the status of the alert. Can be `open` or `closed`.
 - `kibana.rac.alert.start`: the ISO timestamp of the time at which the alert started.
-- `kibana.rac.alert.end`: the ISO timestamp of the time at which the alert recovered. 
+- `kibana.rac.alert.end`: the ISO timestamp of the time at which the alert recovered.
-- `kibana.rac.alert.duration.us`: the duration of the alert, in microseconds. This is always the difference between either the current time, or the time when the alert recovered. 
+- `kibana.rac.alert.duration.us`: the duration of the alert, in microseconds. This is always the difference between either the current time, or the time when the alert recovered.
 - `kibana.rac.alert.severity.level`: the severity of the alert, as a keyword (e.g. critical).
 - `kibana.rac.alert.severity.value`: the severity of the alert, as a numerical value, which allows sorting.
 

x-pack/plugins/rule_registry/server/index.ts

@@ -17,7 +17,9 @@ export { ScopedRuleRegistryClient } from './rule_registry/create_scoped_rule_reg
 export const config = {
   schema: schema.object({
     enabled: schema.boolean({ defaultValue: true }),
-    writeEnabled: schema.boolean({ defaultValue: false }),
+    unsafe: schema.object({
+      write: schema.object({ enabled: schema.boolean({ defaultValue: false }) }),
+    }),
   }),
 };
 

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

@@ -37,7 +37,7 @@ export class RuleRegistryPlugin implements Plugin<RuleRegistryPluginSetupContrac
       kibanaVersion: this.initContext.env.packageInfo.version,
       logger: logger.get('root'),
       alertingPluginSetupContract: plugins.alerting,
-      writeEnabled: config.writeEnabled,
+      writeEnabled: config.unsafe.write.enabled,
     });
 
     return rootRegistry;

x-pack/test/apm_api_integration/configs/index.ts

@@ -18,7 +18,7 @@ const apmFtrConfigs = {
   rules: {
     license: 'trial' as const,
     kibanaConfig: {
-      'xpack.ruleRegistry.writeEnabled': 'true',
+      'xpack.ruleRegistry.unsafe.write.enabled': 'true',
     },
   },
 };