@NotThreadSafe
public class CloudWatchMetricConfig
extends Object 

 /**
 * 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())
 .withEndpointConfiguration(new EndpointConfiguration("https://monitoring.us-west-2.amazonaws.com", "us-west-2"))
 .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 and 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 and Description
  CloudWatchMetricConfig ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  ClientConfiguration	getClientConfiguration () Returns the Client Configuration used to connect to Amazon CloudWatch.
  String	getCloudWatchEndPoint () Returns the end point of AmazonCloudWatch to upload the metrics.
  AWSCredentialsProvider	getCredentialsProvider () Returns the credential provider that holds the credentials to connect to Amazon CloudWatch.
  AwsClientBuilder.EndpointConfiguration	getEndpointConfiguration ()
  int	getMetricQueueSize ()
  long	getQueuePollTimeoutMilli () Returns the metrics queue polling timeout in millisecond.
  void	setClientConfiguration (ClientConfiguration clientConfiguration) Sets the Client Configuration.
  void	setCloudWatchEndPoint (String cloudWatchEndPoint) Deprecated. Use #setEndpointConfiguration(EndpointConfiguration) instead
  void	setCredentialsProvider (AWSCredentialsProvider credentialsProvider) Sets the credential provider to the given provider.
  void	setEndpointConfiguration (AwsClientBuilder.EndpointConfiguration endpointConfiguration) Configure the endpoint to be used
  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	withClientConfiguration (ClientConfiguration clientConfiguration)
  CloudWatchMetricConfig	withCloudWatchEndPoint (String cloudWatchEndPoint) Deprecated. Use #withEndpointConfiguration(EndpointConfiguration) instead
  CloudWatchMetricConfig	withCredentialsProvider (AWSCredentialsProvider credentialsProvider)
  CloudWatchMetricConfig	withEndpointConfiguration (AwsClientBuilder.EndpointConfiguration endpointConfiguration) Configure the endpoint to be used
  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

  • getCredentialsProvider

    public AWSCredentialsProvider getCredentialsProvider()

    Returns the credential provider that holds the credentials to connect to Amazon CloudWatch.

  • setCredentialsProvider

    public void setCredentialsProvider(AWSCredentialsProvider credentialsProvider)

    Sets the credential provider to the given provider. This credential provider is used by the uploader thread to connect to Amazon CloudWatch.

  • withCredentialsProvider

    public CloudWatchMetricConfig withCredentialsProvider(AWSCredentialsProvider credentialsProvider)

  • getClientConfiguration

    public ClientConfiguration getClientConfiguration()

    Returns the Client Configuration used to connect to Amazon CloudWatch.

  • setClientConfiguration

    public void setClientConfiguration(ClientConfiguration clientConfiguration)

    Sets the Client Configuration. This client configuration is used by the uploader thread to connect to Amazon CloudWatch.

  • withClientConfiguration

    public CloudWatchMetricConfig withClientConfiguration(ClientConfiguration clientConfiguration)

  • 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)

  • getCloudWatchEndPoint

    public String getCloudWatchEndPoint()

    Returns the end point of AmazonCloudWatch to upload the metrics.

  • setCloudWatchEndPoint

    @Deprecated
    public void setCloudWatchEndPoint(String cloudWatchEndPoint)

    Deprecated. Use #setEndpointConfiguration(EndpointConfiguration) instead
    Sets the end point of AmazonCloudWatch to upload the metrics.

  • withCloudWatchEndPoint

    @Deprecated
    public CloudWatchMetricConfig withCloudWatchEndPoint(String cloudWatchEndPoint)

    Deprecated. Use #withEndpointConfiguration(EndpointConfiguration) instead
    Sets the end point of AmazonCloudWatch to upload the metrics.

  • getEndpointConfiguration

    public AwsClientBuilder.EndpointConfiguration getEndpointConfiguration()

  • setEndpointConfiguration

    public void setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)

    Configure the endpoint to be used

    Parameters:

    endpointConfiguration - the endpoint configuration

  • withEndpointConfiguration

    public CloudWatchMetricConfig withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)

    Configure the endpoint to be used

    Parameters:

    endpointConfiguration - the endpoint configuration

    Returns:

    the builder

  • 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)