return indication if logging was performed

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/index/DefaultIndexChangedListener.java

@@ -61,12 +61,13 @@ public void fileRemove(String path) {
     public void fileAdded(String path, String analyzer) {
         Statistics stat = statMap.get(path);
         if (stat != null) {
-            stat.report(LOGGER, Level.FINEST, String.format("Added: '%s' (%s)", path, analyzer),
+            boolean ret = stat.report(LOGGER, Level.FINEST, String.format("Added: '%s' (%s)", path, analyzer),
                     "indexer.file.add.latency");
             statMap.remove(path, stat);
 
-            // The reporting updated the meter, however might not have emitted the log message.
-            if (LOGGER.isLoggable(Level.FINEST)) {
+            // The report() updated the meter, however might not have emitted the log message.
+            // In such case allow it to fall through to the below log() statement.
+            if (ret) {
                 return;
             }
         }

opengrok-indexer/src/main/java/org/opengrok/indexer/util/Statistics.java

@@ -43,21 +43,33 @@ public Statistics() {
       startTime = Instant.now();
   }
 
-    private void logIt(Logger logger, Level logLevel, String msg, Duration duration) {
+    /**
+     * Log a message with duration using provided logger if the supplied log level is active.
+     * @param logger logger instance
+     * @param logLevel log level
+     * @param msg message string
+     * @param duration duration to report
+     * @return whether logging was performed
+     */
+    private boolean logIt(Logger logger, Level logLevel, String msg, Duration duration) {
         if (logger.isLoggable(logLevel)) {
             String timeStr = StringUtils.getReadableTime(duration.toMillis());
             logger.log(logLevel, String.format("%s (took %s)", msg, timeStr));
+            return true;
         }
+
+        return false;
     }
 
     /**
      * Log a message along with how much time it took since the constructor was called.
      * @param logger logger instance
      * @param logLevel log level
      * @param msg message string
+     * @return whether logging was performed
      */
-    public void report(Logger logger, Level logLevel, String msg) {
-        logIt(logger, logLevel, msg, Duration.between(startTime, Instant.now()));
+    public boolean report(Logger logger, Level logLevel, String msg) {
+        return logIt(logger, logLevel, msg, Duration.between(startTime, Instant.now()));
     }
 
     /**
@@ -68,9 +80,10 @@ public void report(Logger logger, Level logLevel, String msg) {
      * @param msg message string
      * @param meterName name of the meter
      * @see Metrics#getRegistry()
+     * @return whether logging was performed
      */
-    public void report(Logger logger, Level logLevel, String msg, String meterName) {
-        report(logger, logLevel, msg, meterName, new String[]{});
+    public boolean report(Logger logger, Level logLevel, String msg, String meterName) {
+        return report(logger, logLevel, msg, meterName, new String[]{});
     }
 
     /**
@@ -82,11 +95,12 @@ public void report(Logger logger, Level logLevel, String msg, String meterName)
      * @param meterName name of the meter
      * @param tags array of tags for the meter
      * @see Metrics#getRegistry()
+     * @return whether logging was performed
      */
-    public void report(Logger logger, Level logLevel, String msg, String meterName, String[] tags) {
+    public boolean report(Logger logger, Level logLevel, String msg, String meterName, String[] tags) {
         Duration duration = Duration.between(startTime, Instant.now());
 
-        logIt(logger, logLevel, msg, duration);
+        boolean ret = logIt(logger, logLevel, msg, duration);
 
         MeterRegistry registry = Metrics.getRegistry();
         if (registry != null) {
@@ -95,6 +109,8 @@ public void report(Logger logger, Level logLevel, String msg, String meterName,
                     register(registry).
                     record(duration);
         }
+
+        return ret;
     }
 
     /**
@@ -104,18 +120,20 @@ public void report(Logger logger, Level logLevel, String msg, String meterName,
      * @param logger logger instance
      * @param msg message string
      * @param meterName name of the meter
+     * @return whether logging was performed
      */
-    public void report(Logger logger, String msg, String meterName) {
-        report(logger, Level.INFO, msg, meterName);
+    public boolean report(Logger logger, String msg, String meterName) {
+        return report(logger, Level.INFO, msg, meterName);
     }
 
     /**
      * log a message along with how much time it took since the constructor was called.
      * The log level is {@code INFO}.
      * @param logger logger instance
      * @param msg message string
+     * @return whether logging was performed
      */
-    public void report(Logger logger, String msg) {
-        report(logger, Level.INFO, msg);
+    public boolean report(Logger logger, String msg) {
+        return report(logger, Level.INFO, msg);
     }
 }