org.avaje.metric.GaugeDoubleMetric 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;

/**
 * Metric based on a gauge returning double values.
 * 
 * A GaugeDoubleMetric is created by {@link MetricManager#register(MetricName, GaugeDouble)}.
 * 
 * 

 * Example:
 * 
 * 
 * 
 *   class FreeMemoryGauge implements GaugeDouble {
 *       
 *       public double getValue() {
 *         return mxBean.getFreeMemory() / mxBean.getTotalMemory();
 *       }
 *     }
 *   
 *   
 *   GaugeDoubleMetric gauge = MetricManager.register("jvm.memory.pctfree", freeMemoryGauge);
 *     
 * 
 * 
 * 
 * Note that avaje-metric-core registers some core JVM gauges that include threads, memory
 * and garbage collection.
 */
public interface GaugeDoubleMetric extends Metric {

  /**
   * Return the value.
   */
  double getValue();

}