Dropwizard metrics support

Author: ahornace

opengrok-indexer/pom.xml

@@ -195,6 +195,11 @@ Portions Copyright (c) 2020-2020, Lubos Kosco <[email protected]>.
             <artifactId>jackson-annotations</artifactId>
             <version>${jackson.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.dropwizard.metrics</groupId>
+            <artifactId>metrics-core</artifactId>
+            <version>4.1.0</version>
+        </dependency>
     </dependencies>
 
     <build>

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

@@ -0,0 +1,38 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
+ */
+package org.opengrok.indexer;
+
+import com.codahale.metrics.MetricRegistry;
+
+public class Metrics {
+
+    private static final MetricRegistry instance = new MetricRegistry();
+
+    private Metrics() {
+    }
+
+    public static MetricRegistry getInstance() {
+        return instance;
+    }
+
+}

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

@@ -23,6 +23,8 @@
  */
 package org.opengrok.indexer.authorization;
 
+import java.time.Duration;
+import java.time.Instant;
 import java.util.Map;
 import java.util.TreeMap;
 import java.util.concurrent.locks.ReadWriteLock;
@@ -31,6 +33,10 @@
 import java.util.logging.Logger;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
+
+import com.codahale.metrics.Counter;
+import com.codahale.metrics.Timer;
+import org.opengrok.indexer.Metrics;
 import org.opengrok.indexer.configuration.Configuration;
 import org.opengrok.indexer.configuration.Group;
 import org.opengrok.indexer.configuration.Nameable;
@@ -39,7 +45,6 @@
 import org.opengrok.indexer.framework.PluginFramework;
 import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.indexer.web.Laundromat;
-import org.opengrok.indexer.web.Statistics;
 
 /**
  * Placeholder for performing authorization checks.
@@ -50,6 +55,15 @@ public final class AuthorizationFramework extends PluginFramework<IAuthorization
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AuthorizationFramework.class);
 
+    private final Counter authStackReloadCounter = Metrics.getInstance().counter("authorization_stack_reload");
+    private final Counter authCacheHits = Metrics.getInstance().counter("authorization_cache_hits");
+    private final Counter authCacheMisses = Metrics.getInstance().counter("authorization_cache_misses");
+    private final Counter authSessionsInvalidated = Metrics.getInstance().counter("authorization_sessions_invalidated");
+
+    private final Timer authTimer = Metrics.getInstance().timer("authorization");
+    private final Timer authPositiveTimer = Metrics.getInstance().timer("authorization_positive");
+    private final Timer authNegativeTimer = Metrics.getInstance().timer("authorization_negative");
+
     /**
      * Stack of available plugins/stacks in the order of the execution.
      */
@@ -377,12 +391,10 @@ protected void afterReload() {
             lock.writeLock().unlock();
         }
 
-        Statistics stats = RuntimeEnvironment.getInstance().getStatistics();
-        stats.addRequest("authorization_stack_reload");
+        authStackReloadCounter.inc();
 
         // clean the old stack
         removeAll(oldStack);
-        oldStack = null;
         loadingStack = null;
     }
 
@@ -490,55 +502,50 @@ private boolean checkAll(HttpServletRequest request, String cache, Nameable enti
             return false;
         }
 
-        Statistics stats = RuntimeEnvironment.getInstance().getStatistics();
-
         Boolean val;
         Map<String, Boolean> m = (Map<String, Boolean>) request.getAttribute(cache);
 
         if (m == null) {
             m = new TreeMap<>();
         } else if ((val = m.get(entity.getName())) != null) {
             // cache hit
-            stats.addRequest("authorization_cache_hits");
+            authCacheHits.inc();
             return val;
         }
 
-        stats.addRequest("authorization_cache_misses");
+        authCacheMisses.inc();
 
