software.amazon.kinesis.metrics

Class MetricsUtil

java.lang.Object

software.amazon.kinesis.metrics.MetricsUtil

public class MetricsUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_DIMENSION_NAME
static String	SHARD_ID_DIMENSION_NAME
static String	STREAM_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
MetricsUtil()

Method Summary

Modifier and Type	Method and Description
static void	addCount(@NonNull MetricsScope metricsScope, String dimension, long count, @NonNull MetricsLevel metricsLevel)
static void	addLatency(@NonNull MetricsScope metricsScope, String dimension, long startTime, @NonNull MetricsLevel metricsLevel)
static void	addOperation(@NonNull MetricsScope metricsScope, @NonNull String dimension, @NonNull String value)
static void	addShardId(@NonNull MetricsScope metricsScope, @NonNull String shardId)
static void	addStreamId(@NonNull MetricsScope metricsScope, @NonNull StreamIdentifier streamId)
static void	addSuccess(@NonNull MetricsScope metricsScope, String dimension, boolean success, @NonNull MetricsLevel metricsLevel)
static void	addSuccessAndLatency(@NonNull MetricsScope metricsScope, boolean success, long startTime, @NonNull MetricsLevel metricsLevel)
static void	addSuccessAndLatency(@NonNull MetricsScope metricsScope, String dimension, boolean success, long startTime, @NonNull MetricsLevel metricsLevel)
static void	addWorkerIdentifier(@NonNull MetricsScope metricsScope, @NonNull String workerIdentifier)
static MetricsScope	createMetrics(@NonNull MetricsFactory metricsFactory)
static MetricsScope	createMetricsWithOperation(@NonNull MetricsFactory metricsFactory, @NonNull String operation)
static void	endScope(@NonNull MetricsScope metricsScope)

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

STREAM_IDENTIFIER

public static final String STREAM_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

MetricsUtil

public MetricsUtil()

Method Detail

createMetrics

public static MetricsScope createMetrics(@NonNull
                                         @NonNull MetricsFactory metricsFactory)

createMetricsWithOperation

public static MetricsScope createMetricsWithOperation(@NonNull
                                                      @NonNull MetricsFactory metricsFactory,
                                                      @NonNull
                                                      @NonNull String operation)

addShardId

public static void addShardId(@NonNull
                              @NonNull MetricsScope metricsScope,
                              @NonNull
                              @NonNull String shardId)

addStreamId

public static void addStreamId(@NonNull
                               @NonNull MetricsScope metricsScope,
                               @NonNull
                               @NonNull StreamIdentifier streamId)

addWorkerIdentifier

public static void addWorkerIdentifier(@NonNull
                                       @NonNull MetricsScope metricsScope,
                                       @NonNull
                                       @NonNull String workerIdentifier)

addOperation

public static void addOperation(@NonNull
                                @NonNull MetricsScope metricsScope,
                                @NonNull
                                @NonNull String dimension,
                                @NonNull
                                @NonNull String value)

addSuccessAndLatency

public static void addSuccessAndLatency(@NonNull
                                        @NonNull MetricsScope metricsScope,
                                        boolean success,
                                        long startTime,
                                        @NonNull
                                        @NonNull MetricsLevel metricsLevel)

addSuccessAndLatency

public static void addSuccessAndLatency(@NonNull
                                        @NonNull MetricsScope metricsScope,
                                        String dimension,
                                        boolean success,
                                        long startTime,
                                        @NonNull
                                        @NonNull MetricsLevel metricsLevel)

addLatency

public static void addLatency(@NonNull
                              @NonNull MetricsScope metricsScope,
                              String dimension,
                              long startTime,
                              @NonNull
                              @NonNull MetricsLevel metricsLevel)

addSuccess

public static void addSuccess(@NonNull
                              @NonNull MetricsScope metricsScope,
                              String dimension,
                              boolean success,
                              @NonNull
                              @NonNull MetricsLevel metricsLevel)

addCount

public static void addCount(@NonNull
                            @NonNull MetricsScope metricsScope,
                            String dimension,
                            long count,
                            @NonNull
                            @NonNull MetricsLevel metricsLevel)

endScope

public static void endScope(@NonNull
                            @NonNull MetricsScope metricsScope)