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<String>

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

com.amazonaws.services.kinesis.metrics.impl.FilteringMetricsScope

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

All Implemented Interfaces:

IMetricsScope

public class CWMetricsScope
extends FilteringMetricsScope
implements IMetricsScope

Metrics scope for CloudWatch metrics.

Field Summary

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

data

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

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
CWMetricsScope(CWPublisherRunnable<CWMetricKey> publisher, MetricsLevel metricsLevel, Set<String> metricsEnabledDimensions) Creates a CloudWatch metrics scope with given metrics level and enabled dimensions.

Method Summary

Modifier and Type	Method and Description
void	end() Once we call this method, all MetricDatums added to the scope will be enqueued to the publisher runnable.

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

addData, addData, addDimension

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

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

addData, addData, addDimension

Constructor Detail

CWMetricsScope

public CWMetricsScope(CWPublisherRunnable<CWMetricKey> publisher,
                      MetricsLevel metricsLevel,
                      Set<String> metricsEnabledDimensions)

Creates a CloudWatch metrics scope with given metrics level and enabled dimensions.

Parameters:

publisher - Publisher that emits CloudWatch metrics periodically.

metricsLevel - Metrics level to enable. All data with level below this will be dropped.

metricsEnabledDimensions - Enabled dimensions for CloudWatch metrics.

Method Detail

end

public void end()

Once we call this method, all MetricDatums added to the scope will be enqueued to the publisher runnable. We enqueue MetricDatumWithKey because the publisher will aggregate similar metrics (i.e. MetricDatum with the same metricName) in the background thread. Hence aggregation using MetricDatumWithKey will be especially useful when aggregating across multiple MetricScopes.

Specified by:

end in interface IMetricsScope

Overrides:

end in class EndingMetricsScope