org.springframework.integration.monitor

Interface MessageChannelMetrics

All Known Implementing Classes:

DirectChannelMetrics, PollableChannelMetrics, QueueChannelMetrics

public interface MessageChannelMetrics

Interface for all message channel monitors containing accessors for various useful metrics that are generic for all channel types.

Since:

2.0

Author:

Dave Syer

Method Summary

Modifier and Type	Method and Description
Statistics	getErrorRate()
double	getMaxSendDuration()
double	getMeanErrorRate()
double	getMeanErrorRatio()
double	getMeanSendDuration()
double	getMeanSendRate()
double	getMinSendDuration()
int	getSendCount()
long	getSendCountLong()
Statistics	getSendDuration()
int	getSendErrorCount()
long	getSendErrorCountLong()
Statistics	getSendRate()
double	getStandardDeviationSendDuration()
double	getTimeSinceLastSend()
void	reset()

Method Detail

reset

@ManagedOperation
void reset()

getSendCount

@ManagedMetric(metricType=COUNTER,
               displayName="MessageChannel Send Count")
int getSendCount()

Returns:

the number of successful sends

getSendCountLong

@ManagedMetric(metricType=COUNTER,
               displayName="MessageChannel Send Count")
long getSendCountLong()

Returns:

the number of successful sends

Since:

3.0

getSendErrorCount

@ManagedMetric(metricType=COUNTER,
               displayName="MessageChannel Send Error Count")
int getSendErrorCount()

Returns:

the number of failed sends (either throwing an exception or rejected by the channel)

getSendErrorCountLong

@ManagedMetric(metricType=COUNTER,
               displayName="MessageChannel Send Error Count")
long getSendErrorCountLong()

Returns:

the number of failed sends (either throwing an exception or rejected by the channel)

Since:

3.0

getTimeSinceLastSend

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Time Since Last Send in Seconds")
double getTimeSinceLastSend()

Returns:

the time in seconds since the last send

getMeanSendRate

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Send Rate per Second")
double getMeanSendRate()

Returns:

the mean send rate (per second)

getMeanErrorRate

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Error Rate per Second")
double getMeanErrorRate()

Returns:

the mean error rate (per second). Errors comprise all failed sends.

getMeanErrorRatio

@ManagedMetric(metricType=GAUGE,
               displayName="Mean Channel Error Ratio per Minute")
double getMeanErrorRatio()

Returns:

the mean ratio of failed to successful sends in approximately the last minute

getMeanSendDuration

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Send Mean Duration in Milliseconds")
double getMeanSendDuration()

Returns:

the mean send duration (milliseconds)

getMinSendDuration

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Send Min Duration in Milliseconds")
double getMinSendDuration()

Returns:

the minimum send duration (milliseconds) since startup

getMaxSendDuration

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Send Max Duration in Milliseconds")
double getMaxSendDuration()

Returns:

the maximum send duration (milliseconds) since startup

getStandardDeviationSendDuration

@ManagedMetric(metricType=GAUGE,
               displayName="Channel Send Standard Deviation Duration in Milliseconds")
double getStandardDeviationSendDuration()

Returns:

the standard deviation send duration (milliseconds)

getSendDuration

Statistics getSendDuration()

Returns:

summary statistics about the send duration (milliseconds)

getSendRate

Statistics getSendRate()

Returns:

summary statistics about the send rates (per second)

getErrorRate

Statistics getErrorRate()

Returns:

summary statistics about the error rates (per second)