Package org.apache.flink.autoscaler.metrics

Enum ScalingMetric

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ScalingMetric>
    public enum ScalingMetric
extends java.lang.Enum<ScalingMetric>
    Supported scaling metrics. These represent high level metrics computed from Flink job metrics that are used for scaling decisions in the autoscaler module.

    • Enum Constant Detail

      • LOAD

        public static final ScalingMetric LOAD
        Subtask load (busy time ratio 0 (idle) to 1 (fully utilized)).

      • TRUE_PROCESSING_RATE

        public static final ScalingMetric TRUE_PROCESSING_RATE
        Processing rate at full capacity (records/sec).

      • OBSERVED_TPR

        public static final ScalingMetric OBSERVED_TPR
        Observed true processing rate for sources.

      • CURRENT_PROCESSING_RATE

        public static final ScalingMetric CURRENT_PROCESSING_RATE
        Current processing rate.

      • SOURCE_DATA_RATE

        public static final ScalingMetric SOURCE_DATA_RATE
        Incoming data rate to the source, e.g. rate of records written to the Kafka topic (records/sec).

      • TARGET_DATA_RATE

        public static final ScalingMetric TARGET_DATA_RATE
        Target processing rate of operators as derived from source inputs (records/sec).

      • CATCH_UP_DATA_RATE

        public static final ScalingMetric CATCH_UP_DATA_RATE
        Target processing rate of operators as derived from backlog (records/sec).

      • LAG

        public static final ScalingMetric LAG
        Total number of pending records.

      • PARALLELISM

        public static final ScalingMetric PARALLELISM
        Job vertex parallelism.

      • RECOMMENDED_PARALLELISM

        public static final ScalingMetric RECOMMENDED_PARALLELISM
        Recommended job vertex parallelism.

      • MAX_PARALLELISM

        public static final ScalingMetric MAX_PARALLELISM
        Job vertex max parallelism.

      • SCALE_UP_RATE_THRESHOLD

        public static final ScalingMetric SCALE_UP_RATE_THRESHOLD
        Upper boundary of the target data rate range.

      • SCALE_DOWN_RATE_THRESHOLD

        public static final ScalingMetric SCALE_DOWN_RATE_THRESHOLD
        Lower boundary of the target data rate range.

      • EXPECTED_PROCESSING_RATE

        public static final ScalingMetric EXPECTED_PROCESSING_RATE
        Expected true processing rate after scale up.

    • Method Detail

      • values

        public static ScalingMetric[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ScalingMetric c : ScalingMetric.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ScalingMetric valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • isCalculateAverage

        public boolean isCalculateAverage()