org.rhq.enterprise.communications
Interface ServiceContainerMetricsMBean

All Known Implementing Classes:

ServiceContainerMetrics

public interface ServiceContainerMetricsMBean

This is the interface to the MBean that emits metric information on the server-side comm components.

Author:

John Mazzitelli

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	getAverageExecutionTimeReceived() Returns the average execution time (in milliseconds) it took to execute all successful commands received.
Map<String,CommandProcessorMetrics.Calltime>	getCallTimeDataReceived() Returns a map of individual command types/pojo invocations and their metrics such as number of times invoked, min/max/avg execution times.
long	getNumberDroppedCommandsReceived() Returns the total number of commands that were received but were dropped, usually due to a limit reached in the server that prohibits more commands to be invoked until current invocations finish.
long	getNumberFailedCommandsReceived() Returns the total number of commands that were received but failed to be processed succesfully.
long	getNumberNotProcessedCommandsReceived() Returns the total number of commands that were received but were not processed, usually due to global suspension of command processing.
long	getNumberSuccessfulCommandsReceived() Returns the total number of commands that were received and processed successfully.
long	getNumberTotalCommandsReceived() Returns the sum of all commands 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.

getNumberFailedCommandsReceived

long getNumberFailedCommandsReceived()

Returns the total number of commands that were received but failed to be processed succesfully. This does not count dropped or unprocessed commands.

Returns:

count of failed commands

See Also:

CommandProcessorMetrics.getNumberFailedCommands()

getNumberDroppedCommandsReceived

long getNumberDroppedCommandsReceived()

Returns the total number of commands that were received but were dropped, usually due to a limit reached in the server that prohibits more commands to be invoked until current invocations finish.

Returns:

count of dropped commands

See Also:

CommandProcessorMetrics.getNumberDroppedCommands()

getNumberNotProcessedCommandsReceived

long getNumberNotProcessedCommandsReceived()

Returns the total number of commands that were received but were not processed, usually due to global suspension of command processing.

Returns:

count of dropped commands

See Also:

CommandProcessorMetrics.getNumberNotProcessedCommands()

getNumberSuccessfulCommandsReceived

long getNumberSuccessfulCommandsReceived()

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

Returns:

count of commands successfully processed

See Also:

CommandProcessorMetrics.getNumberSuccessfulCommands()

getNumberTotalCommandsReceived

long getNumberTotalCommandsReceived()

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

Returns:

total number of commands received

getAverageExecutionTimeReceived

long getAverageExecutionTimeReceived()

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

Returns:

average execute time for all successful commands.

See Also:

CommandProcessorMetrics.getAverageExecutionTime()

getCallTimeDataReceived

Map<String,CommandProcessorMetrics.Calltime> getCallTimeDataReceived()

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

Returns:

calltime data

See Also:

CommandProcessorMetrics#getCallTimeDataReceived()