org.springframework.integration.support.management

Class AggregatingMessageChannelMetrics

java.lang.Object

org.springframework.integration.support.management.AbstractMessageChannelMetrics

org.springframework.integration.support.management.DefaultMessageChannelMetrics

org.springframework.integration.support.management.AggregatingMessageChannelMetrics

All Implemented Interfaces:

ConfigurableMetrics

public class AggregatingMessageChannelMetrics
extends DefaultMessageChannelMetrics

An implementation of MessageChannelMetrics that aggregates the total response time over a sample, to avoid fetching the system time twice for every message.

Since:

4.2

Author:

Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AggregatingMessageChannelMetrics.AggregatingChannelMetricsContext

Nested classes/interfaces inherited from class org.springframework.integration.support.management.DefaultMessageChannelMetrics

DefaultMessageChannelMetrics.DefaultChannelMetricsContext

Field Summary

Fields inherited from class org.springframework.integration.support.management.DefaultMessageChannelMetrics

DEFAULT_MOVING_AVERAGE_WINDOW, ONE_MINUTE_SECONDS, ONE_SECOND_SECONDS, receiveCount, receiveErrorCount, sendCount, sendDuration, sendErrorCount, sendErrorRate, sendRate, sendSuccessRatio

Fields inherited from class org.springframework.integration.support.management.AbstractMessageChannelMetrics

logger, name

Constructor Summary

Constructors

Constructor and Description
AggregatingMessageChannelMetrics()
AggregatingMessageChannelMetrics(String name, ExponentialMovingAverage sendDuration, ExponentialMovingAverageRate sendErrorRate, ExponentialMovingAverageRatio sendSuccessRatio, ExponentialMovingAverageRate sendRate, int sampleSize) Construct an instance with the supplied metrics.
AggregatingMessageChannelMetrics(String name, int sampleSize) Construct an instance with default metrics with window=10, period=1 second, lapsePeriod=1 minute.

Method Summary

Modifier and Type	Method and Description
void	afterSend(MetricsContext context, boolean result) End a send event.
MetricsContext	beforeSend() Begin a send event.

Methods inherited from class org.springframework.integration.support.management.DefaultMessageChannelMetrics

afterError, afterReceive, destroy, getErrorRate, getMaxSendDuration, getMeanErrorRate, getMeanErrorRatio, getMeanSendDuration, getMeanSendRate, getMinSendDuration, getReceiveCount, getReceiveCountLong, getReceiveErrorCount, getReceiveErrorCountLong, getSendCount, getSendCountLong, getSendDuration, getSendErrorCount, getSendErrorCountLong, getSendRate, getStandardDeviationSendDuration, getTimeSinceLastSend, reset, toString

Methods inherited from class org.springframework.integration.support.management.AbstractMessageChannelMetrics

isFullStatsEnabled, setFullStatsEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AggregatingMessageChannelMetrics

public AggregatingMessageChannelMetrics()

AggregatingMessageChannelMetrics

public AggregatingMessageChannelMetrics(String name,
                                        int sampleSize)

Construct an instance with default metrics with window=10, period=1 second, lapsePeriod=1 minute.

Parameters:

name - the name.

sampleSize - the sample size over which to aggregate the duration.

AggregatingMessageChannelMetrics

public AggregatingMessageChannelMetrics(String name,
                                        ExponentialMovingAverage sendDuration,
                                        ExponentialMovingAverageRate sendErrorRate,
                                        ExponentialMovingAverageRatio sendSuccessRatio,
                                        ExponentialMovingAverageRate sendRate,
                                        int sampleSize)

Construct an instance with the supplied metrics. For proper representation of metrics, the supplied sendDuration must have a factor=1000000. and the the other arguments must be created with the millis constructor argument set to true.

Parameters:

name - the name.

sendDuration - an ExponentialMovingAverage for calculating the send duration.

sendErrorRate - an ExponentialMovingAverageRate for calculating the send error rate.

sendSuccessRatio - an ExponentialMovingAverageRatio for calculating the success ratio.

sendRate - an ExponentialMovingAverageRate for calculating the send rate.

sampleSize - the sample size over which to aggregate the duration.

Method Detail

beforeSend

public MetricsContext beforeSend()

Description copied from class: AbstractMessageChannelMetrics

Begin a send event.

Overrides:

beforeSend in class DefaultMessageChannelMetrics

Returns:

the context to be used in a subsequent AbstractMessageChannelMetrics.afterSend(MetricsContext, boolean) call.

afterSend

public void afterSend(MetricsContext context,
                      boolean result)

Description copied from class: AbstractMessageChannelMetrics

End a send event. Note that implementations typically will not validate that the context is of the correct type and not null; callers should take care to ensure the context is the object returned by the previous AbstractMessageChannelMetrics.beforeSend() call.

Overrides:

afterSend in class DefaultMessageChannelMetrics

Parameters:

context - the context.

result - true for success, false otherwise.