com.amazonaws.services.kinesis.metrics.impl

Class MetricsHelper

java.lang.Object

com.amazonaws.services.kinesis.metrics.impl.MetricsHelper

public class MetricsHelper
extends Object

MetricsHelper assists with common metrics operations, most notably the storage of IMetricsScopes objects in a ThreadLocal so we don't have to pass one throughout the whole call stack.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_DIMENSION_NAME
static String	SHARD_ID_DIMENSION_NAME
static String	SUCCESS
static String	TIME

Constructor Summary

Constructors

Constructor and Description
MetricsHelper()

Method Summary

Modifier and Type	Method and Description
static void	addLatency(long startTimeMillis, MetricsLevel level)
static void	addLatency(String prefix, long startTimeMillis, MetricsLevel level)
static void	addLatencyPerShard(String shardId, String prefix, long startTimeMillis, MetricsLevel level)
static void	addSuccessAndLatency(long startTimeMillis, boolean success, MetricsLevel level)
static void	addSuccessAndLatency(String prefix, long startTimeMillis, boolean success, MetricsLevel level)
static void	addSuccessAndLatencyPerShard(String shardId, String prefix, long startTimeMillis, boolean success, MetricsLevel level)
static void	endScope()
static IMetricsScope	getMetricsScope()
static void	setMetricsScope(IMetricsScope scope) Sets given metrics scope for the current thread.
static IMetricsScope	startScope(IMetricsFactory factory)
static IMetricsScope	startScope(IMetricsFactory factory, String operation)
static void	unsetMetricsScope() Unsets the metrics scope for the current thread.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_DIMENSION_NAME

public static final String OPERATION_DIMENSION_NAME

See Also:

Constant Field Values

SHARD_ID_DIMENSION_NAME

public static final String SHARD_ID_DIMENSION_NAME

See Also:

Constant Field Values

TIME

public static final String TIME

See Also:

Constant Field Values

SUCCESS

public static final String SUCCESS

See Also:

Constant Field Values

Constructor Detail

MetricsHelper

public MetricsHelper()

Method Detail

startScope

public static IMetricsScope startScope(IMetricsFactory factory)

startScope

public static IMetricsScope startScope(IMetricsFactory factory,
                                       String operation)

setMetricsScope

public static void setMetricsScope(IMetricsScope scope)

Sets given metrics scope for the current thread. Method must be used with care. Metrics helper is designed such that separate metrics scopes are associated with each thread. However, when sharing metrics scope and setting it explicitly on a thread, thread safety must also be taken into account.

Parameters:

scope -

unsetMetricsScope

public static void unsetMetricsScope()

Unsets the metrics scope for the current thread.

getMetricsScope

public static IMetricsScope getMetricsScope()

addSuccessAndLatency

public static void addSuccessAndLatency(long startTimeMillis,
                                        boolean success,
                                        MetricsLevel level)

addSuccessAndLatency

public static void addSuccessAndLatency(String prefix,
                                        long startTimeMillis,
                                        boolean success,
                                        MetricsLevel level)

addSuccessAndLatencyPerShard

public static void addSuccessAndLatencyPerShard(String shardId,
                                                String prefix,
                                                long startTimeMillis,
                                                boolean success,
                                                MetricsLevel level)

addLatency

public static void addLatency(long startTimeMillis,
                              MetricsLevel level)

addLatency

public static void addLatency(String prefix,
                              long startTimeMillis,
                              MetricsLevel level)

addLatencyPerShard

public static void addLatencyPerShard(String shardId,
                                      String prefix,
                                      long startTimeMillis,
                                      MetricsLevel level)

endScope

public static void endScope()