add suggster related meters

fixes #3231

Author: Vladimir Kotal

opengrok-web/src/main/java/org/opengrok/web/api/v1/suggester/provider/service/impl/SuggesterServiceImpl.java

@@ -30,6 +30,7 @@
 import org.apache.lucene.index.Term;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.util.BytesRef;
+import org.opengrok.indexer.Metrics;
 import org.opengrok.suggest.Suggester;
 import org.opengrok.suggest.Suggester.NamedIndexDir;
 import org.opengrok.suggest.Suggester.NamedIndexReader;
@@ -316,7 +317,8 @@ private void initSuggester() {
                 env.isProjectsEnabled(),
                 suggesterConfig.getAllowedFields(),
                 suggesterConfig.getTimeThreshold(),
-                rebuildParalleismLevel);
+                rebuildParalleismLevel,
+                Metrics.getRegistry());
 
         new Thread(() -> {
             suggester.init(getAllProjectIndexDirs());

suggester/pom.xml

@@ -95,6 +95,23 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-core</artifactId>
+            <version>${micrometer.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-core</artifactId>
+            <version>1.5.4</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-core</artifactId>
+            <version>1.5.4</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>

suggester/src/main/java/org/opengrok/suggest/Suggester.java

@@ -22,6 +22,9 @@
  */
 package org.opengrok.suggest;
 
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
 import org.apache.commons.lang3.time.DurationFormatUtils;
 import org.apache.lucene.index.DirectoryReader;
 import org.apache.lucene.index.IndexReader;
@@ -97,6 +100,12 @@ public final class Suggester implements Closeable {
 
     private final CountDownLatch initDone = new CountDownLatch(1);
 
+    private final MeterRegistry registry;
+
+    private final Counter suggesterRebuildCounter;
+    private final Timer suggesterRebuildTimer;
+    private final Timer suggesterInitTimer;
+
     // do NOT use fork join thread pool (work stealing thread pool) because it does not send interrupts upon cancellation
     private final ExecutorService executorService = Executors.newFixedThreadPool(
             Runtime.getRuntime().availableProcessors(),
@@ -115,6 +124,7 @@ public final class Suggester implements Closeable {
      * @param allowedFields fields for which should the suggester be enabled,
      * if {@code null} then enabled for all fields
      * @param timeThreshold time in milliseconds after which the suggestions requests should time out
+     * @param registry
      */
     public Suggester(
             final File suggesterDir,
@@ -124,8 +134,8 @@ public Suggester(
             final boolean projectsEnabled,
             final Set<String> allowedFields,
             final int timeThreshold,
-            final int rebuildParallelismLevel
-    ) {
+            final int rebuildParallelismLevel,
+            MeterRegistry registry) {
         if (suggesterDir == null) {
             throw new IllegalArgumentException("Suggester needs to have directory specified");
         }
@@ -143,6 +153,17 @@ public Suggester(
         this.allowedFields = new HashSet<>(allowedFields);
         this.timeThreshold = timeThreshold;
         this.rebuildParallelismLevel = rebuildParallelismLevel;
+        this.registry = registry;
+
+        suggesterRebuildCounter = Counter.builder("suggester.rebuild").
+                description("suggester rebuild count").
+                register(this.registry);
+        suggesterRebuildTimer = Timer.builder("suggester.rebuild.latency").
+                description("suggester rebuild latency").
+                register(this.registry);
+        suggesterInitTimer = Timer.builder("suggester.init.latency").
+                description("suggester initialization latency").
+                register(this.registry);
     }
 
     /**
@@ -168,7 +189,9 @@ public void init(final Collection<NamedIndexDir> luceneIndexes) {
                 submitInitIfIndexExists(executor, indexDir);
             }
 
-            shutdownAndAwaitTermination(executor, start, "Suggester successfully initialized");
+            Duration duration = Duration.between(start, Instant.now());
+            suggesterInitTimer.record(duration);
+            shutdownAndAwaitTermination(executor, duration, "Suggester successfully initialized");
             initDone.countDown();
         }
     }
@@ -232,12 +255,12 @@ private boolean indexExists(final Path indexDir) throws IOException {
         }
     }
 
-    private void shutdownAndAwaitTermination(final ExecutorService executorService, Instant start, final String logMessageOnSuccess) {
+    private void shutdownAndAwaitTermination(final ExecutorService executorService, Duration duration, final String logMessageOnSuccess) {
         executorService.shutdown();
         try {
             executorService.awaitTermination(awaitTerminationTime.toMillis(), TimeUnit.MILLISECONDS);
             logger.log(Level.INFO, "{0} (took {1})", new Object[]{logMessageOnSuccess,
-                    DurationFormatUtils.formatDurationWords(Duration.between(start, Instant.now()).toMillis(),
+                    DurationFormatUtils.formatDurationWords(duration.toMillis(),
                             true, true)});
         } catch (InterruptedException e) {
             logger.log(Level.SEVERE, "Interrupted while building suggesters", e);
@@ -261,6 +284,7 @@ public void rebuild(final Collection<NamedIndexDir> indexDirs) {
 
         synchronized (lock) {
             Instant start = Instant.now();
+            suggesterRebuildCounter.increment();
             logger.log(Level.INFO, "Rebuilding the following suggesters: {0}", indexDirs);
 
             ExecutorService executor = Executors.newWorkStealingPool(rebuildParallelismLevel);
@@ -274,7 +298,9 @@ public void rebuild(final Collection<NamedIndexDir> indexDirs) {
                 }
             }
 
-            shutdownAndAwaitTermination(executor, start, "Suggesters for " + indexDirs + " were successfully rebuilt");
+            Duration duration = Duration.between(start, Instant.now());
+            suggesterRebuildTimer.record(duration);
+            shutdownAndAwaitTermination(executor, duration, "Suggesters for " + indexDirs + " were successfully rebuilt");
         }
 
         rebuildLock.lock();

suggester/src/test/java/org/opengrok/suggest/SuggesterTest.java

@@ -22,6 +22,8 @@
  */
 package org.opengrok.suggest;
 
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 import org.apache.commons.io.FileUtils;
 import org.apache.lucene.document.Document;
 import org.apache.lucene.document.Field;
@@ -63,6 +65,8 @@
 
 public class SuggesterTest {
 
+    private MeterRegistry registry = new SimpleMeterRegistry();
+
     private static class SuggesterTestData {
 
         private Suggester s;
@@ -98,14 +102,14 @@ private Suggester.NamedIndexReader getNamedIndexReader() throws IOException {
 
     @Test(expected = IllegalArgumentException.class)
     public void testNullSuggesterDir() {
-        new Suggester(null, 10, Duration.ofMinutes(5), false, true, null, Integer.MAX_VALUE, 1);
+        new Suggester(null, 10, Duration.ofMinutes(5), false, true, null, Integer.MAX_VALUE, 1, registry);
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void testNullDuration() throws IOException {
         Path tempFile = Files.createTempFile("opengrok", "test");
         try {
-            new Suggester(tempFile.toFile(), 10, null, false, true, null, Integer.MAX_VALUE, 1);
+            new Suggester(tempFile.toFile(), 10, null, false, true, null, Integer.MAX_VALUE, 1, registry);
         } finally {
             tempFile.toFile().delete();
         }
@@ -115,7 +119,7 @@ public void testNullDuration() throws IOException {
     public void testNegativeDuration() throws IOException {
         Path tempFile = Files.createTempFile("opengrok", "test");
         try {
-            new Suggester(tempFile.toFile(), 10, Duration.ofMinutes(-4), false, true, null, Integer.MAX_VALUE, 1);
+            new Suggester(tempFile.toFile(), 10, Duration.ofMinutes(-4), false, true, null, Integer.MAX_VALUE, 1, registry);
         } finally {
             tempFile.toFile().delete();
         }
@@ -132,7 +136,7 @@ private SuggesterTestData initSuggester() throws IOException {
         Path tempSuggesterDir = Files.createTempDirectory("opengrok");
 
         Suggester s = new Suggester(tempSuggesterDir.toFile(), 10, Duration.ofMinutes(1), true,
-                true, Collections.singleton("test"), Integer.MAX_VALUE, Runtime.getRuntime().availableProcessors());
+                true, Collections.singleton("test"), Integer.MAX_VALUE, Runtime.getRuntime().availableProcessors(), registry);
 
         s.init(Collections.singleton(new Suggester.NamedIndexDir("test", tempIndexDir)));
 
@@ -206,7 +210,7 @@ public void testIndexChangedWhileOffline() throws IOException {
 
         t.s = new Suggester(t.suggesterDir.toFile(), 10, Duration.ofMinutes(1), false,
                 true, Collections.singleton("test"), Integer.MAX_VALUE,
-                Runtime.getRuntime().availableProcessors());
+                Runtime.getRuntime().availableProcessors(), registry);
 
         t.s.init(Collections.singleton(t.getNamedIndexDir()));