com.sun.sgs.management
Interface TaskAggregateMXBean

All Known Implementing Classes:

TaskAggregateStats

public interface TaskAggregateMXBean

The management interface for tasks that have run.

An instance implementing this MBean can be obtained from the from the getPlatformMBeanServer method.

The ObjectName for uniquely identifying this MBean is "com.sun.sgs:type=TaskAggregate".

Field Summary

static String

MXBEAN_NAME The name for uniquely identifying this MBean.

Method Summary

void	clear() Clears all data values.
long	getLastClearTime() Returns the time of the last call to clear(), or the time this MBean was created if clear has never been called.
double	getReadyCountAvg() Returns the average number of tasks which are ready to run in the system.
double	getSmoothingFactor() Returns the smoothing factor used for averages in this MBean.
double	getSuccessfulLagTimeAvg() Returns the average lag time for successful tasks, in milliseconds.
double	getSuccessfulLatencyAvg() Returns the average latency for successful tasks, in milliseconds.
double	getSuccessfulRuntimeAvg() Returns the average runtime for successful tasks, in milliseconds.
long	getSuccessfulRuntimeMax() Returns the maximum runtime for successful tasks, in milliseconds.
long	getTaskCount() Returns the total number of tasks run.
long	getTaskFailureCount() Returns the total number of tasks which failed.
double	getTaskFailurePercentage() Returns the percentage of failed tasks to total tasks.
long	getTransactionalTaskCount() Returns the total number of transactional tasks run.
void	setSmoothingFactor(double newFactor) Set the smoothing factor for all averages in this MBean, between 0.0 and 1.0, inclusive.

Field Detail

MXBEAN_NAME

static final String MXBEAN_NAME

The name for uniquely identifying this MBean.

See Also:

Constant Field Values

Method Detail

getTaskCount

long getTaskCount()

Returns the total number of tasks run.

Returns:

the total number of tasks run

getTransactionalTaskCount

long getTransactionalTaskCount()

Returns the total number of transactional tasks run.

Returns:

the total number of transactional tasks run

getTaskFailureCount

long getTaskFailureCount()

Returns the total number of tasks which failed.

Returns:

the total number of tasks which failed

getTaskFailurePercentage

double getTaskFailurePercentage()

Returns the percentage of failed tasks to total tasks.

Returns:

the percentage of failed tasks to total tasks

getReadyCountAvg

double getReadyCountAvg()

Returns the average number of tasks which are ready to run in the system. A large average indicates the task queue is falling behind.

Returns:

the average number of tasks which are ready to run

getSuccessfulRuntimeMax

long getSuccessfulRuntimeMax()

Returns the maximum runtime for successful tasks, in milliseconds.

Returns:

the maximum runtime for successful tasks

getSuccessfulRuntimeAvg

double getSuccessfulRuntimeAvg()

Returns the average runtime for successful tasks, in milliseconds.

Returns:

the average runtime for successful tasks

getSuccessfulLagTimeAvg

double getSuccessfulLagTimeAvg()

Returns the average lag time for successful tasks, in milliseconds. Lag time is the amount of time spent on the ready queue before the task starts.

Returns:

the average lag time for successful tasks

getSuccessfulLatencyAvg

double getSuccessfulLatencyAvg()

Returns the average latency for successful tasks, in milliseconds. Latency is total amount of time it takes a successful task to run, and is the sum of lagtime and runtime.

Returns:

the average latency for successful tasks.

getSmoothingFactor

double getSmoothingFactor()

Returns the smoothing factor used for averages in this MBean.

Returns:

the smoothing factory used for averages

setSmoothingFactor

void setSmoothingFactor(double newFactor)

Set the smoothing factor for all averages in this MBean, between 0.0 and 1.0, inclusive. A value closer to 1.0 provides less smoothing of the data, and more weight to recent data; a value closer to 0.0 provides more smoothing but is less responsive to recent changes.

Parameters:

newFactor - the new smoothing factor

Throws:

IllegalArgumentException - if the value is not between 0.0 and 1.0, inclusive

clear

void clear()

Clears all data values.

getLastClearTime

long getLastClearTime()

Returns the time of the last call to clear(), or the time this MBean was created if clear has never been called. The time is the difference, measured in milliseconds, between the time at which this was last cleared and midnight, January 1, 1970 UTC.

Returns:

the time of the last call to clear