[7.x] Add setting to decommission legacy monitoring cluster alerts (#62668) (#64443)

Adds a setting that, when enabled, directs any currently running exporters in monitoring 
will treat any cluster alert definition as excluded from the list of allowed cluster alert 
watches. This is the first step to adding a migration path away from using cluster alerts 
configured by the monitoring plugin and toward those managed by the stack monitoring 
solutions on the new alerting feature.

Co-authored-by: Przemko Robakowski <[email protected]>

Author: jbaiera

x-pack/plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/Monitoring.java

@@ -82,6 +82,9 @@ public class Monitoring extends Plugin implements ActionPlugin, ReloadablePlugin
     public static final Setting<Boolean> CLEAN_WATCHER_HISTORY = boolSetting("xpack.watcher.history.cleaner_service.enabled",
         true, Setting.Property.Dynamic, Setting.Property.NodeScope, Setting.Property.Deprecated);
 
+    public static final Setting<Boolean> MIGRATION_DECOMMISSION_ALERTS = boolSetting("xpack.monitoring.migration.decommission_alerts",
+        false, Setting.Property.Dynamic, Setting.Property.NodeScope);
+
     protected final Settings settings;
     private final boolean transportClientMode;
 
@@ -164,6 +167,7 @@ public List<Setting<?>> getSettings() {
         List<Setting<?>> settings = new ArrayList<>();
         settings.add(MonitoringField.HISTORY_DURATION);
         settings.add(CLEAN_WATCHER_HISTORY);
+        settings.add(MIGRATION_DECOMMISSION_ALERTS);
         settings.add(MonitoringService.ENABLED);
         settings.add(MonitoringService.ELASTICSEARCH_COLLECTION_ENABLED);
         settings.add(MonitoringService.INTERVAL);

x-pack/plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/exporter/Exporters.java

@@ -23,6 +23,7 @@
 import org.elasticsearch.gateway.GatewayService;
 import org.elasticsearch.license.XPackLicenseState;
 import org.elasticsearch.xpack.core.ssl.SSLService;
+import org.elasticsearch.xpack.monitoring.Monitoring;
 import org.elasticsearch.xpack.monitoring.exporter.http.HttpExporter;
 import org.elasticsearch.xpack.core.monitoring.exporter.MonitoringDoc;
 import org.elasticsearch.xpack.monitoring.exporter.local.LocalExporter;
@@ -62,7 +63,9 @@ public Exporters(Settings settings, Map<String, Exporter.Factory> factories,
 
         final List<Setting.AffixSetting<?>> dynamicSettings =
             getSettings().stream().filter(Setting::isDynamic).collect(Collectors.toList());
-        clusterService.getClusterSettings().addSettingsUpdateConsumer(this::setExportersSetting, dynamicSettings);
+        final List<Setting<?>> updateSettings = new ArrayList<Setting<?>>(dynamicSettings);
+        updateSettings.add(Monitoring.MIGRATION_DECOMMISSION_ALERTS);
+        clusterService.getClusterSettings().addSettingsUpdateConsumer(this::setExportersSetting, updateSettings);
         HttpExporter.registerSettingValidators(clusterService, sslService);
         // this ensures that logging is happening by adding an empty consumer per affix setting
         for (Setting.AffixSetting<?> affixSetting : dynamicSettings) {

x-pack/plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/exporter/http/HttpExporter.java

@@ -43,6 +43,7 @@
 import org.elasticsearch.xpack.core.ssl.SSLConfiguration;
 import org.elasticsearch.xpack.core.ssl.SSLConfigurationSettings;
 import org.elasticsearch.xpack.core.ssl.SSLService;
+import org.elasticsearch.xpack.monitoring.Monitoring;
 import org.elasticsearch.xpack.monitoring.exporter.ClusterAlertsUtil;
 import org.elasticsearch.xpack.monitoring.exporter.ExportBulk;
 import org.elasticsearch.xpack.monitoring.exporter.Exporter;
@@ -908,7 +909,7 @@ private static void configureClusterAlertsResources(final Config config, final S
 
             // add a resource per watch
             for (final String watchId : ClusterAlertsUtil.WATCH_IDS) {
-                final boolean blacklisted = blacklist.contains(watchId);
+                final boolean blacklisted = blacklist.contains(watchId) || Monitoring.MIGRATION_DECOMMISSION_ALERTS.get(config.settings());
                 // lazily load the cluster state to fetch the cluster UUID once it's loaded
                 final Supplier<String> uniqueWatchId = () -> ClusterAlertsUtil.createUniqueWatchId(clusterService, watchId);
                 final Supplier<String> watch = blacklisted ? null : () -> ClusterAlertsUtil.loadWatch(clusterService, watchId);

x-pack/plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/exporter/local/LocalExporter.java

@@ -51,6 +51,7 @@
 import org.elasticsearch.xpack.core.watcher.transport.actions.get.GetWatchRequest;
 import org.elasticsearch.xpack.core.watcher.transport.actions.get.GetWatchResponse;
 import org.elasticsearch.xpack.core.watcher.watch.Watch;
+import org.elasticsearch.xpack.monitoring.Monitoring;
 import org.elasticsearch.xpack.monitoring.cleaner.CleanerService;
 import org.elasticsearch.xpack.monitoring.exporter.ClusterAlertsUtil;
 import org.elasticsearch.xpack.monitoring.exporter.ExportBulk;
@@ -105,6 +106,7 @@ public class LocalExporter extends Exporter implements ClusterStateListener, Cle
     private final boolean useIngest;
     private final DateFormatter dateTimeFormatter;
     private final List<String> clusterAlertBlacklist;
+    private final boolean decommissionClusterAlerts;
 
     private final AtomicReference<State> state = new AtomicReference<>(State.INITIALIZED);
     private final AtomicBoolean installingSomething = new AtomicBoolean(false);
@@ -120,6 +122,7 @@ public LocalExporter(Exporter.Config config, Client client, CleanerService clean
         this.licenseState = config.licenseState();
         this.useIngest = USE_INGEST_PIPELINE_SETTING.getConcreteSettingForNamespace(config.name()).get(config.settings());
         this.clusterAlertBlacklist = ClusterAlertsUtil.getClusterAlertsBlacklist(config);
+        this.decommissionClusterAlerts = Monitoring.MIGRATION_DECOMMISSION_ALERTS.get(config.settings());
         this.cleanerService = cleanerService;
         this.dateTimeFormatter = dateTimeFormatter(config);
         // if additional listeners are added here, adjust LocalExporterTests#testLocalExporterRemovesListenersOnClose accordingly
@@ -158,8 +161,10 @@ public void licenseStateChanged() {
     boolean isExporterReady() {
         // forces the setup to occur if it hasn't already
         final boolean running = resolveBulk(clusterService.state(), false) != null;
+        // Report on watcher readiness
+        boolean alertsProcessed = canUseWatcher() == false || watcherSetup.get();
 
-        return running && installingSomething.get() == false;
+        return running && installingSomething.get() == false && alertsProcessed;
     }
 
     @Override
@@ -455,7 +460,8 @@ private void getClusterAlertsInstallationAsyncActions(final boolean indexExists,
 
         for (final String watchId : ClusterAlertsUtil.WATCH_IDS) {
             final String uniqueWatchId = ClusterAlertsUtil.createUniqueWatchId(clusterService, watchId);
-            final boolean addWatch = canAddWatches && clusterAlertBlacklist.contains(watchId) == false;
+            final boolean addWatch = canAddWatches && clusterAlertBlacklist.contains(watchId) == false &&
+                decommissionClusterAlerts == false;
 
             // we aren't sure if no watches exist yet, so add them
             if (indexExists) {

x-pack/plugin/monitoring/src/test/java/org/elasticsearch/xpack/monitoring/exporter/http/HttpExporterResourceTests.java

@@ -102,7 +102,11 @@ public void setupResources() {
     }
 
     public void awaitCheckAndPublish(final Boolean expected) {
-        resources.checkAndPublish(client, listener);
+        awaitCheckAndPublish(resources, expected);
+    }
+
+    public void awaitCheckAndPublish(HttpResource resource, final Boolean expected) {
+        resource.checkAndPublish(client, listener);
 
         verifyListener(expected);
     }
@@ -484,6 +488,56 @@ public void testWatchPublishBlocksAfterSuccessfulWatcherCheck() {
         verifyNoMoreInteractions(client);
     }
 
+    public void testDeployClusterAlerts() {
+        final int successfulGetTemplates = randomIntBetween(0, EXPECTED_TEMPLATES);
+        final int unsuccessfulGetTemplates = EXPECTED_TEMPLATES - successfulGetTemplates;
+        final int successfulGetPipelines = randomIntBetween(0, EXPECTED_PIPELINES);
+        final int unsuccessfulGetPipelines = EXPECTED_PIPELINES - successfulGetPipelines;
+        final Exception exception = failurePutException();
+
+        whenValidVersionResponse();
+        whenGetTemplates(successfulGetTemplates, unsuccessfulGetTemplates);
+        whenSuccessfulPutTemplates(unsuccessfulGetTemplates);
+        whenGetPipelines(successfulGetPipelines, unsuccessfulGetPipelines);
+        whenSuccessfulPutPipelines(unsuccessfulGetPipelines);
+        // license needs to be valid, otherwise we'll do DELETEs, which are tested earlier
+        whenWatcherCanBeUsed(true);
+
+        // a number of watches are mocked as present
+        final int existingWatches = randomIntBetween(0, EXPECTED_WATCHES);
+
+        // For completeness's sake. GET/PUT watches wont be called by the resources.
+        // Instead it tries to DELETE the watches ignoring them not existing.
+        whenGetWatches(existingWatches, EXPECTED_WATCHES - existingWatches);
+        whenPerformRequestAsyncWith(client, new RequestMatcher(is("PUT"), startsWith("/_watcher/watch/")), exception);
+        whenPerformRequestAsyncWith(client, new RequestMatcher(is("DELETE"), startsWith("/_watcher/watch/")),
+            successfulDeleteResponses(EXPECTED_WATCHES));
+
+        // Create resources that are configured to remove all watches
+        Settings removalExporterSettings = Settings.builder()
+            .put(exporterSettings)
+            .put("xpack.monitoring.migration.decommission_alerts", true)
+            .build();
+        MultiHttpResource overrideResource = HttpExporter.createResources(
+            new Exporter.Config("_http", "http", removalExporterSettings, clusterService, licenseState));
+
+        assertTrue(overrideResource.isDirty());
+        awaitCheckAndPublish(overrideResource, true);
+        // Should proceed
+        assertFalse(overrideResource.isDirty());
+
+        verifyVersionCheck();
+        verifyGetTemplates(EXPECTED_TEMPLATES);
+        verifyPutTemplates(unsuccessfulGetTemplates);
+        verifyGetPipelines(EXPECTED_PIPELINES);
+        verifyPutPipelines(unsuccessfulGetPipelines);
+        verifyWatcherCheck();
+        verifyGetWatches(0);
+        verifyPutWatches(0);
+        verifyDeleteWatches(EXPECTED_WATCHES);
+        verifyNoMoreInteractions(client);
+    }
+
     public void testSuccessfulChecksOnElectedMasterNode() {
         final int successfulGetTemplates = randomIntBetween(0, EXPECTED_TEMPLATES);
         final int unsuccessfulGetTemplates = EXPECTED_TEMPLATES - successfulGetTemplates;

x-pack/plugin/monitoring/src/test/java/org/elasticsearch/xpack/monitoring/exporter/local/LocalExporterIntegTestCase.java

@@ -32,7 +32,7 @@ public static void setupThreadPool() {
     }
 
     @AfterClass
-    public static void cleanUpStatic() throws Exception {
+    public static void cleanUpStatic() {
         if (THREADPOOL != null) {
             terminate(THREADPOOL);
         }
@@ -57,6 +57,15 @@ protected Settings nodeSettings(int nodeOrdinal) {
                        .build();
     }
 
+    /**
+     * Create a new {@link LocalExporter} with the default exporter settings and name.
+     *
+     * @return Never {@code null}.
+     */
+    protected LocalExporter createLocalExporter() {
+        return createLocalExporter(exporterName, null);
+    }
+
     /**
      * Create a new {@link LocalExporter}. Expected usage:
      * <pre><code>
@@ -68,12 +77,11 @@ protected Settings nodeSettings(int nodeOrdinal) {
      *
      * @return Never {@code null}.
      */
-    protected LocalExporter createLocalExporter() {
-        final Settings settings = localExporterSettings();
+    protected LocalExporter createLocalExporter(String exporterName, Settings exporterSettings) {
         final XPackLicenseState licenseState = TestUtils.newTestLicenseState();
-        final Exporter.Config config = new Exporter.Config(exporterName, "local", settings, clusterService(), licenseState);
+        final Exporter.Config config = new Exporter.Config(exporterName, "local", exporterSettings, clusterService(), licenseState);
         final CleanerService cleanerService =
-                new CleanerService(settings, clusterService().getClusterSettings(), THREADPOOL, licenseState);
+            new CleanerService(exporterSettings, clusterService().getClusterSettings(), THREADPOOL, licenseState);
 
         return new LocalExporter(config, client(), cleanerService);
     }