FileSettingsHealthTracker

Author: prdoyle

server/src/main/java/org/elasticsearch/node/NodeConstruction.java

@@ -193,6 +193,7 @@
 import org.elasticsearch.reservedstate.action.ReservedClusterSettingsAction;
 import org.elasticsearch.reservedstate.service.FileSettingsService;
 import org.elasticsearch.reservedstate.service.FileSettingsService.FileSettingsHealthIndicatorService;
+import org.elasticsearch.reservedstate.service.FileSettingsService.FileSettingsHealthTracker;
 import org.elasticsearch.reservedstate.service.FileSettingsServiceProvider;
 import org.elasticsearch.rest.action.search.SearchResponseMetrics;
 import org.elasticsearch.script.ScriptModule;
@@ -1112,11 +1113,11 @@ public Map<String, String> queryFields() {
         actionModule.getReservedClusterStateService().installProjectStateHandler(new ReservedPipelineAction());
 
         var fileSettingsHealthIndicatorPublisher = new FileSettingsService.FileSettingsHealthIndicatorPublisherImpl(clusterService, client);
-        var fileSettingsHealthIndicatorService = new FileSettingsHealthIndicatorService(settings, fileSettingsHealthIndicatorPublisher);
+        var fileSettingsHealthTracker = new FileSettingsHealthTracker(settings, fileSettingsHealthIndicatorPublisher);
         FileSettingsService fileSettingsService = pluginsService.loadSingletonServiceProvider(
             FileSettingsServiceProvider.class,
             () -> FileSettingsService::new
-        ).construct(clusterService, actionModule.getReservedClusterStateService(), environment, fileSettingsHealthIndicatorService);
+        ).construct(clusterService, actionModule.getReservedClusterStateService(), environment, fileSettingsHealthTracker);
 
         RestoreService restoreService = new RestoreService(
             clusterService,
@@ -1200,8 +1201,7 @@ public Map<String, String> queryFields() {
                 transportService,
                 threadPool,
                 telemetryProvider,
-                repositoriesService,
-                fileSettingsHealthIndicatorService
+                repositoriesService
             )
         );
 
