com.amazonaws.metrics

Interface AwsSdkMetrics.AdminMBean

Enclosing class:

AwsSdkMetrics

public static interface AwsSdkMetrics.AdminMBean

MBean interface for AwsSdkMetrics administration.

Method Summary

Methods

Modifier and Type	Method and Description
void	disableMetrics() Disables the request metric collector at the AWS SDK level.
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.
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.
Integer	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.
String	getRegion() Returns the region configured for the default AWS SDK metric collector; or null if the default is to be used.
String	getRequestMetricCollector() Returns the name of the request metric collector set at the AWS SDK level, or NONE if there is none.
String	getServiceMetricCollector() Returns the name of the service metric collector set at the AWS SDK level, or NONE if there is none.
boolean	isMachineMetricsExcluded() Returns true if machine metrics is to be excluded; false otherwise.
boolean	isMetricsEnabled() Returns true if metrics at the AWS SDK level is enabled; false if disabled.
void	setMachineMetricsExcluded(boolean excludeMachineMetrics) Used to set whether the JVM metrics is to be excluded.
void	setMetricQueueSize(Integer metricQueueSize) Sets the metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
void	setQueuePollTimeoutMilli(Integer 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.
void	setRegion(String region) Sets the region to be used for the default AWS SDK metric collector; or null if the default is to be used.

Method Detail

isMetricsEnabled

boolean isMetricsEnabled()

Returns true if metrics at the AWS SDK level is enabled; false if disabled.

getRequestMetricCollector

String getRequestMetricCollector()

Returns the name of the request metric collector set at the AWS SDK level, or NONE if there is none.

getServiceMetricCollector

String getServiceMetricCollector()

Returns the name of the service metric collector set at the AWS SDK level, or NONE if there is none.

enableDefaultMetrics

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

void disableMetrics()

Disables the request metric collector at the AWS SDK level.

isMachineMetricsExcluded

boolean isMachineMetricsExcluded()

Returns true if machine metrics is to be excluded; false otherwise.

setMachineMetricsExcluded

void setMachineMetricsExcluded(boolean excludeMachineMetrics)

Used to set whether the JVM metrics is to be excluded.

Parameters:

excludeMachineMetrics - true if JVM metrics is to be excluded; false otherwise.

getRegion

String getRegion()

Returns the region configured for the default AWS SDK metric collector; or null if the default is to be used.

setRegion

void setRegion(String region)

Sets the region to be used for the default AWS SDK metric collector; or null if the default is to be used.

getMetricQueueSize

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

void setMetricQueueSize(Integer metricQueueSize)

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

Integer 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. Use Integer instead of Long as it seems jconsole does not handle Long properly.

setQueuePollTimeoutMilli

void setQueuePollTimeoutMilli(Integer 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. Use Integer instead of Long as it seems jconsole does not handle Long properly.