org.springframework.integration.support.management.MessageHandlerMetrics.java Source code

Introduction

Here is the source code for org.springframework.integration.support.management.MessageHandlerMetrics.java

Source

/*
 * Copyright 2002-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.integration.support.management;

import org.springframework.jmx.export.annotation.ManagedMetric;
import org.springframework.jmx.support.MetricType;

/**
 * @author Dave Syer
 * @author Gary Russell
 * @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.
 * @since 2.0
 */
@Deprecated
public interface MessageHandlerMetrics extends BaseHandlerMetrics {

    /**
     * @return the number of successful handler calls
     */
    @ManagedMetric(metricType = MetricType.COUNTER, displayName = "Handler Execution Count")
    int getHandleCount();

    /**
     * @return the number of successful handler calls
     * @since 3.0
     */
    @ManagedMetric(metricType = MetricType.COUNTER, displayName = "Handler Execution Count")
    long getHandleCountLong();

    @Override
    default long handleCount() {
        return getHandleCountLong();
    }

    /**
     * @return the number of failed handler calls
     */
    @ManagedMetric(metricType = MetricType.COUNTER, displayName = "Handler Error Count")
    int getErrorCount();

    /**
     * @return the number of failed handler calls
     * @since 3.0
     */
    @ManagedMetric(metricType = MetricType.COUNTER, displayName = "Handler Error Count")
    long getErrorCountLong();

    @Override
    default long errorCount() {
        return getErrorCountLong();
    }

    /**
     * @return the mean handler duration (milliseconds)
     */
    @ManagedMetric(metricType = MetricType.GAUGE, displayName = "Handler Mean Duration in Milliseconds")
    double getMeanDuration();

    /**
     * @return the minimum handler duration (milliseconds)
     */
    @ManagedMetric(metricType = MetricType.GAUGE, displayName = "Handler Min Duration in Milliseconds")
    double getMinDuration();

    /**
     * @return the maximum handler duration (milliseconds)
     */
    @ManagedMetric(metricType = MetricType.GAUGE, displayName = "Handler Max Duration in Milliseconds")
    double getMaxDuration();

    /**
     * @return the standard deviation handler duration (milliseconds)
     */
    @ManagedMetric(metricType = MetricType.GAUGE, displayName = "Handler Standard Deviation Duration in Milliseconds")
    double getStandardDeviationDuration();

    @ManagedMetric(metricType = MetricType.GAUGE, displayName = "Handler Active Execution Count")
    int getActiveCount();

    @ManagedMetric(metricType = MetricType.GAUGE, displayName = "Handler Active Execution Count")
    long getActiveCountLong();

    /**
     * @return summary statistics about the handler duration (milliseconds)
     */
    Statistics getDuration();

    void setManagedName(String name);

    String getManagedName();

    void setManagedType(String source);

    String getManagedType();

}