com.amazonaws.services.kinesis.metrics.interfaces

Interface IMetricsScope

All Known Implementing Classes:

AccumulateByNameMetricsScope, AccumulatingMetricsScope, CWMetricsScope, DimensionTrackingMetricsScope, EndingMetricsScope, FilteringMetricsScope, LogMetricsScope, NullMetricsScope, ThreadSafeMetricsDelegatingScope

public interface IMetricsScope

An IMetricsScope represents a set of metric data that share a set of dimensions. IMetricsScopes know how to output themselves (perhaps to disk, perhaps over service calls, etc).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METRICS_DIMENSIONS_ALL Value that signifies that all dimensions are allowed for the metrics scope.

Method Summary

Modifier and Type	Method and Description
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.
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.

Field Detail

METRICS_DIMENSIONS_ALL

static final java.lang.String METRICS_DIMENSIONS_ALL

Value that signifies that all dimensions are allowed for the metrics scope.

See Also:

Constant Field Values

Method Detail

addData

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

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

Parameters:

name - data point name

value - data point value

unit - unit of data point

addData

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. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Parameters:

name - data point name

value - data point value

unit - unit of data point

level - metrics level of this data point

addDimension

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

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

Parameters:

name - dimension name

value - dimension value

end

void end()

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