org.rhq.enterprise.server.remote
Interface RemoteSafeInvocationHandlerMetricsMBean

All Known Implementing Classes:

RemoteSafeInvocationHandlerMetrics

public interface RemoteSafeInvocationHandlerMetricsMBean

Field Summary

static ObjectName

OBJECTNAME_METRICS The name of this metric collector MBean as it will be registered under by the service container

Method Summary

void	clear() Clears the metrics data, starting all values back to 0 as if starting fresh.
long	getAverageExecutionTime() Returns the average execution time (in milliseconds) it took to execute all successful invocations received.
Map<String,RemoteSafeInvocationHandlerMetrics.Calltime>	getCallTimeData() Returns a map of individual invocations and their metrics such as number of times invoked, min/max/avg execution times.
Map<String,long[]>	getCallTimeDataAsPrimitives() This obtains the same calltime data as getCallTimeData() except the map that is returned contains only primitive objects so remote clients do not have to have this MBean class definition in their classloaders.
long	getNumberFailedInvocations() Returns the total number of invocations that were received but failed to be processed succesfully.
long	getNumberSuccessfulInvocations() Returns the total number of invocations that were received and processed successfully.
long	getNumberTotalInvocations() Returns the sum of all invocations received, successful or not.

Field Detail

OBJECTNAME_METRICS

static final ObjectName OBJECTNAME_METRICS

The name of this metric collector MBean as it will be registered under by the service container

Method Detail

clear

void clear()

Clears the metrics data, starting all values back to 0 as if starting fresh.

getNumberFailedInvocations

long getNumberFailedInvocations()

Returns the total number of invocations that were received but failed to be processed succesfully.

Returns:

count of failed invocations

getNumberSuccessfulInvocations

long getNumberSuccessfulInvocations()

Returns the total number of invocations that were received and processed successfully.

Returns:

count of invocations successfully processed

getNumberTotalInvocations

long getNumberTotalInvocations()

Returns the sum of all invocations received, successful or not.

Returns:

total number of invocations received

getAverageExecutionTime

long getAverageExecutionTime()

Returns the average execution time (in milliseconds) it took to execute all successful invocations received.

Returns:

average execute time for all successful invocations.

getCallTimeData

Map<String,RemoteSafeInvocationHandlerMetrics.Calltime> getCallTimeData()

Returns a map of individual invocations and their metrics such as number of times invoked, min/max/avg execution times.

Returns:

calltime data

getCallTimeDataAsPrimitives

Map<String,long[]> getCallTimeDataAsPrimitives()

This obtains the same calltime data as getCallTimeData() except the map that is returned contains only primitive objects so remote clients do not have to have this MBean class definition in their classloaders. The order of the map values is important - each element in the array is as follows:

1. count
2. successes
3. failures
4. minimum execution time
5. maximum execution time
6. average execution time

Returns:

the calltime data stored in a map containing primitive arrays. Keyed on API name.