org.springframework.integration.support.management

Interface BaseChannelMetrics

All Superinterfaces:

DisposableBean, IntegrationManagement, IntegrationStatsManagement

All Known Subinterfaces:

MessageChannelMetrics

All Known Implementing Classes:

AbstractAmqpChannel, AbstractExecutorChannel, AbstractJmsChannel, AbstractMessageChannel, AbstractPollableChannel, AbstractSubscribableChannel, DirectChannel, ExecutorChannel, FluxMessageChannel, NullChannel, PointToPointSubscribableAmqpChannel, PollableAmqpChannel, PollableJmsChannel, PriorityChannel, PublishSubscribeAmqpChannel, PublishSubscribeChannel, QueueChannel, RendezvousChannel, SubscribableJmsChannel, SubscribableRedisChannel

public interface BaseChannelMetrics
extends IntegrationStatsManagement

Primary interface for channels that provide metrics.

Since:

5.2

Author:

Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Method Summary

Modifier and Type	Method and Description
long	sendCount()
long	sendErrorCount()

Methods inherited from interface org.springframework.integration.support.management.IntegrationStatsManagement

isStatsEnabled, setStatsEnabled

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

destroy, getOverrides, isCountsEnabled, isLoggingEnabled, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled

Method Detail

sendCount

@ManagedMetric(metricType=COUNTER,
               displayName="Channel Send Count")
long sendCount()

Returns:

the number of successful sends

sendErrorCount

@ManagedMetric(metricType=COUNTER,
               displayName="Channel Send Error Count")
long sendErrorCount()

Returns:

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