AwsSdkMetrics (AWS SDK for Java

java.lang.Object
- java.lang.Enum<AwsSdkMetrics>
- - com.amazonaws.metrics.AwsSdkMetrics

All Implemented Interfaces:

Serializable, Comparable<AwsSdkMetrics>
```
public enum AwsSdkMetrics
extends Enum<AwsSdkMetrics>
```
Used to control the default AWS SDK metric collection system.
The default request metric collection of the Java AWS SDK is disabled by default. To enable it, simply specify the system property "com.amazonaws.sdk.enableDefaultMetrics" when starting up the JVM. When the system property is specified, a default metric collector will be started at the AWS SDK level. The default implementation uploads the request/response metrics captured to Amazon CloudWatch using AWS credentials obtained via the DefaultAWSCredentialsProviderChain.
Instead of via system properties, the default AWS SDK metric collection can also be enabled programmatically via enableDefaultMetrics(). Similarly, metric collection at the AWS SDK level can be disabled via disableMetrics().
Clients who needs to fully customize the metric collection can implement the SPI MetricCollector, and then replace the default AWS SDK implementation of the collector via setMetricCollector(MetricCollector).
Alternatively, for limited customization of the internal collector implementation provided by the AWS SDK, one can extend the internal Amazon CloudWatch request metric collector. See the javadoc at com.amazonaws.metrics.internal.cloudwatch.CloudWatchMetricConfig for more details.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsSdkMetrics.AdminMBean
MBean interface for AwsSdkMetrics administration.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AwsSdkMetrics.AdminMBean` MBean interface for AwsSdkMetrics administration.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AWS_CREDENTAIL_PROPERTIES_FILE`
`static String`	`CLOUDWATCH_REGION`
`static String`	`EXCLUDE_MACHINE_METRICS` Used to exclude the generation of JVM metrics when the AWS SDK default metrics is enabled when starting up the JVM.
`static String`	`METRIC_QUEUE_SIZE`
`static String`	`METRICS_NAMESPACE`
`static String`	`QUEUE_POLL_TIMEOUT_MILLI`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`add(MetricType type)` Adds the given metric type to the registry of predefined metrics to be captured at the AWS SDK level.
`static <T extends MetricType> boolean`	`addAll(Collection<T> types)` Adds the given metric types to the registry of predefined metrics to be captured at the AWS SDK level.
`static void`	`disableMetrics()` Convenient method to disable the request metric collector at the AWS SDK level.
`static boolean`	`enableDefaultMetrics()` Starts the default AWS SDK request metric collector, but only if no request metric collector is currently in use at the AWS SDK level.
`static AWSCredentialsProvider`	`getCredentialProvider()` Returns the credential provider for the default AWS SDK metric implementation.
`static <T extends MetricCollector> T`	`getMetricCollector()`
`static Integer`	`getMetricQueueSize()` Returns the internal metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
`static Set<MetricType>`	`getPredefinedMetrics()` Returns an unmodifiable set of the current predefined metrics.
`static Long`	`getQueuePollTimeoutMilli()` Returns the internal metric queue timeout in millisecond to be used for the default AWS SDK metric collector; or null if the default is to be used.
`static Regions`	`getRegion()` Returns the region configured for the default AWS SDK metric collector; or null if the default is to be used.
`static <T extends RequestMetricCollector> T`	`getRequestMetricCollector()` Returns a non-null request metric collector for the SDK.
`static <T extends ServiceMetricCollector> T`	`getServiceMetricCollector()`
`static boolean`	`isDefaultMetricsEnabled()` Returns true if the system property `SDKGlobalConfiguration.DEFAULT_METRICS_SYSTEM_PROPERTY` has been set; false otherwise.
`static boolean`	`isMachineMetricExcluded()` Returns true if machine metrics is to be excluded.
`static boolean`	`isMetricsEnabled()` Returns true if metrics at the AWS SDK level is enabled; false if disabled.
`static boolean`	`remove(MetricType type)` Removes the given metric type from the registry of predefined metrics to be captured at the AWS SDK level.
`static <T extends MetricType> void`	`set(Collection<T> types)` Sets the given metric types to replace the registry of predefined metrics to be captured at the AWS SDK level.
`static void`	`setCredentialProvider(AWSCredentialsProvider provider)` Sets the credential provider for the default AWS SDK metric implementation; or null if the default is to be used.
`static void`	`setMachineMetricsExcluded(boolean excludeMachineMetrics)` Used to set whether the machine metrics is to be excluded.
`static void`	`setMetricCollector(MetricCollector mc)` Sets the request metric collector to be used by the AWS SDK, and stop the previously running collector used by the AWS SDK, if any.
`static void`	`setMetricQueueSize(Integer size)` Sets the metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
`static void`	`setQueuePollTimeoutMilli(Long timeoutMilli)` Sets the queue poll time in millisecond to be used for the default AWS SDK metric collector; or null if the default is to be used.
`static void`	`setRegion(Regions region)` Sets the region to be used for the default AWS SDK metric collector; or null if the default is to be used.
`static AwsSdkMetrics`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AwsSdkMetrics[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - METRICS_NAMESPACE
```
public static final String METRICS_NAMESPACE
```
    See Also:
    Constant Field Values
  - EXCLUDE_MACHINE_METRICS
```
public static final String EXCLUDE_MACHINE_METRICS
```
    Used to exclude the generation of JVM metrics when the AWS SDK default metrics is enabled when starting up the JVM.
```
 Example:
  -Dcom.amazonaws.sdk.enableDefaultMetrics=excludeJvmMetrics
 
```
    See Also:
    Constant Field Values
  - AWS_CREDENTAIL_PROPERTIES_FILE
```
public static final String AWS_CREDENTAIL_PROPERTIES_FILE
```
    See Also:
    Constant Field Values
  - CLOUDWATCH_REGION
```
public static final String CLOUDWATCH_REGION
```
    See Also:
    Constant Field Values
  - METRIC_QUEUE_SIZE
```
public static final String METRIC_QUEUE_SIZE
```
    See Also:
    Constant Field Values
  - QUEUE_POLL_TIMEOUT_MILLI
```
public static final String QUEUE_POLL_TIMEOUT_MILLI
```
    See Also:
    Constant Field Values
- Method Detail
  - values
```
public static AwsSdkMetrics[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AwsSdkMetrics c : AwsSdkMetrics.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AwsSdkMetrics valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getRequestMetricCollector
```
public static <T extends RequestMetricCollector> T getRequestMetricCollector()
```
    Returns a non-null request metric collector for the SDK. If no custom request metric collector has previously been specified via setMetricCollector(MetricCollector) and the SDKGlobalConfiguration.DEFAULT_METRICS_SYSTEM_PROPERTY has been set, then this method will initialize and return the default metric collector provided by the AWS SDK on a best-attempt basis.
  - getServiceMetricCollector
```
public static <T extends ServiceMetricCollector> T getServiceMetricCollector()
```
  - getMetricCollector
```
public static <T extends MetricCollector> T getMetricCollector()
```
  - setMetricCollector
```
public static void setMetricCollector(MetricCollector mc)
```
    Sets the request metric collector to be used by the AWS SDK, and stop the previously running collector used by the AWS SDK, if any. Note, however, a request metric collector specified at the web service client level or request level, if any, always takes precedence over the one specified at the AWS SDK level.
    Caller of this method is responsible for starting the new request metric collector specified as the input parameter.
    
    Parameters:
    mc - the request metric collector to be used by the AWS SDK; or null if no request metric collection is to be performed at the AWS SDK level.
    See Also:
    RequestMetricCollector, RequestMetricCollector.NONE
  - setMachineMetricsExcluded
```
public static void setMachineMetricsExcluded(boolean excludeMachineMetrics)
```
    Used to set whether the machine metrics is to be excluded.
    
    Parameters:
    excludeMachineMetrics - true if machine metrics is to be excluded; false otherwise.
  - isDefaultMetricsEnabled
```
public static boolean isDefaultMetricsEnabled()
```
    Returns true if the system property SDKGlobalConfiguration.DEFAULT_METRICS_SYSTEM_PROPERTY has been set; false otherwise.
  - isMetricsEnabled
```
public static boolean isMetricsEnabled()
```
    Returns true if metrics at the AWS SDK level is enabled; false if disabled.
  - isMachineMetricExcluded
```
public static boolean isMachineMetricExcluded()
```
    Returns true if machine metrics is to be excluded.
  - enableDefaultMetrics
```
public static boolean enableDefaultMetrics()
```
    Starts the default AWS SDK request metric collector, but only if no request metric collector is currently in use at the AWS SDK level.
    
    Returns:
    true if the default AWS SDK request metric collector has been successfully started by this call; false otherwise.
  - disableMetrics
```
public static void disableMetrics()
```
    Convenient method to disable the request metric collector at the AWS SDK level.
  - add
```
public static boolean add(MetricType type)
```
    Adds the given metric type to the registry of predefined metrics to be captured at the AWS SDK level.
    
    Returns:
    true if the set of predefined metric types gets changed as a result of the call
  - addAll
```
public static <T extends MetricType> boolean addAll(Collection<T> types)
```
    Adds the given metric types to the registry of predefined metrics to be captured at the AWS SDK level.
    
    Returns:
    true if the set of predefined metric types gets changed as a result of the call
  - set
```
public static <T extends MetricType> void set(Collection<T> types)
```
    Sets the given metric types to replace the registry of predefined metrics to be captured at the AWS SDK level.
  - remove
```
public static boolean remove(MetricType type)
```
    Removes the given metric type from the registry of predefined metrics to be captured at the AWS SDK level.
    
    Returns:
    true if the set of predefined metric types gets changed as a result of the call
  - getPredefinedMetrics
```
public static Set<MetricType> getPredefinedMetrics()
```
    Returns an unmodifiable set of the current predefined metrics.
  - getCredentialProvider
```
public static AWSCredentialsProvider getCredentialProvider()
```
    Returns the credential provider for the default AWS SDK metric implementation. This method is restricted to calls from the default AWS SDK metric implementation.
    
    Throws:
    
    SecurityException - if called outside the default AWS SDK metric implementation.
  - setCredentialProvider
```
public static void setCredentialProvider(AWSCredentialsProvider provider)
```
    Sets the credential provider for the default AWS SDK metric implementation; or null if the default is to be used.
  - getRegion
```
public static Regions getRegion()
```
    Returns the region configured for the default AWS SDK metric collector; or null if the default is to be used.
  - setRegion
```
public static void setRegion(Regions region)
```
    Sets the region to be used for the default AWS SDK metric collector; or null if the default is to be used.
  - getMetricQueueSize
```
public static Integer getMetricQueueSize()
```
    Returns the internal metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
  - setMetricQueueSize
```
public static void setMetricQueueSize(Integer size)
```
    Sets the metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
  - getQueuePollTimeoutMilli
```
public static Long getQueuePollTimeoutMilli()
```
    Returns the internal metric queue timeout in millisecond to be used for the default AWS SDK metric collector; or null if the default is to be used.
  - setQueuePollTimeoutMilli
```
public static void setQueuePollTimeoutMilli(Long timeoutMilli)
```
    Sets the queue poll time in millisecond to be used for the default AWS SDK metric collector; or null if the default is to be used.

Did this page help you?

Enum AwsSdkMetrics

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

METRICS_NAMESPACE

EXCLUDE_MACHINE_METRICS

AWS_CREDENTAIL_PROPERTIES_FILE

CLOUDWATCH_REGION

METRIC_QUEUE_SIZE

QUEUE_POLL_TIMEOUT_MILLI

Method Detail

values

valueOf

getRequestMetricCollector

getServiceMetricCollector

getMetricCollector

setMetricCollector

setMachineMetricsExcluded

isDefaultMetricsEnabled

isMetricsEnabled

isMachineMetricExcluded

enableDefaultMetrics

disableMetrics

add

addAll

set

remove

getPredefinedMetrics

getCredentialProvider

setCredentialProvider

getRegion

setRegion

getMetricQueueSize

setMetricQueueSize

getQueuePollTimeoutMilli

setQueuePollTimeoutMilli