com.amazonaws.services.kinesis.metrics.impl

Class CWMetricsScope

java.lang.Object

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

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

com.amazonaws.services.kinesis.metrics.impl.AccumulatingMetricsScope<java.lang.String>

com.amazonaws.services.kinesis.metrics.impl.AccumulateByNameMetricsScope

com.amazonaws.services.kinesis.metrics.impl.CWMetricsScope

All Implemented Interfaces:

IMetricsScope

public class CWMetricsScope
extends AccumulateByNameMetricsScope
implements IMetricsScope

Field Summary

Fields inherited from class com.amazonaws.services.kinesis.metrics.impl.AccumulatingMetricsScope

data

Constructor Summary

Constructors

Constructor and Description
CWMetricsScope(CWPublisherRunnable<CWMetricKey> publisher) Each CWMetricsScope takes a publisher which contains the logic of when to publish metrics.

Method Summary

Methods

Modifier and Type	Method and Description
void	addData(java.lang.String name, double value, StandardUnit unit) Adds a data point to this IMetricsScope.
void	addDimension(java.lang.String name, java.lang.String value) Adds a dimension that applies to all metrics in this IMetricsScope.
void	end() Flushes the data from this IMetricsScope and causes future calls to addData and addDimension to fail.

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

getKey

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

addData

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

Constructor Detail

CWMetricsScope

public CWMetricsScope(CWPublisherRunnable<CWMetricKey> publisher)

Each CWMetricsScope takes a publisher which contains the logic of when to publish metrics.

Parameters:

publisher - publishing logic

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 AccumulatingMetricsScope<java.lang.String>

Parameters:

name - data point name

value - data point value

unit - unit of data point

addDimension

public void addDimension(java.lang.String name,
                java.lang.String value)

Description copied from interface: IMetricsScope

Adds a dimension that applies to all metrics in this IMetricsScope.

Specified by:

addDimension in interface IMetricsScope

Overrides:

addDimension in class EndingMetricsScope

Parameters:

name - dimension name

value - dimension value

end

public void end()

Description copied from interface: IMetricsScope

Flushes the data from this IMetricsScope and causes future calls to addData and addDimension to fail.

Specified by:

end in interface IMetricsScope

Overrides:

end in class EndingMetricsScope