GH-2803: Deprecate legacy metrics

Resolves #2803

* Polishing - PR Comments

* More PR Comments

* Missed one comment

Author: garyrussell

spring-integration-core/src/main/java/org/springframework/integration/aggregator/AbstractCorrelatingMessageHandler.java

@@ -32,7 +32,6 @@
 import org.springframework.aop.framework.ProxyFactory;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryAware;
-import org.springframework.beans.factory.DisposableBean;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ApplicationEventPublisherAware;
 import org.springframework.context.Lifecycle;
@@ -92,7 +91,7 @@
  * @since 2.0
  */
 public abstract class AbstractCorrelatingMessageHandler extends AbstractMessageProducingHandler
-		implements DiscardingMessageHandler, DisposableBean, ApplicationEventPublisherAware, Lifecycle {
+		implements DiscardingMessageHandler, ApplicationEventPublisherAware, Lifecycle {
 
 	private final Comparator<Message<?>> sequenceNumberComparator = new MessageSequenceComparator();
 

spring-integration-core/src/main/java/org/springframework/integration/aggregator/ExpressionEvaluatingMessageGroupProcessor.java

@@ -19,7 +19,6 @@
 import java.util.Map;
 
 import org.springframework.beans.factory.BeanFactory;
-import org.springframework.beans.factory.BeanFactoryAware;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.integration.store.MessageGroup;
 
@@ -32,7 +31,7 @@
  * @author Dave Syer
  * @author Gary Russell
  */
-public class ExpressionEvaluatingMessageGroupProcessor extends AbstractAggregatingMessageGroupProcessor implements BeanFactoryAware {
+public class ExpressionEvaluatingMessageGroupProcessor extends AbstractAggregatingMessageGroupProcessor {
 
 	private final ExpressionEvaluatingMessageListProcessor processor;
 

spring-integration-core/src/main/java/org/springframework/integration/channel/AbstractMessageChannel.java

@@ -37,9 +37,6 @@
 import org.springframework.integration.support.management.ConfigurableMetricsAware;
 import org.springframework.integration.support.management.DefaultMessageChannelMetrics;
 import org.springframework.integration.support.management.IntegrationManagedResource;
-import org.springframework.integration.support.management.MessageChannelMetrics;
-import org.springframework.integration.support.management.MetricsContext;
-import org.springframework.integration.support.management.Statistics;
 import org.springframework.integration.support.management.TrackableComponent;
 import org.springframework.integration.support.management.metrics.MeterFacade;
 import org.springframework.integration.support.management.metrics.MetricsCaptor;
@@ -69,7 +66,8 @@
 @IntegrationManagedResource
 @SuppressWarnings("deprecation")
 public abstract class AbstractMessageChannel extends IntegrationObjectSupport
-		implements MessageChannel, TrackableComponent, ChannelInterceptorAware, MessageChannelMetrics,
+		implements MessageChannel, TrackableComponent, ChannelInterceptorAware,
+		org.springframework.integration.support.management.MessageChannelMetrics,
 		ConfigurableMetricsAware<AbstractMessageChannelMetrics> {
 
 	protected final ChannelInterceptorList interceptors; // NOSONAR
@@ -117,8 +115,8 @@ public void setShouldTrack(boolean shouldTrack) {
 	}
 
 	@Override
-	public void registerMetricsCaptor(MetricsCaptor metricsCaptor) {
-		this.metricsCaptor = metricsCaptor;
+	public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister) {
+		this.metricsCaptor = metricsCaptorToRegister;
 	}
 
 	@Nullable
@@ -335,17 +333,17 @@ public double getStandardDeviationSendDuration() {
 	}
 
 	@Override
-	public Statistics getSendDuration() {
+	public org.springframework.integration.support.management.Statistics getSendDuration() {
 		return this.channelMetrics.getSendDuration();
 	}
 
 	@Override
-	public Statistics getSendRate() {
+	public org.springframework.integration.support.management.Statistics getSendRate() {
 		return this.channelMetrics.getSendRate();
 	}
 
 	@Override
-	public Statistics getErrorRate() {
+	public org.springframework.integration.support.management.Statistics getErrorRate() {
 		return this.channelMetrics.getErrorRate();
 	}
 
@@ -429,7 +427,7 @@ public boolean send(Message<?> messageArg, long timeout) {
 		Deque<ChannelInterceptor> interceptorStack = null;
 		boolean sent = false;
 		boolean metricsProcessed = false;
-		MetricsContext metricsContext = null;
+		org.springframework.integration.support.management.MetricsContext metricsContext = null;
 		boolean countsAreEnabled = this.countsEnabled;
 		ChannelInterceptorList interceptorList = this.interceptors;
 		AbstractMessageChannelMetrics metrics = this.channelMetrics;

spring-integration-core/src/main/java/org/springframework/integration/channel/NullChannel.java

@@ -27,8 +27,6 @@
 import org.springframework.integration.support.management.ConfigurableMetricsAware;
 import org.springframework.integration.support.management.DefaultMessageChannelMetrics;
 import org.springframework.integration.support.management.IntegrationManagedResource;
-import org.springframework.integration.support.management.MessageChannelMetrics;
-import org.springframework.integration.support.management.Statistics;
 import org.springframework.integration.support.management.metrics.MetricsCaptor;
 import org.springframework.integration.support.management.metrics.TimerFacade;
 import org.springframework.lang.Nullable;
@@ -47,7 +45,9 @@
  * @author Artyem Bilan
  */
 @IntegrationManagedResource
-public class NullChannel implements PollableChannel, MessageChannelMetrics,
+@SuppressWarnings("deprecation")
+public class NullChannel implements PollableChannel,
+		org.springframework.integration.support.management.MessageChannelMetrics,
 		ConfigurableMetricsAware<AbstractMessageChannelMetrics>, BeanNameAware, NamedComponent {
 
 	private final Log logger = LogFactory.getLog(getClass());
@@ -211,17 +211,17 @@ public double getStandardDeviationSendDuration() {
 	}
 
 	@Override
-	public Statistics getSendDuration() {
+	public org.springframework.integration.support.management.Statistics getSendDuration() {
 		return this.channelMetrics.getSendDuration();
 	}
 
 	@Override
-	public Statistics getSendRate() {
+	public org.springframework.integration.support.management.Statistics getSendRate() {
 		return this.channelMetrics.getSendRate();
 	}
 
 	@Override
-	public Statistics getErrorRate() {
+	public org.springframework.integration.support.management.Statistics getErrorRate() {
 		return this.channelMetrics.getErrorRate();
 	}
 

spring-integration-core/src/main/java/org/springframework/integration/channel/interceptor/ThreadStatePropagationChannelInterceptor.java

@@ -21,7 +21,6 @@
 import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessageHandler;
 import org.springframework.messaging.MessageHeaders;
-import org.springframework.messaging.support.ChannelInterceptor;
 import org.springframework.messaging.support.ExecutorChannelInterceptor;
 
 /**
@@ -51,7 +50,7 @@
  * @since 4.2
  */
 public abstract class ThreadStatePropagationChannelInterceptor<S>
-		implements ChannelInterceptor, ExecutorChannelInterceptor {
+		implements ExecutorChannelInterceptor {
 
 	@Override
 	public final Message<?> preSend(Message<?> message, MessageChannel channel) {

spring-integration-core/src/main/java/org/springframework/integration/config/EnableIntegrationManagement.java

@@ -23,6 +23,7 @@
 import java.lang.annotation.Target;
 
 import org.springframework.context.annotation.Import;
+import org.springframework.core.annotation.AliasFor;
 
 /**
  * Enables default configuring of management in Spring Integration components in an existing application.
@@ -53,9 +54,29 @@
 	 * Defaults to no components, unless JMX is enabled in which case, defaults to all
 	 * components. Overrides {@link #defaultCountsEnabled()} for matching bean names.
 	 * @return the patterns.
+	 * @deprecated in favor of 'metersEnabled'.
 	 */
+	@Deprecated
+	@AliasFor("metersEnabled")
 	String[] countsEnabled() default "*";
 
+	/**
+	 * A list of simple patterns for component names for which message counts will be
+	 * enabled (defaults to '*'). Enables message
+	 * counting (`sendCount`, `errorCount`, `receiveCount`) for those components that
+	 * support counters (channels, message handlers, etc). This is the initial setting
+	 * only, individual components can have counts enabled/disabled at runtime. May be
+	 * overridden by an entry in {@link #statsEnabled() statsEnabled} which is additional
+	 * functionality over simple counts. If a pattern starts with `!`, counts are disabled
+	 * for matches. For components that match multiple patterns, the first pattern wins.
+	 * Disabling counts at runtime also disables stats.
+	 * Defaults to no components, unless JMX is enabled in which case, defaults to all
+	 * components. Overrides {@link #defaultCountsEnabled()} for matching bean names.
+	 * @return the patterns.
+	 */
+	@AliasFor("countsEnabled")
+	String[] metersEnabled() default "*";
+
 	/**
 	 * A list of simple patterns for component names for which message statistics will be
 	 * enabled (response times, rates etc), as well as counts (a positive match here
@@ -72,7 +93,11 @@
 	 * Defaults to no components, unless JMX is enabled in which case, defaults to all
 	 * components.
 	 * @return the patterns.
+	 * @deprecated in favor of dimensional metrics via
+	 * {@link org.springframework.integration.support.management.metrics.MeterFacade}.
+	 * Built-in metrics will be removed in a future release.
 	 */
+	@Deprecated
 	String[] statsEnabled() default "*";
 
 	/**
@@ -86,7 +111,11 @@
 	 * The default setting for enabling statistics when a bean name is not matched by
 	 * {@link #statsEnabled() statsEnabled}.
 	 * @return the value; false by default, or true when JMX is enabled.
+	 * @deprecated in favor of dimensional metrics via
+	 * {@link org.springframework.integration.support.management.metrics.MeterFacade}.
+	 * Built-in metrics will be removed in a future release.
 	 */
+	@Deprecated
 	String defaultStatsEnabled() default "false";
 
 	/**
@@ -113,7 +142,11 @@
 	 * The bean name of a {@code MetricsFactory}. The {@code DefaultMetricsFactory} is used
 	 * if omitted.
 	 * @return the bean name.
+	 * @deprecated in favor of dimensional metrics via
+	 * {@link org.springframework.integration.support.management.metrics.MeterFacade}.
+	 * Built-in metrics will be removed in a future release.
 	 */
+	@Deprecated
 	String metricsFactory() default "";
 
 }

spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationManagementConfiguration.java

@@ -64,6 +64,7 @@ public void setImportMetadata(AnnotationMetadata importMetadata) {
 				"@EnableIntegrationManagement is not present on importing class " + importMetadata.getClassName());
 	}
 
+	@SuppressWarnings("deprecation")
 	@Bean(name = IntegrationManagementConfigurer.MANAGEMENT_CONFIGURER_NAME)
 	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
 	public IntegrationManagementConfigurer managementConfigurer() {
@@ -90,17 +91,18 @@ private void setupCountsEnabledNamePatterns(IntegrationManagementConfigurer conf
 			String pattern = this.environment.resolvePlaceholders(managedComponent);
 			patterns.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(pattern)));
 		}
-		configurer.setEnabledCountsPatterns(patterns.toArray(new String[patterns.size()]));
+		configurer.setEnabledCountsPatterns(patterns.toArray(new String[0]));
 	}
 
+	@SuppressWarnings("deprecation")
 	private void setupStatsEnabledNamePatterns(IntegrationManagementConfigurer configurer) {
-		List<String> patterns = new ArrayList<String>();
+		List<String> patterns = new ArrayList<>();
 		String[] statsEnabled = this.attributes.getStringArray("statsEnabled");
 		for (String managedComponent : statsEnabled) {
 			String pattern = this.environment.resolvePlaceholders(managedComponent);
 			patterns.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(pattern)));
 		}
-		configurer.setEnabledStatsPatterns(patterns.toArray(new String[patterns.size()]));
+		configurer.setEnabledStatsPatterns(patterns.toArray(new String[0]));
 	}
 
 }