com.j256.simplemetrics.metric

Class ControlledMetricAccum

java.lang.Object

com.j256.simplemetrics.metric.BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

com.j256.simplemetrics.metric.ControlledMetricAccum

All Implemented Interfaces:

com.j256.simplejmx.common.JmxSelfNaming, ControlledMetric<Long,ControlledMetricAccum.AccumValue>, Comparable<BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>>

public class ControlledMetricAccum
extends BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

Managed ControlledMetric for metrics like page-count or database-accesses that you are adding to continually as opposed to a ControlledMetricValue.

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlledMetricAccum.AccumValue Wrapper around a long counter and a reset flag.

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

ControlledMetric.AggregationType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	add(long delta) Add a delta value to the metric.
void	adjustValue(long value) Adjust the value by a long primitive value.
void	adjustValue(Number value) Adjust the metric with this value.
ControlledMetricAccum.AccumValue	createInitialValue() Create the initial value for our metric.
ControlledMetric.AggregationType	getAggregationType() Returns the type of aggregation used by this metric.
Number	getValue() Return the number of the metric.
MetricValueDetails	getValueDetails() Return the value details of the metric.
MetricValueDetails	getValueDetailsToPersist() Get the current value details for persisting purposes.
Number	getValueToPersist() Get the current number for persisting purposes.
long	increment() Add one to the metric.
Long	makeValueFromLong(long value) Make a value type from long input.
Long	makeValueFromNumber(Number value) Make a value type from Number input.

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

compareTo, equals, getAggregationTypeName, getComponent, getDescription, getJmxBeanName, getJmxDomainName, getJmxFolderNames, getMetricValue, getModule, getName, getUnit, hashCode, storeValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlledMetricAccum

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

Parameters:

component - Component short name such as "my". Required.

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

name - String label description the metric. Required.

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

unit - Unit of the metric. Null if none.

Method Detail

createInitialValue

public ControlledMetricAccum.AccumValue createInitialValue()

Description copied from interface: ControlledMetric

Create the initial value for our metric.

makeValueFromLong

public Long 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 Long makeValueFromNumber(Number value)

Description copied from interface: ControlledMetric

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

add

public long add(long delta)

Add a delta value to the metric. This is for metrics (like pageview count) which are incrementing over time.

increment

public long increment()

Add one to the metric.

adjustValue

public void adjustValue(long value)

Description copied from interface: ControlledMetric

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.

Specified by:

adjustValue in interface ControlledMetric<Long,ControlledMetricAccum.AccumValue>

Overrides:

adjustValue in class BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

adjustValue

public void adjustValue(Number value)

Description copied from interface: ControlledMetric

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.

Specified by:

adjustValue in interface ControlledMetric<Long,ControlledMetricAccum.AccumValue>

Overrides:

adjustValue in class BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

getValue

public Number getValue()

Description copied from class: BaseControlledMetric

Return the number of the metric. This is a transient value good for JMX or other direct monitoring of the metric. Use BaseControlledMetric.getValueToPersist() if you want to save the value to disk.

Specified by:

getValue in interface ControlledMetric<Long,ControlledMetricAccum.AccumValue>

Overrides:

getValue in class BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

getValueDetails

public MetricValueDetails getValueDetails()

Description copied from class: BaseControlledMetric

Return the value details of the metric. This is a transient value good for JMX or other direct monitoring of the metric. Use BaseControlledMetric.getValueDetailsToPersist() if you want to save the value to disk.

Specified by:

getValueDetails in interface ControlledMetric<Long,ControlledMetricAccum.AccumValue>

Overrides:

getValueDetails in class BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

getValueToPersist

public Number getValueToPersist()

Description copied from class: BaseControlledMetric

Get the current number for persisting purposes. This causes the metrics to be set to reset on next adjustment.

Specified by:

getValueToPersist in interface ControlledMetric<Long,ControlledMetricAccum.AccumValue>

Overrides:

getValueToPersist in class BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

getValueDetailsToPersist

public MetricValueDetails getValueDetailsToPersist()

Description copied from class: BaseControlledMetric

Get the current value details for persisting purposes. This causes the metrics to be set to reset on next adjustment.

Specified by:

getValueDetailsToPersist in interface ControlledMetric<Long,ControlledMetricAccum.AccumValue>

Overrides:

getValueDetailsToPersist in class BaseControlledMetric<Long,ControlledMetricAccum.AccumValue>

getAggregationType

public ControlledMetric.AggregationType getAggregationType()

Description copied from interface: ControlledMetric

Returns the type of aggregation used by this metric.