Use micrometer and expose metrics in prometheus format

Author: ahornace

opengrok-indexer/pom.xml

@@ -196,9 +196,14 @@ Portions Copyright (c) 2020-2020, Lubos Kosco <[email protected]>.
             <version>${jackson.version}</version>
         </dependency>
         <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-core</artifactId>
-            <version>4.1.0</version>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-core</artifactId>
+            <version>${micrometer.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-registry-prometheus</artifactId>
+            <version>${micrometer.version}</version>
         </dependency>
     </dependencies>
 

opengrok-indexer/src/main/java/org/opengrok/indexer/Metrics.java

@@ -18,20 +18,21 @@
  */
 
 /*
- * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer;
 
-import com.codahale.metrics.MetricRegistry;
+import io.micrometer.prometheus.PrometheusConfig;
+import io.micrometer.prometheus.PrometheusMeterRegistry;
 
-public class Metrics {
+public final class Metrics {
 
-    private static final MetricRegistry instance = new MetricRegistry();
+    private static final PrometheusMeterRegistry instance = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
 
     private Metrics() {
     }
 
-    public static MetricRegistry getInstance() {
+    public static PrometheusMeterRegistry getInstance() {
         return instance;
     }
 

opengrok-indexer/src/main/java/org/opengrok/indexer/authorization/AuthorizationFramework.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.authorization;
@@ -34,8 +34,8 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
 
-import com.codahale.metrics.Counter;
-import com.codahale.metrics.Timer;
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.Timer;
 import org.opengrok.indexer.Metrics;
 import org.opengrok.indexer.configuration.Configuration;
 import org.opengrok.indexer.configuration.Group;
@@ -391,7 +391,7 @@ protected void afterReload() {
             lock.writeLock().unlock();
         }
 
-        authStackReloadCounter.inc();
+        authStackReloadCounter.increment();
 
         // clean the old stack
         removeAll(oldStack);
@@ -509,11 +509,11 @@ private boolean checkAll(HttpServletRequest request, String cache, Nameable enti
             m = new TreeMap<>();
         } else if ((val = m.get(entity.getName())) != null) {
             // cache hit
-            authCacheHits.inc();
+            authCacheHits.increment();
             return val;
         }
 
-        authCacheMisses.inc();
+        authCacheMisses.increment();
 
         Duration duration;
         boolean overallDecision;
@@ -524,7 +524,7 @@ private boolean checkAll(HttpServletRequest request, String cache, Nameable enti
             HttpSession session;
             if (((session = request.getSession(false)) != null) && isSessionInvalid(session)) {
                 session.invalidate();
-                authSessionsInvalidated.inc();
+                authSessionsInvalidated.increment();
             }
             request.getSession().setAttribute(SESSION_VERSION, getPluginVersion());
 
@@ -536,16 +536,16 @@ private boolean checkAll(HttpServletRequest request, String cache, Nameable enti
             lock.readLock().unlock();
         }
 
-        authTimer.update(duration);
+        authTimer.record(duration);
         if (overallDecision) {
-            authPositiveTimer.update(duration);
+            authPositiveTimer.record(duration);
         } else {
-            authNegativeTimer.update(duration);
+            authNegativeTimer.record(duration);
         }
-        Metrics.getInstance().timer(String.format("authorization_of_%s", entity.getName())).update(duration);
+        Metrics.getInstance().timer(String.format("authorization_of_%s", entity.getName())).record(duration);
         Metrics.getInstance()
                 .timer(String.format("authorization_%s_of_%s", overallDecision ? "positive" : "negative", entity.getName()))
-                .update(duration);
+                .record(duration);
 
         m.put(entity.getName(), overallDecision);
         request.setAttribute(cache, m);

opengrok-indexer/src/main/java/org/opengrok/indexer/authorization/AuthorizationStack.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2020 Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.authorization;
@@ -288,14 +288,14 @@ protected boolean processStack(Nameable entity,
         Metrics.getInstance()
                 .timer(String.format("authorization_in_stack_%s_%s", getName(),
                         overallDecision ? "positive" : "negative"))
-                .update(duration);
+                .record(duration);
         Metrics.getInstance()
                 .timer(String.format("authorization_in_stack_%s_%s_of_%s", getName(),
                         overallDecision ? "positive" : "negative", entity.getName()))
-                .update(duration);
+                .record(duration);
         Metrics.getInstance()
                 .timer(String.format("authorization_in_stack_%s_of_%s", getName(), entity.getName()))
-                .update(duration);
+                .record(duration);
 
         return overallDecision;
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java

@@ -18,7 +18,7 @@
  */
 
  /*
-  * Copyright (c) 2006, 2019, Oracle and/or its affiliates. All rights reserved.
+  * Copyright (c) 2006, 2020, Oracle and/or its affiliates. All rights reserved.
   * Portions Copyright (c) 2017-2020, Chris Fraire <[email protected]>.
   */
 package org.opengrok.indexer.configuration;
@@ -1537,14 +1537,6 @@ public IncludeFiles getIncludeFiles() {
         return includeFiles;
     }
 
-    public String getStatisticsFilePath() {
-        return syncReadConfiguration(Configuration::getStatisticsFilePath);
-    }
-
-    public void setStatisticsFilePath(String statisticsFilePath) {
-        syncWriteConfiguration(statisticsFilePath, Configuration::setStatisticsFilePath);
-    }
-
     /**
      * Return the authorization framework used in this environment.
      *

opengrok-indexer/src/test/java/org/opengrok/indexer/authorization/AuthorizationFrameworkReloadTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2020 Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.authorization;
 
@@ -146,7 +146,7 @@ public void run() {
         }
 
         // Double check that at least one reload() was done.
-        long reloads = Metrics.getInstance().counter("authorization_stack_reload").getCount();
+        long reloads = (long) Metrics.getInstance().counter("authorization_stack_reload").count();
         assertTrue(reloads > 0);
     }
 

opengrok-web/pom.xml

@@ -18,7 +18,7 @@ information: Portions Copyright [yyyy] [name of copyright owner]
 
 CDDL HEADER END
 
-Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
 Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
 
 -->
@@ -158,16 +158,6 @@ Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
             <artifactId>modelmapper</artifactId>
             <version>2.3.0</version>
         </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-jersey2</artifactId>
-            <version>4.1.0</version>
-        </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-servlets</artifactId>
-            <version>4.1.0</version>
-        </dependency>
     </dependencies>
 
     <build>

opengrok-web/src/main/java/org/opengrok/web/AuthorizationFilter.java

@@ -18,12 +18,14 @@
  */
 
 /*
- * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.web;
 
 import java.io.IOException;
+import java.time.Duration;
+import java.time.Instant;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import javax.servlet.Filter;
@@ -35,8 +37,8 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
-import com.codahale.metrics.Meter;
-import com.codahale.metrics.Timer;
+import io.micrometer.core.instrument.DistributionSummary;
+import io.micrometer.core.instrument.Timer;
 import org.opengrok.indexer.Metrics;
 import org.opengrok.indexer.configuration.Project;
 import org.opengrok.indexer.logger.LoggerFactory;
@@ -48,11 +50,11 @@ public class AuthorizationFilter implements Filter {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AuthorizationFilter.class);
 
-    private final Meter requests = Metrics.getInstance().meter(StatisticsFilter.REQUESTS_METRIC);
+    private final DistributionSummary requests = Metrics.getInstance().summary(StatisticsFilter.REQUESTS_METRIC);
     private final Timer requestsForbidden = Metrics.getInstance().timer("requests_forbidden");
 
     @Override
-    public void init(FilterConfig fc) throws ServletException {
+    public void init(FilterConfig fc) {
     }
 
     @Override
@@ -75,10 +77,10 @@ public void doFilter(ServletRequest sr, ServletResponse sr1, FilterChain fc) thr
 
         PageConfig config = PageConfig.get(httpReq);
 
-        Timer.Context timerCtx = requestsForbidden.time();
-        try {
-            Project p = config.getProject();
-            if (p != null && !config.isAllowed(p)) {
+        Project p = config.getProject();
+        if (p != null && !config.isAllowed(p)) {
+            Instant start = Instant.now();
+            try {
                 if (LOGGER.isLoggable(Level.INFO)) {
                     if (httpReq.getRemoteUser() != null) {
                         LOGGER.log(Level.INFO, "Access denied for user ''{0}'' for URI: {1}",
@@ -98,7 +100,7 @@ public void doFilter(ServletRequest sr, ServletResponse sr1, FilterChain fc) thr
                  * In this branch of the if statement the filter processing stopped
                  * and does not follow to the StatisticsFilter.
                  */
-                requests.mark();
+                requests.record(1);
 
                 if (!config.getEnv().getIncludeFiles().getForbiddenIncludeFileContent(false).isEmpty()) {
                     sr.getRequestDispatcher("/eforbidden").forward(sr, sr1);
@@ -107,9 +109,9 @@ public void doFilter(ServletRequest sr, ServletResponse sr1, FilterChain fc) thr
 
                 httpRes.sendError(HttpServletResponse.SC_FORBIDDEN, "Access forbidden");
                 return;
+            } finally {
+                requestsForbidden.record(Duration.between(start, Instant.now()));
             }
-        } finally {
-            timerCtx.stop();
         }
         fc.doFilter(sr, sr1);
     }

