org.apache.qpid.server.stats

Interface StatisticsGatherer

All Known Subinterfaces:

BDBHAReplicaVirtualHost<X>, BDBHAVirtualHost<X>, BDBVirtualHost<X>, Broker<X>, DerbyVirtualHost<X>, JDBCVirtualHost<X>, ProvidedStoreVirtualHost<X>, RedirectingVirtualHost<X>, VirtualHostImpl<X,Q,E>

All Known Implementing Classes:

AbstractVirtualHost, BDBHAReplicaVirtualHostImpl, BDBHAVirtualHostImpl, BDBVirtualHostImpl, BrokerAdapter, DerbyVirtualHostImpl, JDBCVirtualHostImpl, MemoryVirtualHost, ProvidedStoreVirtualHostImpl

public interface StatisticsGatherer

This interface is to be implemented by any broker business object that wishes to gather statistics about messages delivered through it. These statistics are exposed using a separate JMX Mbean interface, which calls these methods to retrieve the underlying StatisticsCounters and return their attributes. This interface gives a standard way for parts of the broker to set up and configure statistics generation.

When creating these objects, there should be a parent/child relationship between them, such that the lowest level gatherer can record statistics if enabled, and pass on the notification to the parent object to allow higher level aggregation. When resetting statistics, this works in the opposite direction, with higher level gatherers also resetting all of their children.

Method Summary

Modifier and Type	Method and Description
StatisticsCounter	getDataDeliveryStatistics() Gives access to the StatisticsCounter that is used to count delivered message size statistics.
StatisticsCounter	getDataReceiptStatistics() Gives access to the StatisticsCounter that is used to count received message size statistics.
StatisticsCounter	getMessageDeliveryStatistics() Gives access to the StatisticsCounter that is used to count delivered message statistics.
StatisticsCounter	getMessageReceiptStatistics() Gives access to the StatisticsCounter that is used to count received message statistics.
void	registerMessageDelivered(long messageSize) This method is responsible for registering the delivery of a message with the counters.
void	registerMessageReceived(long messageSize, long timestamp) This method is responsible for registering the receipt of a message with the counters, and also for passing this notification to any parent StatisticsGatherers.
void	resetStatistics() Reset the counters for this, and any child StatisticsGatherers.

Method Detail

registerMessageReceived

void registerMessageReceived(long messageSize,
                             long timestamp)

This method is responsible for registering the receipt of a message with the counters, and also for passing this notification to any parent StatisticsGatherers. If statistics generation is not enabled, then this method should simple delegate to the parent gatherer.

Parameters:

messageSize - the size in bytes of the delivered message

timestamp - the time the message was delivered

registerMessageDelivered

void registerMessageDelivered(long messageSize)

This method is responsible for registering the delivery of a message with the counters. Message delivery is recorded by the counter using the current system time, as opposed to the message timestamp.

Parameters:

messageSize - the size in bytes of the delivered message

See Also:

registerMessageReceived(long, long)

getMessageDeliveryStatistics

StatisticsCounter getMessageDeliveryStatistics()

Gives access to the StatisticsCounter that is used to count delivered message statistics.

Returns:

the StatisticsCounter that counts delivered messages

getMessageReceiptStatistics

StatisticsCounter getMessageReceiptStatistics()

Gives access to the StatisticsCounter that is used to count received message statistics.

Returns:

the StatisticsCounter that counts received messages

getDataDeliveryStatistics

StatisticsCounter getDataDeliveryStatistics()

Gives access to the StatisticsCounter that is used to count delivered message size statistics.

Returns:

the StatisticsCounter that counts delivered bytes

getDataReceiptStatistics

StatisticsCounter getDataReceiptStatistics()

Gives access to the StatisticsCounter that is used to count received message size statistics.

Returns:

the StatisticsCounter that counts received bytes

resetStatistics

void resetStatistics()

Reset the counters for this, and any child StatisticsGatherers.