#13 - Add ability to easily suppress reporting on small timed metrics via MetricReportConfig.setThresholdMean()

Author: rbygrave

src/main/java/org/avaje/metric/report/CsvReportWriter.java

@@ -21,31 +21,31 @@ public class CsvReportWriter implements ReportWriter {
 
   protected final String endOfLine;
 
+  protected final long thresholdMean;
+
   /**
    * Create as comma delimited with newline character at the end of each line.
    */
-  public CsvReportWriter() {
-    this("HH:mm:ss", 2, ", ", "\n");
+  public CsvReportWriter(long thresholdMean) {
+    this("HH:mm:ss", 2, ", ", "\n", thresholdMean);
   }
 
   /**
    * Construct with all the format options.
    *
-   * @param timeNowFormat
-   *          The date time format for the collection time. Typically this is HH:mm:ss.
-   * @param decimalPlaces
-   *          The number of decimal places to format double values. This typically defaults to 2.
-   * @param delimiter
-   *          A string that separates the columns and typically a comma.
-   * @param endOfLine
-   *          A string added at the end of each metric and typically a newline character.
+   * @param timeNowFormat  The date time format for the collection time. Typically this is HH:mm:ss.
+   * @param decimalPlaces  The number of decimal places to format double values. This typically defaults to 2.
+   * @param delimiter      A string that separates the columns and typically a comma.
+   * @param endOfLine      A string added at the end of each metric and typically a newline character.
+   * @param thresholdMean  A threshold mean value that can be used to suppress reporting on small metrics.
    */
-  public CsvReportWriter(String timeNowFormat, int decimalPlaces, String delimiter, String endOfLine) {
+  public CsvReportWriter(String timeNowFormat, int decimalPlaces, String delimiter, String endOfLine, long thresholdMean) {
 
     this.nowFormatter = new SimpleDateFormat(timeNowFormat);
     this.decimalPlaces = decimalPlaces;
     this.delimiter = delimiter;
     this.endOfLine = endOfLine;
+    this.thresholdMean = thresholdMean;
   }
 
   /**
@@ -57,7 +57,7 @@ public void write(Writer writer, ReportMetrics reportMetrics) throws IOException
 
     String timeNowFormatted = nowFormatter.format(new Date());
 
-    CsvWriteVisitor visitor = new CsvWriteVisitor(writer, timeNowFormatted, decimalPlaces, delimiter, endOfLine);
+    CsvWriteVisitor visitor = new CsvWriteVisitor(writer, timeNowFormatted, decimalPlaces, delimiter, endOfLine, thresholdMean);
     visitor.write(reportMetrics);
   }
 

src/main/java/org/avaje/metric/report/CsvWriteVisitor.java

@@ -85,6 +85,11 @@ public class CsvWriteVisitor implements MetricVisitor {
    */
   protected final Writer writer;
 
+  /**
+   * A threshold mean value used to suppress reporting of small timed metrics values.
+   */
+  protected final long thresholdMean;
+
   /**
    * Set to true when reporting error metrics (to get the "err." prefix on the metric name).
    */
@@ -97,8 +102,8 @@ public class CsvWriteVisitor implements MetricVisitor {
    * @param collectTimeFormatted The time the metrics were collected. Typically in HH:mm:ss format.
    * @param decimalPlaces        The number of decimal places to format double values. Typically 2.
    */
-  public CsvWriteVisitor(Writer writer, String collectTimeFormatted, int decimalPlaces) {
-    this(writer, collectTimeFormatted, decimalPlaces, ", ", "\n");
+  public CsvWriteVisitor(Writer writer, String collectTimeFormatted, int decimalPlaces, long thresholdMean) {
+    this(writer, collectTimeFormatted, decimalPlaces, ", ", "\n", thresholdMean);
   }
 
   /**
@@ -110,14 +115,16 @@ public CsvWriteVisitor(Writer writer, String collectTimeFormatted, int decimalPl
    * @param delimiter            The delimiter string that prefixes each column.
    * @param endOfLine            The character appended after each metric has been output. Typically the newline character.
    */
-  public CsvWriteVisitor(Writer writer, String collectTimeFormatted, int decimalPlaces, String delimiter, String endOfLine) {
+  public CsvWriteVisitor(Writer writer, String collectTimeFormatted, int decimalPlaces,
+                         String delimiter, String endOfLine, long thresholdMean) {
 
     this.collectTime = System.currentTimeMillis();
     this.writer = writer;
     this.collectTimeFormatted = collectTimeFormatted;
     this.decimalPlaces = decimalPlaces;
     this.delimiter = delimiter;
     this.endOfLine = endOfLine;
+    this.thresholdMean = thresholdMean;
   }
 
   /**
@@ -146,9 +153,19 @@ protected void writeMetricEnd(Metric metric) throws IOException {
   @Override
   public void visit(TimedMetric metric) throws IOException {
 
+    ValueStatistics successStats = metric.getCollectedSuccessStatistics();
+    ValueStatistics errorStats = metric.getCollectedErrorStatistics();
+    if (thresholdMean > 0) {
+      if (successStats.getMean() < thresholdMean && errorStats.getMean() < thresholdMean) {
+        // suppress reporting based on threshold mean (typically when discovering which
+        // metrics we really want to report on etc).
+        return;
+      }
+    }
+
     writeMetricName(metric, "tm");
-    writeSummary("", metric.getCollectedSuccessStatistics());
-    writeSummary("err.", metric.getCollectedErrorStatistics());
+    writeSummary("", successStats);
+    writeSummary("err.", errorStats);
     writeMetricEnd(metric);
   }
 

src/main/java/org/avaje/metric/report/FileReporter.java

@@ -53,7 +53,7 @@ public FileReporter(String baseDirectory, String baseFileName, ReportWriter repo
   public FileReporter(String baseDirectory, String baseFileName, int numberOfFilesToKeep, ReportWriter reportWriter) {
 
     super(baseDirectory, baseFileName, numberOfFilesToKeep);
-    this.reportWriter = (reportWriter != null) ? reportWriter : new CsvReportWriter();
+    this.reportWriter = (reportWriter != null) ? reportWriter : new CsvReportWriter(0);
 
     cleanup();
   }

src/main/java/org/avaje/metric/report/MetricReportConfig.java

@@ -29,6 +29,8 @@ public class MetricReportConfig {
 
   int requestTimingThreshold;
 
+  long thresholdMean;
+
   ScheduledExecutorService executor;
 
   List<RequestTimingListener> requestTimingListeners = new ArrayList<>();
@@ -167,6 +169,22 @@ public void setRequestsFreqInSeconds(int requestsFreqInSeconds) {
     this.requestsFreqInSeconds = requestsFreqInSeconds;
   }
 
+  /**
+   * Return a threshold mean in microseconds that can be used to suppress
+   * reporting on uninteresting metrics.
+   */
+  public long getThresholdMean() {
+    return thresholdMean;
+  }
+
+  /**
+   * Set a threshold mean in microseconds that can be used to suppress
+   * reporting on uninteresting metrics.
+   */
+  public void setThresholdMean(long thresholdMean) {
+    this.thresholdMean = thresholdMean;
+  }
+
   /**
    * Return the local reporter to use. This is typically a reporter that writes metrics out to a local file system.
    */

src/main/java/org/avaje/metric/report/MetricReportManager.java

@@ -100,7 +100,7 @@ protected MetricReporter defaultReporter(MetricReportConfig config) {
     if (config.getLocalReporter() != null) {
       return config.getLocalReporter();
     }
-    return new FileReporter(config.getDirectory(), config.getMetricsFileName(), new CsvReportWriter());
+    return new FileReporter(config.getDirectory(), config.getMetricsFileName(), new CsvReportWriter(config.getThresholdMean()));
   }
 
   /**

src/test/java/org/avaje/metric/report/CsvFileReporterTest.java

@@ -12,12 +12,15 @@ public class CsvFileReporterTest {
 
   @Test
   public void exercise_with_MetricReportManager() throws InterruptedException, IOException {
-    
-    FileReporter fileReporter = new FileReporter(".", "metric-csv-exercise");
+
+    //CsvReportWriter csvReportWriter = new CsvReportWriter(40000);
+    //FileReporter fileReporter = new FileReporter(".", "metric-csv-exercise", csvReportWriter);
 
     MetricReportConfig config = new MetricReportConfig();
     config.setFreqInSeconds(1);
-    config.setLocalReporter(fileReporter);
+    config.setMetricsFileName("metric-csv-exercise2");
+    //config.setThresholdMean(40000);
+    //config.setLocalReporter(fileReporter);
 
     MetricReportManager report = new MetricReportManager(config);
 

src/test/java/org/avaje/metric/report/CsvWriteVisitorTest.java

@@ -43,7 +43,7 @@ public void testCounter() throws IOException {
 
 
   private CsvWriteVisitor createVisitor(StringWriter writer) {
-    return new CsvWriteVisitor(writer, "10:00:00", 2, ",", "\n");
+    return new CsvWriteVisitor(writer, "10:00:00", 2, ",", "\n", 0);
   }