OAK-11613: expose ELASTIC_ENABLED metric

Author: fabriziofortino

oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticIndexProviderService.java

@@ -161,19 +161,22 @@ public class ElasticIndexProviderService {
 
     @Activate
     private void activate(BundleContext bundleContext, Config config) {
+        metricHandler = new ElasticMetricHandler(statisticsProvider);
         boolean disabled = Boolean.parseBoolean(System.getProperty(OAK_ELASTIC_PREFIX + PROP_DISABLED, Boolean.toString(config.disabled())));
         if (disabled) {
             LOG.info("Component disabled by configuration");
+            metricHandler.markEnabled(false);
             return;
         }
 
+        elasticConnection = getElasticConnection(config);
+        boolean isElasticAvailable = elasticConnection.isAvailable();
+        metricHandler.markEnabled(isElasticAvailable);
+
         whiteboard = new OsgiWhiteboard(bundleContext);
 
         //initializeTextExtractionDir(bundleContext, config);
         //initializeExtractedTextCache(config, statisticsProvider);
-
-        elasticConnection = getElasticConnection(config);
-        metricHandler = new ElasticMetricHandler(statisticsProvider);
         indexTracker = new ElasticIndexTracker(elasticConnection, metricHandler);
 
         // register observer needed for index tracking
@@ -195,7 +198,11 @@ private void activate(BundleContext bundleContext, Config config) {
 
         registerIndexProvider(bundleContext);
         registerIndexEditor(bundleContext);
-        registerIndexCleaner(config);
+        if (isElasticAvailable) {
+            registerIndexCleaner(config);
+        } else {
+            LOG.warn("The Elastic cluster at {} is not reachable. The index cleaner job has not been enabled", elasticConnection);
+        }
     }
 
     @Deactivate
@@ -216,10 +223,6 @@ private void deactivate() {
     }
 
     private void registerIndexCleaner(Config contextConfig) {
-        if (!elasticConnection.isAvailable()) {
-            LOG.warn("The Elastic cluster at {} is not reachable. The index cleaner job has not been enabled", elasticConnection);
-            return;
-        }
         if (contextConfig.remoteIndexCleanupFrequency() <= 0) {
             LOG.info("Index Cleaner disabled by configuration");
             return;

oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java

@@ -34,6 +34,8 @@
  */
 public class ElasticMetricHandler {
 
+    private static final String ENABLED = "ELASTIC_ENABLED";
+
     private static final String QUERY_RATE = "ELASTIC_QUERY_RATE";
     private static final String QUERY_INTERNAL_RATE = "ELASTIC_QUERY_INTERNAL_RATE";
 
@@ -59,6 +61,15 @@ public ElasticMetricHandler(StatisticsProvider sp) {
         timer = statsProviderUtil.getTimerStats();
     }
 
+    /**
+     * Marks the Elastic metric as enabled or disabled.
+     *
+     * @param enabled a boolean indicating whether the Elastic metric is enabled (true) or disabled (false)
+     */
+    public void markEnabled(boolean enabled) {
+        meter.apply(ENABLED, Collections.emptyMap()).mark(enabled ? 1 : 0);
+    }
+
     /**
      * Tracks a new query using two metrics:
      * <ul>

oak-search-elastic/src/test/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticIndexProviderServiceTest.java

@@ -26,6 +26,7 @@
 import org.apache.jackrabbit.oak.spi.state.NodeStore;
 import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
 import org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardUtils;
+import org.apache.jackrabbit.oak.stats.MeterStats;
 import org.apache.jackrabbit.oak.stats.StatisticsProvider;
 import org.apache.sling.testing.mock.osgi.MockOsgi;
 import org.apache.sling.testing.mock.osgi.junit.OsgiContext;
@@ -51,7 +52,13 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 public class ElasticIndexProviderServiceTest {
 
@@ -68,12 +75,17 @@ public class ElasticIndexProviderServiceTest {
 
     private Whiteboard wb;
 
+    private final MeterStats spyElasticEnabledMetric = spy(MeterStats.class);
+
     @Before
     public void setUp() {
+        reset(spyElasticEnabledMetric);
+        StatisticsProvider spyStatsProvider = mock(StatisticsProvider.class);
+        when(spyStatsProvider.getMeter(eq("ELASTIC_ENABLED"), any())).thenReturn(spyElasticEnabledMetric);
         MountInfoProvider mip = Mounts.newBuilder().build();
         context.registerService(MountInfoProvider.class, mip);
         context.registerService(NodeStore.class, new MemoryNodeStore());
-        context.registerService(StatisticsProvider.class, StatisticsProvider.NOOP);
+        context.registerService(StatisticsProvider.class, spyStatsProvider);
         context.registerService(AsyncIndexInfoService.class, mock(AsyncIndexInfoService.class));
 
         wb = new OsgiWhiteboard(context.bundleContext());
@@ -84,6 +96,8 @@ public void setUp() {
     public void defaultSetup() {
         MockOsgi.activate(service, context.bundleContext());
 
+        verify(spyElasticEnabledMetric).mark(eq(0L));
+
         assertNotNull(context.getService(QueryIndexProvider.class));
         assertNotNull(context.getService(IndexEditorProvider.class));
 
@@ -98,6 +112,8 @@ public void defaultSetup() {
     public void withElasticSetup() {
         MockOsgi.activate(service, context.bundleContext(), getElasticConfig());
 
+        verify(spyElasticEnabledMetric).mark(eq(1L));
+
         assertNotNull(context.getService(QueryIndexProvider.class));
         assertNotNull(context.getService(IndexEditorProvider.class));
 
@@ -112,6 +128,8 @@ public void withIndexCleanerSetup() {
         props.put("remoteIndexCleanupFrequency", 600);
         MockOsgi.activate(service, context.bundleContext(), props);
 
+        verify(spyElasticEnabledMetric).mark(eq(1L));
+
         assertNotNull(context.getService(QueryIndexProvider.class));
         assertNotNull(context.getService(IndexEditorProvider.class));
 
@@ -124,6 +142,8 @@ public void withIndexCleanerSetup() {
     public void disabled() {
         MockOsgi.activate(service, context.bundleContext(), Map.of(PROP_DISABLED, true));
 
+        verify(spyElasticEnabledMetric).mark(eq(0L));
+
         assertNull(context.getService(QueryIndexProvider.class));
         assertNull(context.getService(IndexEditorProvider.class));