com.j256.simplemetrics.metric

Class ControlledMetricRatio

java.lang.Object

com.j256.simplemetrics.metric.BaseControlledMetric<ControlledMetricRatio.NumeratorDenominator,ControlledMetricRatio.RatioValue>

com.j256.simplemetrics.metric.ControlledMetricRatio

All Implemented Interfaces:

com.j256.simplejmx.common.JmxSelfNaming, ControlledMetric<ControlledMetricRatio.NumeratorDenominator,ControlledMetricRatio.RatioValue>, Comparable<BaseControlledMetric<ControlledMetricRatio.NumeratorDenominator,ControlledMetricRatio.RatioValue>>

public class ControlledMetricRatio
extends BaseControlledMetric<ControlledMetricRatio.NumeratorDenominator,ControlledMetricRatio.RatioValue>

A metric which tracks the relationship between two values. For example, if you want to account for a cache hit ratio or the average number of results per query. We manage this as a numerator and a denominator to ensure we don't lose value resolution.

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlledMetricRatio.NumeratorDenominator Class which holds a numerator and denominator double.
static class	ControlledMetricRatio.RatioValue Wrapper around a numerator and denominator.

Nested classes/interfaces inherited from interface com.j256.simplemetrics.metric.ControlledMetric

ControlledMetric.AggregationType

Constructor Summary

Constructors

Constructor and Description
ControlledMetricRatio(String component, String module, String name, String description, String unit)

Method Summary

Modifier and Type	Method and Description
void	adjustValue(Number numerator, Number denominator) Adjust the value of our numerator and denominator to set new values for it.
ControlledMetricRatio.RatioValue	createInitialValue() Create the initial value for our metric.
ControlledMetric.AggregationType	getAggregationType() Returns the type of aggregation used by this metric.
ControlledMetricRatio.NumeratorDenominator	makeValueFromLong(long value) Make a value type from long input.
ControlledMetricRatio.NumeratorDenominator	makeValueFromNumber(Number number) Make a value type from Number input.

Methods inherited from class com.j256.simplemetrics.metric.BaseControlledMetric

adjustValue, adjustValue, compareTo, equals, getAggregationTypeName, getComponent, getDescription, getJmxBeanName, getJmxDomainName, getJmxFolderNames, getMetricValue, getModule, getName, getUnit, getValue, getValueDetails, getValueDetailsToPersist, getValueToPersist, hashCode, storeValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ControlledMetricRatio

public ControlledMetricRatio(String component,
                             String module,
                             String name,
                             String description,
                             String unit)

Parameters:

component - Component short name such as "web".

module - Module name to identify the part of the component such as "pageview".

name - String label description the metric.

description - Description for more information which may not be persisted.

unit - Unit of the metric.

Method Detail

createInitialValue

public ControlledMetricRatio.RatioValue createInitialValue()

Description copied from interface: ControlledMetric

Create the initial value for our metric.

makeValueFromLong

public ControlledMetricRatio.NumeratorDenominator makeValueFromLong(long value)

Description copied from interface: ControlledMetric

Make a value type from long input. This is only needed to support the ControlledMetric.adjustValue(long) method.

makeValueFromNumber

public ControlledMetricRatio.NumeratorDenominator makeValueFromNumber(Number number)

Description copied from interface: ControlledMetric

Make a value type from Number input. This is only needed to support the ControlledMetric.adjustValue(Number) method.

getAggregationType

public ControlledMetric.AggregationType getAggregationType()

Description copied from interface: ControlledMetric

Returns the type of aggregation used by this metric.

adjustValue

public void adjustValue(Number numerator,
                        Number denominator)

Adjust the value of our numerator and denominator to set new values for it. These will be added to the running values for the numerator and denominator. For example, if you want to account for a cache miss (i.e. a request and a miss) then you would say adjustValue(0, 1). Or if you are counting the number of results per query you might say adjustValue(3, 1). NOTE: if you just want to set the value of this ratio and not have it be a running total, then you should consider just using a ControlledMetricValue.