com.amazonaws.services.kinesis.metrics.impl

Class AccumulatingMetricsScope<KeyType>

java.lang.Object

com.amazonaws.services.kinesis.metrics.impl.DimensionTrackingMetricsScope

com.amazonaws.services.kinesis.metrics.impl.EndingMetricsScope

com.amazonaws.services.kinesis.metrics.impl.AccumulatingMetricsScope<KeyType>

Type Parameters:

KeyType - can be a class or object defined by the user that stores information about a MetricDatum needed by the user. The following is a example of what a KeyType class might look like: class SampleKeyType { private long timeKeyCreated; private MetricDatum datum; public SampleKeyType(long timeKeyCreated, MetricDatum datum){ this.timeKeyCreated = timeKeyCreated; this.datum = datum; } }

All Implemented Interfaces:

IMetricsScope

Direct Known Subclasses:

AccumulateByNameMetricsScope

public abstract class AccumulatingMetricsScope<KeyType>
extends EndingMetricsScope

An IMetricsScope that accumulates data from multiple calls to addData with the same name parameter. It tracks min, max, sample count, and sum for each named metric.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<KeyType,MetricDatum>	data

Fields inherited from interface com.amazonaws.services.kinesis.metrics.interfaces.IMetricsScope

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
AccumulatingMetricsScope()

Method Summary

Modifier and Type	Method and Description
void	addData(KeyType key, java.lang.String name, double value, StandardUnit unit) Adds data points to an IMetricsScope.
void	addData(java.lang.String name, double value, StandardUnit unit) Adds a data point to this IMetricsScope.
void	addData(java.lang.String name, double value, StandardUnit unit, MetricsLevel level) Adds a data point to this IMetricsScope if given metrics level is enabled.
protected abstract KeyType	getKey(java.lang.String name)

Methods inherited from class com.amazonaws.services.kinesis.metrics.impl.EndingMetricsScope

addDimension, end

Methods inherited from class com.amazonaws.services.kinesis.metrics.impl.DimensionTrackingMetricsScope

getDimensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

data

protected java.util.Map<KeyType,MetricDatum> data

Constructor Detail

AccumulatingMetricsScope

public AccumulatingMetricsScope()

Method Detail

addData

public void addData(java.lang.String name,
                    double value,
                    StandardUnit unit)

Description copied from interface: IMetricsScope

Adds a data point to this IMetricsScope. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Specified by:

addData in interface IMetricsScope

Overrides:

addData in class EndingMetricsScope

Parameters:

name - data point name

value - data point value

unit - unit of data point

addData

public void addData(java.lang.String name,
                    double value,
                    StandardUnit unit,
                    MetricsLevel level)

Description copied from interface: IMetricsScope

Adds a data point to this IMetricsScope if given metrics level is enabled. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Specified by:

addData in interface IMetricsScope

Overrides:

addData in class EndingMetricsScope

Parameters:

name - data point name

value - data point value

unit - unit of data point

level - metrics level of this data point

getKey

protected abstract KeyType getKey(java.lang.String name)

Parameters:

name - key name for a metric

Returns:

the name of the key

addData

public void addData(KeyType key,
                    java.lang.String name,
                    double value,
                    StandardUnit unit)

Adds data points to an IMetricsScope. Multiple calls to IMetricsScopes that have the same key will have their data accumulated.

Parameters:

key - data point key

name - data point name

value - data point value

unit - data point unit