com.amazonaws.services.kinesis.metrics.impl

Class CWMetricsFactory

java.lang.Object

com.amazonaws.services.kinesis.metrics.impl.CWMetricsFactory

All Implemented Interfaces:

IMetricsFactory

public class CWMetricsFactory
extends Object
implements IMetricsFactory

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

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	DEFAULT_METRICS_ENABLED_DIMENSIONS Default metrics dimensions.
static MetricsLevel	DEFAULT_METRICS_LEVEL Default metrics level to enable.

Constructor Summary

Constructors

Constructor and Description
CWMetricsFactory(com.amazonaws.services.cloudwatch.AmazonCloudWatch cloudWatchClient, String namespace, long bufferTimeMillis, int maxQueueSize) Constructor.
CWMetricsFactory(com.amazonaws.services.cloudwatch.AmazonCloudWatch cloudWatchClient, String namespace, long bufferTimeMillis, int maxQueueSize, MetricsLevel metricsLevel, Set<String> metricsEnabledDimensions) Constructor.
CWMetricsFactory(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.ClientConfiguration clientConfig, String namespace, long bufferTimeMillis, int maxQueueSize) Constructor.
CWMetricsFactory(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, String namespace, long bufferTimeMillis, int maxQueueSize) Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METRICS_LEVEL

public static final MetricsLevel DEFAULT_METRICS_LEVEL

Default metrics level to enable. By default, all metrics levels are emitted.

DEFAULT_METRICS_ENABLED_DIMENSIONS

public static final Set<String> DEFAULT_METRICS_ENABLED_DIMENSIONS

Default metrics dimensions. By default, all dimensions are enabled.

Constructor Detail

CWMetricsFactory

public CWMetricsFactory(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                        String namespace,
                        long bufferTimeMillis,
                        int maxQueueSize)

Constructor.

Parameters:

credentialsProvider - client credentials for CloudWatch

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

CWMetricsFactory

public CWMetricsFactory(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                        com.amazonaws.ClientConfiguration clientConfig,
                        String namespace,
                        long bufferTimeMillis,
                        int maxQueueSize)

Constructor.

Parameters:

credentialsProvider - client credentials for CloudWatch

clientConfig - Configuration to use with the AmazonCloudWatchClient

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

CWMetricsFactory

public CWMetricsFactory(com.amazonaws.services.cloudwatch.AmazonCloudWatch cloudWatchClient,
                        String namespace,
                        long bufferTimeMillis,
                        int maxQueueSize)

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

CWMetricsFactory

public CWMetricsFactory(com.amazonaws.services.cloudwatch.AmazonCloudWatch cloudWatchClient,
                        String namespace,
                        long bufferTimeMillis,
                        int maxQueueSize,
                        MetricsLevel metricsLevel,
                        Set<String> metricsEnabledDimensions)

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

Method Detail

createMetrics

public IMetricsScope createMetrics()

Specified by:

createMetrics in interface IMetricsFactory

Returns:

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

shutdown

public void shutdown()