software.amazon.kinesis.metrics

Class CloudWatchMetricsFactory

java.lang.Object

software.amazon.kinesis.metrics.CloudWatchMetricsFactory

All Implemented Interfaces:

MetricsFactory

public class CloudWatchMetricsFactory
extends Object
implements MetricsFactory

An IMetricsFactory that creates IMetricsScopes that output themselves via CloudWatch. Batches IMetricsScopes together to reduce API calls.

Constructor Summary

Constructors

Constructor and Description
CloudWatchMetricsFactory(software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient, String namespace, long bufferTimeMillis, int maxQueueSize, MetricsLevel metricsLevel, Set<String> metricsEnabledDimensions, int flushSize) Constructor.

Method Summary

Modifier and Type	Method and Description
MetricsScope	createMetrics()
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudWatchMetricsFactory

public CloudWatchMetricsFactory(@NonNull
                                software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient,
                                @NonNull
                                String namespace,
                                long bufferTimeMillis,
                                int maxQueueSize,
                                @NonNull
                                MetricsLevel metricsLevel,
                                @NonNull
                                Set<String> metricsEnabledDimensions,
                                int flushSize)

Constructor.

Parameters:

cloudWatchClient - Client used to make CloudWatch requests

namespace - the namespace under which the metrics will appear in the CloudWatch console

bufferTimeMillis - time to buffer metrics before publishing to CloudWatch

maxQueueSize - maximum number of metrics that we can have in a queue

metricsLevel - metrics level to enable

metricsEnabledDimensions - metrics dimensions to allow

flushSize - size of batch that can be published

Method Detail

createMetrics

public MetricsScope createMetrics()

Specified by:

createMetrics in interface MetricsFactory

Returns:

a new IMetricsScope object of the type constructed by this factory.

shutdown

public void shutdown()