Package software.amazon.awssdk.metrics.internal.cloudwatch

Class CloudWatchMetricConfig

java.lang.Object

software.amazon.awssdk.metrics.internal.cloudwatch.CloudWatchMetricConfig

@NotThreadSafe
public class CloudWatchMetricConfig
extends Object

Configuration for the default AWS SDK collection implementation. This class is not intended to be used directly by client code except for cases where the default behavior of the internal Amazon CloudWatch collector implementation needs to be customized.

Example:

 /**
  * My custom Request Metric Collector by extending from the internal Amazon CloudWatch
  * implementation.
  */
 static class MyCloudWatchMetricCollector extends
         CloudWatchRequestMetricCollector {
     MyCloudWatchMetricCollector(CloudWatchMetricConfig config) {
         super(config);
     }
 }
 MyCloudWatchMetricCollector myCollector = new MyCloudWatchMetricCollector(
         new CloudWatchMetricConfig()
                 .withQueuePollTimeoutMilli(60000)
                 .withMetricQueueSize(1000)
                 .withCredentialsProvider(
                         new DefaultAWSCredentialsProviderChain())
                 .withCloudWatchEndPoint("monitoring.us-west-2.amazonaws.com")
                 .withPredefinedMetrics(
                         new HashSet<Field>(Arrays.asList(Field.HttpRequestTime,
                                 Field.ResponseProcessingTime))));
 myCollector.start();
 // Enable the AWS SDK level request metric collection with a custom collector
 AwsSdkMetrics.setRequestMetricCollector(myCollector);
 

See Also:

AwsSdkMetrics

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_METRICS_QSIZE	Default metrics queue size.
static int	DEFAULT_QUEUE_POLL_TIMEOUT_MILLI	Default timeout in millisecond for queue polling.

Constructor Summary

Constructors

Constructor	Description
CloudWatchMetricConfig()

Method Summary

Modifier and Type	Method	Description
CloudWatchClient	getCloudWatchClient()
int	getMetricQueueSize()
long	getQueuePollTimeoutMilli()	Returns the metrics queue polling timeout in millisecond.
void	setCloudWatchClient(CloudWatchClient cloudWatchClient)
void	setMetricQueueSize(int metricQueueSize)	Configure the metric queue size, overriding the default.
void	setQueuePollTimeoutMilli(long queuePollTimeoutMilli)	Sets the metric queue polling timeout in millisecond.
CloudWatchMetricConfig	withCloudWatchClient(CloudWatchClient cloudWatchClient)
CloudWatchMetricConfig	withMetricQueueSize(int metricQueueSize)
CloudWatchMetricConfig	withQueuePollTimeoutMilli(long queuePollTimeoutMilli)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METRICS_QSIZE

public static final int DEFAULT_METRICS_QSIZE

Default metrics queue size. If the queue size exceeds this value, then excessive metrics will be dropped to prevent resource exhaustion.

See Also:

Constant Field Values

DEFAULT_QUEUE_POLL_TIMEOUT_MILLI

public static final int DEFAULT_QUEUE_POLL_TIMEOUT_MILLI

Default timeout in millisecond for queue polling. Set to one-minute which is the finest granularity of Amazon CloudWatch.

Constructor Detail

CloudWatchMetricConfig

public CloudWatchMetricConfig()

Method Detail

getQueuePollTimeoutMilli

public long getQueuePollTimeoutMilli()

Returns the metrics queue polling timeout in millisecond.

setQueuePollTimeoutMilli

public void setQueuePollTimeoutMilli(long queuePollTimeoutMilli)

Sets the metric queue polling timeout in millisecond. The default set set to one-minute per the finest granularity of Amazon CloudWatch

withQueuePollTimeoutMilli

public CloudWatchMetricConfig withQueuePollTimeoutMilli(long queuePollTimeoutMilli)

getMetricQueueSize

public int getMetricQueueSize()

setMetricQueueSize

public void setMetricQueueSize(int metricQueueSize)

Configure the metric queue size, overriding the default. Must be at least 1.

See Also:

DEFAULT_METRICS_QSIZE

withMetricQueueSize

public CloudWatchMetricConfig withMetricQueueSize(int metricQueueSize)

getCloudWatchClient

public CloudWatchClient getCloudWatchClient()

setCloudWatchClient

public void setCloudWatchClient(CloudWatchClient cloudWatchClient)

withCloudWatchClient

public CloudWatchMetricConfig withCloudWatchClient(CloudWatchClient cloudWatchClient)