com.amazonaws.services.kinesis.metrics.interfaces

Interface IMetricsScope

All Known Implementing Classes:

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

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

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.

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

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.