software.amazon.kinesis.metrics

Class CloudWatchMetricsScope

java.lang.Object

software.amazon.kinesis.metrics.DimensionTrackingMetricsScope

software.amazon.kinesis.metrics.EndingMetricsScope

software.amazon.kinesis.metrics.AccumulatingMetricsScope<String>

software.amazon.kinesis.metrics.AccumulateByNameMetricsScope

software.amazon.kinesis.metrics.FilteringMetricsScope

software.amazon.kinesis.metrics.CloudWatchMetricsScope

All Implemented Interfaces:

MetricsScope

public class CloudWatchMetricsScope
extends FilteringMetricsScope
implements MetricsScope

Metrics scope for CloudWatch metrics.

Field Summary

Fields inherited from class software.amazon.kinesis.metrics.AccumulatingMetricsScope

data

Fields inherited from interface software.amazon.kinesis.metrics.MetricsScope

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
CloudWatchMetricsScope(CloudWatchPublisherRunnable 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 software.amazon.kinesis.metrics.FilteringMetricsScope

addData, addData, addDimension

Methods inherited from class software.amazon.kinesis.metrics.AccumulateByNameMetricsScope

getKey

Methods inherited from class software.amazon.kinesis.metrics.AccumulatingMetricsScope

addData

Methods inherited from class software.amazon.kinesis.metrics.DimensionTrackingMetricsScope

getDimensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.kinesis.metrics.MetricsScope

addData, addData, addDimension

Constructor Detail

CloudWatchMetricsScope

public CloudWatchMetricsScope(CloudWatchPublisherRunnable 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 MetricsScope

Overrides:

end in class EndingMetricsScope