software.amazon.kinesis.metrics

Class ThreadSafeMetricsDelegatingScope

java.lang.Object

software.amazon.kinesis.metrics.ThreadSafeMetricsDelegatingScope

All Implemented Interfaces:

MetricsScope

public class ThreadSafeMetricsDelegatingScope
extends Object
implements MetricsScope

Metrics scope that delegates to another metrics scope and is thread safe to be shared across different threads.

Field Summary

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

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
ThreadSafeMetricsDelegatingScope(MetricsScope delegate) Creates an instance of the metrics scope.

Method Summary

Modifier and Type	Method and Description
void	addData(String name, double value, software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit) Adds a data point to this IMetricsScope.
void	addData(String name, double value, software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit, MetricsLevel level) Adds a data point to this IMetricsScope if given metrics level is enabled.
void	addDimension(String name, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadSafeMetricsDelegatingScope

public ThreadSafeMetricsDelegatingScope(MetricsScope delegate)

Creates an instance of the metrics scope.

Parameters:

delegate - metrics scope to delegate to

Method Detail

addData

public void addData(String name,
                    double value,
                    software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit)

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

Specified by:

addData in interface MetricsScope

Parameters:

name - data point name

value - data point value

unit - unit of data point

addData

public void addData(String name,
                    double value,
                    software.amazon.awssdk.services.cloudwatch.model.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.

Specified by:

addData in interface MetricsScope

Parameters:

name - data point name

value - data point value

unit - unit of data point

level - metrics level of this data point

addDimension

public void addDimension(String name,
                         String value)

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

Specified by:

addDimension in interface MetricsScope

Parameters:

name - dimension name

value - dimension value

end

public void end()

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

Specified by:

end in interface MetricsScope