com.amazonaws.services.kinesis.metrics.impl

Class FilteringMetricsScope

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

All Implemented Interfaces:

IMetricsScope

Direct Known Subclasses:

CWMetricsScope

public class FilteringMetricsScope
extends AccumulateByNameMetricsScope

An IMetricsScope that filters addData(java.lang.String, double, com.amazonaws.services.cloudwatch.model.StandardUnit) calls based on the provided metrics level. If the provided metrics level is less than enabled level, then data is dropped. This class also adds the dimension to the scope if it is enabled.

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
FilteringMetricsScope() Creates a metrics scope that allows all metrics data and dimensions.
FilteringMetricsScope(MetricsLevel metricsLevel, Set<String> metricsEnabledDimensions) Creates a metrics scope that drops data with level below the given enabled level and only allows dimensions that are part of the given enabled dimensions list.

Method Summary

Modifier and Type	Method and Description
void	addData(String name, double value, com.amazonaws.services.cloudwatch.model.StandardUnit unit) Adds the data to the metrics scope at lowest metrics level.
void	addData(String name, double value, com.amazonaws.services.cloudwatch.model.StandardUnit unit, MetricsLevel level) Adds the data to the metrics scope if the given level is equal to above the enabled metrics level.
void	addDimension(String name, String value) Adds given dimension with value if allowed dimensions list contains this dimension's name.

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.EndingMetricsScope

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

Constructor Detail

FilteringMetricsScope

public FilteringMetricsScope()

Creates a metrics scope that allows all metrics data and dimensions.

FilteringMetricsScope

public FilteringMetricsScope(MetricsLevel metricsLevel,
                             Set<String> metricsEnabledDimensions)

Creates a metrics scope that drops data with level below the given enabled level and only allows dimensions that are part of the given enabled dimensions list.

Parameters:

metricsLevel - Level of metrics that is enabled. All metrics below this level will be dropped.

metricsEnabledDimensions - Enabled dimensions.

Method Detail

addData

public void addData(String name,
                    double value,
                    com.amazonaws.services.cloudwatch.model.StandardUnit unit)

Adds the data to the metrics scope at lowest metrics level.

Specified by:

addData in interface IMetricsScope

Overrides:

addData in class AccumulatingMetricsScope<String>

Parameters:

name - Metrics data name.

value - Value of the metrics.

unit - Unit of the metrics.

addData

public void addData(String name,
                    double value,
                    com.amazonaws.services.cloudwatch.model.StandardUnit unit,
                    MetricsLevel level)

Adds the data to the metrics scope if the given level is equal to above the enabled metrics level.

Specified by:

addData in interface IMetricsScope

Overrides:

addData in class AccumulatingMetricsScope<String>

Parameters:

name - Metrics data name.

value - Value of the metrics.

unit - Unit of the metrics.

level - Metrics level for the data.

addDimension

public void addDimension(String name,
                         String value)

Adds given dimension with value if allowed dimensions list contains this dimension's name.

Specified by:

addDimension in interface IMetricsScope

Overrides:

addDimension in class EndingMetricsScope

Parameters:

name - Name of the dimension.

value - Value for the dimension.