com.amazonaws.metrics
Interface MetricAdminMBean

All Known Implementing Classes:

MetricAdmin

public interface MetricAdminMBean

MBean interface for AwsSdkMetrics administration.

Method Summary

void	disableMetrics() Disables the metric collector at the AWS SDK level.
boolean	enableDefaultMetrics() Starts the default AWS SDK metric collector, but only if no metric collector is currently in use at the AWS SDK level.
String	getCredentialFile() Returns the last set AWS credential file; or null if there is none.
String	getHostMetricName() Returns the host name for metric purposes.
String	getJvmMetricName() Returns the JVM metric name.
String	getMetricNameSpace() Returns the metric name space.
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.
boolean	isPerHostMetricsIncluded() Returns true if per-host metrics is to be included; false otherwise.
boolean	isSingleMetricNamespace() Returns true if single metric name space is to be used; false otherwise.
void	setCredentialFile(String filepath) Sets the AWS credential file used by the default AWS SDK metric collector for accessing CloudWatch.
void	setHostMetricName(String hostMetricName) Sets the host name to enable per-host level metrics generation.
void	setJvmMetricName(String jvmMetricName) Sets the JVM metric name to enable per-JVM level metrics generation.
void	setMachineMetricsExcluded(boolean excludeMachineMetrics) Used to set whether the JVM metrics is to be excluded.
void	setMetricNameSpace(String metricNameSpace) Sets the metric name space.
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	setPerHostMetricsIncluded(boolean includePerHostMetrics) Used to set whether the per-host metrics is to be included.
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.
void	setSingleMetricNamespace(boolean singleMetricNamespace) Used to set whether a single metric name space 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 metric collector, but only if no metric collector is currently in use at the AWS SDK level.

Returns:

true if the default AWS SDK metric collector has been successfully started by this call; false otherwise.

disableMetrics

void disableMetrics()

Disables the 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.

isPerHostMetricsIncluded

boolean isPerHostMetricsIncluded()

Returns true if per-host metrics is to be included; false otherwise.

setPerHostMetricsIncluded

void setPerHostMetricsIncluded(boolean includePerHostMetrics)

Used to set whether the per-host metrics is to be included.

Parameters:

includePerHostMetrics - true if per-host metrics is to be included; 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.

getCredentialFile

String getCredentialFile()

Returns the last set AWS credential file; or null if there is none.

setCredentialFile

void setCredentialFile(String filepath)
                       throws FileNotFoundException,
                              IOException

Sets the AWS credential file used by the default AWS SDK metric collector for accessing CloudWatch.

Parameters:

filepath - must be a valid path to an AWS credential property file.

Throws:

FileNotFoundException

IOException

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.

getMetricNameSpace

String getMetricNameSpace()

Returns the metric name space.

setMetricNameSpace

void setMetricNameSpace(String metricNameSpace)

Sets the metric name space.

Throws:

IllegalArgumentException - if the given name space is either null or blank.

getJvmMetricName

String getJvmMetricName()

Returns the JVM metric name. If the returned value is either null or blank, no JVM level metrics will be generated.

setJvmMetricName

void setJvmMetricName(String jvmMetricName)

Sets the JVM metric name to enable per-JVM level metrics generation. If the given value is either null or blank, no JVM level metrics will be generated.

getHostMetricName

String getHostMetricName()

Returns the host name for metric purposes. If the returned value is either null or blank, the host name will be automatically detected via InetAddresss.

setHostMetricName

void setHostMetricName(String hostMetricName)

Sets the host name to enable per-host level metrics generation. If the given value is either null or blank but the per-host metric is enabled, the host name will be automatically detected via InetAddresss.

isSingleMetricNamespace

boolean isSingleMetricNamespace()

Returns true if single metric name space is to be used; false otherwise.

setSingleMetricNamespace

void setSingleMetricNamespace(boolean singleMetricNamespace)

Used to set whether a single metric name space is to be used.