org.avaje.metric.ValueStatistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of avaje-metric-api Show documentation

The newest version!

package org.avaje.metric;

/**
 * Statistics collected by ValueMetric or TimedMetric.
 */
public interface ValueStatistics {

  /**
   * Return the time these statistics were collected from.
   * 
   * This should equate to the last time the statistics were collected for reporting purposes so if
   * that is ever minute then this would return the epoch time of 1 minute ago.
   */
  long getStartTime();

  /**
   * Return the count of values collected (since the last reset/collection).
   */
  long getCount();

  /**
   * Return the total of all the values (since the last reset/collection).
   */
  long getTotal();

  /**
   * Return the Max value collected (since the last reset/collection).
   */
  long getMax();

  /**
   * Return the mean value rounded up for the values collected since the last reset/collection.
   */
  long getMean();

}