public final class TopNGroupScope extends Object
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 and Description |
---|
TopNGroupScope(int top,
int period,
int minTopCount)
Create an instance of TopNGroupScope describing parameters that defines TopN anomaly scope.
|
Modifier and Type | Method and Description |
---|---|
Integer |
getMinTopCount()
Gets the number of point-sets in the period to falls into the top rank for anomaly reporting.
|
Integer |
getPeriod()
Gets the period indicating the number of latest point-sets detector select for ranking.
|
Integer |
getTop()
Gets the top anomaly-rank.
|
TopNGroupScope |
setMinTopCount(Integer minTopCount)
Sets the number of point-sets in the period to falls into the top rank for anomaly reporting,
|
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, +∞).
|
TopNGroupScope |
setTop(Integer top)
Sets the top anomaly-rank value, value should in the range : [1, +∞).
|
public TopNGroupScope(int top, int period, int minTopCount)
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.public Integer getTop()
public Integer getPeriod()
public Integer getMinTopCount()
public TopNGroupScope setTop(Integer top)
top
- the top value to set.public TopNGroupScope setPeriod(Integer period)
period
- the period value to set.public TopNGroupScope setMinTopCount(Integer minTopCount)
the value should be less than or equal to period.
minTopCount
- the minTopCount value to set.Copyright © 2021 Microsoft Corporation. All rights reserved.