-        long time = 0;
-        boolean overallDecision = false;
+        Duration duration;
+        boolean overallDecision;
 
         lock.readLock().lock();
         try {
             // Make sure there is a HTTP session that corresponds to current plugin version.
             HttpSession session;
             if (((session = request.getSession(false)) != null) && isSessionInvalid(session)) {
                 session.invalidate();
-                stats.addRequest("authorization_sessions_invalidated");
+                authSessionsInvalidated.inc();
             }
             request.getSession().setAttribute(SESSION_VERSION, getPluginVersion());
 
-            time = System.currentTimeMillis();
-
+            Instant start = Instant.now();
             overallDecision = performCheck(entity, pluginPredicate, skippingPredicate);
+            Instant end = Instant.now();
+            duration = Duration.between(start, end);
         } finally {
             lock.readLock().unlock();
         }
 
-        if (time > 0) {
-            time = System.currentTimeMillis() - time;
-
-            stats.addRequestTime("authorization", time);
-            stats.addRequestTime(
-                    String.format("authorization_%s", overallDecision ? "positive" : "negative"),
-                    time);
-            stats.addRequestTime(
-                    String.format("authorization_%s_of_%s", overallDecision ? "positive" : "negative", entity.getName()),
-                    time);
-            stats.addRequestTime(
-                    String.format("authorization_of_%s", entity.getName()),
-                    time);
+        authTimer.update(duration);
+        if (overallDecision) {
+            authPositiveTimer.update(duration);
+        } else {
+            authNegativeTimer.update(duration);
         }
+        Metrics.getInstance().timer(String.format("authorization_of_%s", entity.getName())).update(duration);
+        Metrics.getInstance()
+                .timer(String.format("authorization_%s_of_%s", overallDecision ? "positive" : "negative", entity.getName()))
+                .update(duration);
 
         m.put(entity.getName(), overallDecision);
         request.setAttribute(cache, m);

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

@@ -18,22 +18,24 @@
  */
 
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.authorization;
 
+import java.time.Duration;
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.TreeMap;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+
+import org.opengrok.indexer.Metrics;
 import org.opengrok.indexer.configuration.Nameable;
-import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.logger.LoggerFactory;
-import org.opengrok.indexer.web.Statistics;
 
 /**
  * Subclass of {@link AuthorizationEntity}. It implements the methods to
@@ -222,8 +224,7 @@ protected boolean processStack(Nameable entity,
             PluginDecisionPredicate pluginPredicate,
             PluginSkippingPredicate skippingPredicate) {
 
-        Statistics stats = RuntimeEnvironment.getInstance().getStatistics();
-        long time = System.currentTimeMillis();
+        Instant start = Instant.now();
 
         boolean overallDecision = true;
         for (AuthorizationEntity authEntity : getStack()) {
@@ -282,17 +283,19 @@ protected boolean processStack(Nameable entity,
                 }
             }
         }
-        time = System.currentTimeMillis() - time;
-
-        stats.addRequestTime(
-                String.format("authorization_in_stack_%s_%s", getName(), overallDecision ? "positive" : "negative"),
-                time);
-        stats.addRequestTime(
-                String.format("authorization_in_stack_%s_%s_of_%s", getName(), overallDecision ? "positive" : "negative", entity.getName()),
-                time);
-        stats.addRequestTime(
-                String.format("authorization_in_stack_%s_of_%s", getName(), entity.getName()),
-                time);
+        Duration duration = Duration.between(start, Instant.now());
+
+        Metrics.getInstance()
+                .timer(String.format("authorization_in_stack_%s_%s", getName(),
+                        overallDecision ? "positive" : "negative"))
+                .update(duration);
+        Metrics.getInstance()
+                .timer(String.format("authorization_in_stack_%s_%s_of_%s", getName(),
+                        overallDecision ? "positive" : "negative", entity.getName()))
+                .update(duration);
+        Metrics.getInstance()
+                .timer(String.format("authorization_in_stack_%s_of_%s", getName(), entity.getName()))
+                .update(duration);
 
         return overallDecision;
     }

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2020, Chris Fraire <[email protected]>.
  * Portions Copyright (c) 2020, Aleksandr Kirillov <[email protected]>.
  */
@@ -76,7 +76,6 @@ public final class Configuration {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(Configuration.class);
     public static final String PLUGIN_DIRECTORY_DEFAULT = "plugins";
-    public static final String STATISTICS_FILE_DEFAULT = "statistics.json";
 
     /**
      * A check if a pattern contains at least one pair of parentheses meaning
@@ -217,7 +216,6 @@ public final class Configuration {
     private boolean scopesEnabled;
     private boolean projectsEnabled;
     private boolean foldingEnabled;
-    private String statisticsFilePath;
     /*
      * Set to false if we want to disable fetching history of individual files
      * (by running appropriate SCM command) when the history is not found
@@ -429,14 +427,6 @@ public void setCtagsTimeout(long timeout) throws IllegalArgumentException {
         this.ctagsTimeout = timeout;
     }
 
-    public String getStatisticsFilePath() {
-        return statisticsFilePath;
-    }
-
-    public void setStatisticsFilePath(String statisticsFilePath) {
-        this.statisticsFilePath = statisticsFilePath;
-    }
-
     public boolean isLastEditedDisplayMode() {
         return lastEditedDisplayMode;
     }
@@ -524,7 +514,6 @@ public Configuration() {
         setScanningDepth(defaultScanningDepth); // default depth of scanning for repositories
         setScopesEnabled(true);
         setSourceRoot(null);
-        setStatisticsFilePath(null);
         //setTabSize(4);
         setTagsEnabled(false);
         //setUserPage("http://www.myserver.org/viewProfile.jspa?username=");
@@ -848,21 +837,16 @@ public String getDataRoot() {
     /**
      * Sets data root.
      *
-     * This method also sets the pluginDirectory if it is not already set and
-     * also this method sets the statisticsFilePath if it is not already set
+     * This method also sets the pluginDirectory if it is not already set.
      *
      * @see #setPluginDirectory(java.lang.String)
-     * @see #setStatisticsFilePath(java.lang.String)
      *
      * @param dataRoot data root path
      */
     public void setDataRoot(String dataRoot) {
         if (dataRoot != null && getPluginDirectory() == null) {
             setPluginDirectory(dataRoot + "/../" + PLUGIN_DIRECTORY_DEFAULT);
         }
-        if (dataRoot != null && getStatisticsFilePath() == null) {
-            setStatisticsFilePath(dataRoot + "/" + STATISTICS_FILE_DEFAULT);
-        }
         this.dataRoot = dataRoot;
     }
 

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

@@ -72,7 +72,6 @@
 import org.opengrok.indexer.util.PathUtils;
 import org.opengrok.indexer.util.ResourceLock;
 import org.opengrok.indexer.web.Prefix;
-import org.opengrok.indexer.web.Statistics;
 import org.opengrok.indexer.web.Util;
 import org.opengrok.indexer.web.messages.Message;
 import org.opengrok.indexer.web.messages.MessagesContainer;
@@ -99,7 +98,6 @@ public final class RuntimeEnvironment {
     private final Map<String, SearcherManager> searcherManagerMap = new ConcurrentHashMap<>();
 
     private String configURI;
-    private Statistics statistics = new Statistics();
     IncludeFiles includeFiles = new IncludeFiles();
     private final MessagesContainer messagesContainer = new MessagesContainer();
 
@@ -251,14 +249,6 @@ public long getCtagsTimeout() {
     public void setCtagsTimeout(long ctagsTimeout) {
         syncWriteConfiguration(ctagsTimeout, Configuration::setCtagsTimeout);
     }
-    
-    public Statistics getStatistics() {
-        return statistics;
-    }
-
-    public void setStatistics(Statistics statistics) {
-        this.statistics = statistics;
-    }
 
     public void setLastEditedDisplayMode(boolean lastEditedDisplayMode) {
         syncWriteConfiguration(lastEditedDisplayMode, Configuration::setLastEditedDisplayMode);