@@ -1372,8 +1372,7 @@ private Module loadDiagnosticServices(
         TransportService transportService,
         ThreadPool threadPool,
         TelemetryProvider telemetryProvider,
-        RepositoriesService repositoriesService,
-        FileSettingsHealthIndicatorService fileSettingsHealthIndicatorService
+        RepositoriesService repositoriesService
     ) {
 
         MasterHistoryService masterHistoryService = new MasterHistoryService(transportService, threadPool, clusterService);
@@ -1389,7 +1388,7 @@ private Module loadDiagnosticServices(
             new RepositoryIntegrityHealthIndicatorService(clusterService),
             new DiskHealthIndicatorService(clusterService),
             new ShardsCapacityHealthIndicatorService(clusterService),
-            fileSettingsHealthIndicatorService
+            new FileSettingsHealthIndicatorService()
         );
         var pluginHealthIndicatorServices = pluginsService.filterPlugins(HealthPlugin.class)
             .flatMap(plugin -> plugin.getHealthIndicatorServices().stream());

server/src/main/java/org/elasticsearch/reservedstate/service/FileSettingsHealthIndicatorPublisher.java

@@ -11,10 +11,10 @@
 
 import org.elasticsearch.action.ActionListener;
 import org.elasticsearch.action.support.master.AcknowledgedResponse;
-import org.elasticsearch.reservedstate.service.FileSettingsService.FileSettingsHealthIndicatorService;
+import org.elasticsearch.reservedstate.service.FileSettingsService.FileSettingsHealthTracker;
 
 /**
- * Used by {@link FileSettingsHealthIndicatorService} to send health info to the health node.
+ * Used by {@link FileSettingsHealthTracker} to send health info to the health node.
  */
 public interface FileSettingsHealthIndicatorPublisher {
     void publish(FileSettingsService.FileSettingsHealthInfo info, ActionListener<AcknowledgedResponse> actionListener);

server/src/main/java/org/elasticsearch/reservedstate/service/FileSettingsService.java

@@ -84,27 +84,27 @@ public class FileSettingsService extends MasterNodeFileWatchingService implement
 
     private final Path watchedFile;
     private final ReservedClusterStateService stateService;
-    private final FileSettingsHealthIndicatorService healthIndicatorService;
+    private final FileSettingsHealthTracker healthIndicatorTracker;
 
     /**
      * Constructs the {@link FileSettingsService}
      *
      * @param clusterService so we can register ourselves as a cluster state change listener
      * @param stateService an instance of the immutable cluster state controller, so we can perform the cluster state changes
      * @param environment we need the environment to pull the location of the config and operator directories
-     * @param healthIndicatorService tracks the success or failure of file-based settings
+     * @param healthIndicatorTracker tracks the success or failure of file-based settings operations
      */
     @SuppressWarnings("this-escape")
     public FileSettingsService(
         ClusterService clusterService,
         ReservedClusterStateService stateService,
         Environment environment,
-        FileSettingsHealthIndicatorService healthIndicatorService
+        FileSettingsHealthTracker healthIndicatorTracker
     ) {
         super(clusterService, environment.configDir().toAbsolutePath().resolve(OPERATOR_DIRECTORY));
         this.watchedFile = watchedFileDir().resolve(SETTINGS_FILE_NAME);
         this.stateService = stateService;
-        this.healthIndicatorService = healthIndicatorService;
+        this.healthIndicatorTracker = healthIndicatorTracker;
     }
 
     protected Logger logger() {
@@ -115,8 +115,8 @@ public Path watchedFile() {
         return watchedFile;
     }
 
-    public FileSettingsHealthIndicatorService healthIndicatorService() {
-        return healthIndicatorService;
+    public FileSettingsHealthTracker healthIndicatorService() {
+        return healthIndicatorTracker;
     }
 
     /**
@@ -152,14 +152,14 @@ public void handleSnapshotRestore(ClusterState clusterState, Metadata.Builder md
 
     @Override
     protected void doStart() {
-        healthIndicatorService.startOccurred();
+        healthIndicatorTracker.startOccurred();
         super.doStart();
     }
 
     @Override
     protected void doStop() {
         super.doStop();
-        healthIndicatorService.stopOccurred();
+        healthIndicatorTracker.stopOccurred();
     }
 
     /**
@@ -202,7 +202,7 @@ protected void processFile(Path file, boolean startup) throws IOException, Execu
             logger().debug("Received notification for unknown file {}", file);
         } else {
             logger().info("processing path [{}] for [{}]{}", watchedFile, NAMESPACE, startup ? " on service start" : "");
-            healthIndicatorService.changeOccurred();
+            healthIndicatorTracker.changeOccurred();
             processFileChanges(startup ? HIGHER_OR_SAME_VERSION : HIGHER_VERSION_ONLY);
         }
     }
@@ -222,15 +222,15 @@ private void processFileChanges(ReservedStateVersionCheck versionCheck) throws I
     protected void completeProcessing(Exception e, PlainActionFuture<Void> completion) {
         try {
             if (e != null) {
-                healthIndicatorService.failureOccurred(e.toString());
+                healthIndicatorTracker.failureOccurred(e.toString());
                 completion.onFailure(e);
             } else {
                 completion.onResponse(null);
-                healthIndicatorService.successOccurred();
+                healthIndicatorTracker.successOccurred();
             }
         } finally {
             logger().debug("Publishing to health node");
-            healthIndicatorService.publish();
+            healthIndicatorTracker.publish();
         }
     }
 
@@ -304,6 +304,9 @@ public FileSettingsHealthInfo failed(String failureDescription) {
         }
     }
 
+    /**
+     * Stateless service that maps a {@link FileSettingsHealthInfo} to a {@link HealthIndicatorResult}.
+     */
     public static class FileSettingsHealthIndicatorService implements HealthIndicatorService {
         static final String NAME = "file_settings";
         static final String INACTIVE_SYMPTOM = "File-based settings are inactive";
@@ -321,6 +324,43 @@ public static class FileSettingsHealthIndicatorService implements HealthIndicato
             )
         );
 
+        @Override
+        public String name() {
+            return NAME;
+        }
+
+        @Override
+        public synchronized HealthIndicatorResult calculate(boolean verbose, int maxAffectedResourcesCount, HealthInfo healthInfo) {
+            return calculate(healthInfo.fileSettingsHealthInfo());
+        }
+
+        public HealthIndicatorResult calculate(FileSettingsHealthInfo info) {
+            if (info.isActive() == false) {
+                return createIndicator(GREEN, INACTIVE_SYMPTOM, HealthIndicatorDetails.EMPTY, List.of(), List.of());
+            }
+            if (0 == info.changeCount()) {
+                return createIndicator(GREEN, NO_CHANGES_SYMPTOM, HealthIndicatorDetails.EMPTY, List.of(), List.of());
+            }
+            if (0 == info.failureStreak()) {
+                return createIndicator(GREEN, SUCCESS_SYMPTOM, HealthIndicatorDetails.EMPTY, List.of(), List.of());
+            } else {
+                return createIndicator(
+                    YELLOW,
+                    FAILURE_SYMPTOM,
+                    new SimpleHealthIndicatorDetails(
+                        Map.of("failure_streak", info.failureStreak(), "most_recent_failure", info.mostRecentFailure())
+                    ),
+                    STALE_SETTINGS_IMPACT,
+                    List.of()
+                );
+            }
+        }
+    }
+
+    /**
+     * Houses the current {@link FileSettingsHealthInfo} and provides a means to <i>publish</i> it to the health node.
+     */
+    public static class FileSettingsHealthTracker {
         /**
          * We want a length limit so we don't blow past the indexing limit in the case of a long description string.
          * This is an {@code OperatorDynamic} setting so that if the truncation hampers troubleshooting efforts,
@@ -338,11 +378,15 @@ public static class FileSettingsHealthIndicatorService implements HealthIndicato
         private final FileSettingsHealthIndicatorPublisher publisher;
         private FileSettingsHealthInfo currentInfo = FileSettingsHealthInfo.INDETERMINATE;
 
-        public FileSettingsHealthIndicatorService(Settings settings, FileSettingsHealthIndicatorPublisher publisher) {
+        public FileSettingsHealthTracker(Settings settings, FileSettingsHealthIndicatorPublisher publisher) {
             this.settings = settings;
             this.publisher = publisher;
         }
 
+        public FileSettingsHealthInfo getCurrentInfo() {
+            return currentInfo;
+        }
+
         public synchronized void startOccurred() {
             currentInfo = FileSettingsHealthInfo.INITIAL_ACTIVE;
         }
@@ -372,6 +416,9 @@ private String limitLength(String description) {
             }
         }
 
+        /**
+         * Sends the current health info to the health node.
+         */
         public void publish() {
             publisher.publish(
                 currentInfo,
@@ -381,42 +428,6 @@ public void publish() {
                 )
             );
         }
-
-        @Override
-        public String name() {
-            return NAME;
-        }
-
-        @Override
-        public synchronized HealthIndicatorResult calculate(boolean verbose, int maxAffectedResourcesCount, HealthInfo healthInfo) {
-            return calculate(healthInfo.fileSettingsHealthInfo());
-        }
-
-        public HealthIndicatorResult calculateFromCurrentInfo() {
-            return calculate(currentInfo);
-        }
-
-        private HealthIndicatorResult calculate(FileSettingsHealthInfo info) {
-            if (info.isActive() == false) {
-                return createIndicator(GREEN, INACTIVE_SYMPTOM, HealthIndicatorDetails.EMPTY, List.of(), List.of());
-            }
-            if (0 == info.changeCount()) {
-                return createIndicator(GREEN, NO_CHANGES_SYMPTOM, HealthIndicatorDetails.EMPTY, List.of(), List.of());
-            }
-            if (0 == info.failureStreak()) {
-                return createIndicator(GREEN, SUCCESS_SYMPTOM, HealthIndicatorDetails.EMPTY, List.of(), List.of());
-            } else {
-                return createIndicator(
-                    YELLOW,
-                    FAILURE_SYMPTOM,
-                    new SimpleHealthIndicatorDetails(
-                        Map.of("failure_streak", info.failureStreak(), "most_recent_failure", info.mostRecentFailure())
-                    ),
-                    STALE_SETTINGS_IMPACT,
-                    List.of()
-                );
-            }
-        }
     }
 
     public static class FileSettingsHealthIndicatorPublisherImpl implements FileSettingsHealthIndicatorPublisher {

server/src/main/java/org/elasticsearch/reservedstate/service/FileSettingsServiceProvider.java

@@ -17,6 +17,6 @@ FileSettingsService construct(
         ClusterService clusterService,
         ReservedClusterStateService stateService,
         Environment environment,
-        FileSettingsService.FileSettingsHealthIndicatorService healthIndicatorService
+        FileSettingsService.FileSettingsHealthTracker healthIndicatorService
     );
 }