com.j256.simplemetrics.metric

Interface ControlledMetric<V,MV extends MetricValue<V,MV>>

Type Parameters:

V - Value type that is stored inside of the metric. It can be a decimal, floating point, or custom type.

MV - Metric value which wraps and manages the raw value.

All Known Implementing Classes:

BaseControlledMetric, ControlledMetricAccum, ControlledMetricRatio, ControlledMetricTimer, ControlledMetricValue

public interface ControlledMetric<V,MV extends MetricValue<V,MV>>

Metric which is managed by the system.

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ControlledMetric.AggregationType When we need to aggregate multiple values of this metric, this determines how we do so.

Method Summary

Modifier and Type	Method and Description
void	adjustValue(long value) Adjust the value by a long primitive value.
void	adjustValue(Number value) Adjust the metric with this value.
MV	createInitialValue() Create the initial value for our metric.
ControlledMetric.AggregationType	getAggregationType() Returns the type of aggregation used by this metric.
String	getAggregationTypeName() Return the aggregation type of the metric.
String	getComponent() Component name of the metric.
String	getDescription() Description of the component which is not persisted.
String	getModule() Module name of the metric or null if none.
String	getName() Component name of the metric.
String	getUnit() Unit of the metric such as percentage, megabytes, or per-second.
Number	getValue() Returned the value of the metric as a number.
MetricValueDetails	getValueDetails() Return the value details of the metric.
MetricValueDetails	getValueDetailsToPersist() Return the value details of the metric suitable to be persisted.
Number	getValueToPersist() Return the value of the metric as a number suitable to be persisted.
V	makeValueFromLong(long value) Make a value type from long input.
V	makeValueFromNumber(Number number) Make a value type from Number input.

Method Detail

getComponent

String getComponent()

Component name of the metric. This can be something like "heap".

getModule

String getModule()

Module name of the metric or null if none. This can be something like "oldGen".

getName

String getName()

Component name of the metric. This can be something like "usedPercentage".

getDescription

String getDescription()

Description of the component which is not persisted. Here for code documentation purposes and JMX.

getUnit

String getUnit()

Unit of the metric such as percentage, megabytes, or per-second.

getAggregationTypeName

String getAggregationTypeName()

Return the aggregation type of the metric.

createInitialValue

MV createInitialValue()

Create the initial value for our metric.

adjustValue

void adjustValue(long value)

Adjust the value by a long primitive value. If this is an accumulator then it will be added. If this is a value then it will bet set.

adjustValue

void adjustValue(Number value)

Adjust the metric with this value. If this is an accumulator then it will be added. If this is a value then it will bet set.

makeValueFromLong

V makeValueFromLong(long value)

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

makeValueFromNumber

V makeValueFromNumber(Number number)

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

getValue

Number getValue()

Returned the value of the metric as a number.

getValueDetails

MetricValueDetails getValueDetails()

Return the value details of the metric.

getValueToPersist

Number getValueToPersist()

Return the value of the metric as a number suitable to be persisted.

getValueDetailsToPersist

MetricValueDetails getValueDetailsToPersist()

Return the value details of the metric suitable to be persisted.

getAggregationType

ControlledMetric.AggregationType getAggregationType()

Returns the type of aggregation used by this metric.