Package com.azure.ai.metricsadvisor.administration.models

Class TopNGroupScope

java.lang.Object
com.azure.ai.metricsadvisor.administration.models.TopNGroupScope
public final class TopNGroupScope extends Object
The type TopNGroupScope represents the parameters that defines TopN anomaly scope. Detector produces an alert when such "scoped" anomalies are detected.

Each metric has a stream of data points. There can be multiple metrics, hence multiple streams of data points. When these multiple streams produce data points, it can be form a "set" stream. Each set (aka point-set) is indexed by a timestamp; such a set contains data points information arrived at that timestamp from different streams. The TopNGroupScope parameters defines the criteria to report anomalies from these point-set. Each data point in the point-set can be either an anomaly or not. Each anomaly has a rank assigned. The detector can look into the rank of anomalies in each point-sets and use them to compute anomaly-rank for the point-set. The Period in TopNGroupScope means how many latest point-sets we want the service to select for ranking. The Top in TopNGroupScope defines the top anomaly-rank (like top 3 rank), and when anomaly-rank of MinTopCount number of point-sets falls into this top rank, the detector to produce an alert.

  • Constructor Details

    • TopNGroupScope

      public TopNGroupScope(int top, int period, int minTopCount)
      Create an instance of TopNGroupScope describing parameters that defines TopN anomaly scope.
      Parameters:
      top - the top anomaly-rank.
      period - the number of latest point-sets detector select for ranking.
      minTopCount - the number of point-sets in the period to falls into the top rank for anomaly reporting.

  • Method Details

    • getTop

      public Integer getTop()
      Gets the top anomaly-rank.
      Returns:
      the top value.

    • getPeriod

      public Integer getPeriod()
      Gets the period indicating the number of latest point-sets detector select for ranking.
      Returns:
      the period value.

    • getMinTopCount

      public Integer getMinTopCount()
      Gets the number of point-sets in the period to falls into the top rank for anomaly reporting.
      Returns:
      the minTopCount value.

    • setTop

      public TopNGroupScope setTop(Integer top)
      Sets the top anomaly-rank value, value should in the range : [1, +∞).
      Parameters:
      top - the top value to set.
      Returns:
      the TopNGroupScope object itself.

    • setPeriod

      public TopNGroupScope setPeriod(Integer period)
      Sets the period value indicating the number of latest point-sets detector should select for ranking, value should be in the range : [1, +∞).
      Parameters:
      period - the period value to set.
      Returns:
      the TopNGroupScope object itself.

    • setMinTopCount

      public TopNGroupScope setMinTopCount(Integer minTopCount)
      Sets the number of point-sets in the period to falls into the top rank for anomaly reporting,

      the value should be less than or equal to period.

      Parameters:
      minTopCount - the minTopCount value to set.
      Returns:
      the TopNGroupScope object itself.