opengrok-web/src/main/java/org/opengrok/web/HealthCheckServletContextListener.java

@@ -17,8 +17,8 @@
  * CDDL HEADER END
  */
 
- /*
- * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+/*
+ * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.web;
 
@@ -33,8 +33,8 @@
 import javax.servlet.ServletResponse;
 import javax.servlet.http.HttpServletRequest;
 
-import com.codahale.metrics.Meter;
-import com.codahale.metrics.Timer;
+import io.micrometer.core.instrument.DistributionSummary;
+import io.micrometer.core.instrument.Timer;
 import org.opengrok.indexer.Metrics;
 import org.opengrok.indexer.web.PageConfig;
 import org.opengrok.indexer.web.Prefix;
@@ -44,7 +44,7 @@ public class StatisticsFilter implements Filter {
 
     static final String REQUESTS_METRIC = "requests";
 
-    private final Meter requests = Metrics.getInstance().meter(REQUESTS_METRIC);
+    private final DistributionSummary requests = Metrics.getInstance().summary(REQUESTS_METRIC);
 
     private final Timer genericTimer = Metrics.getInstance().timer("*");
     private final Timer emptySearch = Metrics.getInstance().timer("empty_search");
@@ -80,26 +80,26 @@ public void doFilter(ServletRequest sr, ServletResponse sr1, FilterChain fc)
          * Add the request to the statistics. Be aware of the colliding call in
          * {@code AuthorizationFilter#doFilter}.
          */
-        requests.mark();
-        genericTimer.update(duration);
+        requests.record(1);
+        genericTimer.record(duration);
 
-        Metrics.getInstance().timer(category).update(duration);
+        Metrics.getInstance().timer(category).record(duration);
 
         /* supplementary categories */
         if (config.getProject() != null) {
             Metrics.getInstance()
                     .timer("viewing_of_" + config.getProject().getName())
-                    .update(duration);
+                    .record(duration);
         }
 
         SearchHelper helper = (SearchHelper) config.getRequestAttribute(SearchHelper.REQUEST_ATTR);
         if (helper != null) {
             if (helper.hits == null || helper.hits.length == 0) {
                 // empty search
-                emptySearch.update(duration);
+                emptySearch.record(duration);
             } else {
                 // successful search
-                successfulSearch.update(duration);
+                successfulSearch.record(duration);
             }
         }
     }