public final class MetricAnomalyAlertScope extends Object
Modifier and Type | Method and Description |
---|---|
static MetricAnomalyAlertScope |
forSeriesGroup(DimensionKey seriesGroupId)
Creates an MetricAnomalyAlertScope indicating that alert should be generated when
anomalies are detected in a specific time series group of a metric.
|
static MetricAnomalyAlertScope |
forTopNGroup(int top,
int period,
int minTopCount)
Creates an MetricAnomalyAlertScope based on TopN scoping rule.
|
static MetricAnomalyAlertScope |
forTopNGroup(TopNGroupScope topNGroup)
Creates an MetricAnomalyAlertScope based on TopN scope.
|
static MetricAnomalyAlertScope |
forWholeSeries()
Creates an MetricAnomalyAlertScope indicating that alert should be generated when
anomalies are detected in any of the time series of a metric.
|
MetricAnomalyAlertScopeType |
getScopeType()
Gets the scope type.
|
DimensionKey |
getSeriesGroupInScope()
Gets the id of the time series group if alert is scoped to that group.
|
TopNGroupScope |
getTopNGroupInScope()
Gets the TopN scope value if alert is scoped to TopN time series.
|
public MetricAnomalyAlertScopeType getScopeType()
public DimensionKey getSeriesGroupInScope()
public TopNGroupScope getTopNGroupInScope()
public static MetricAnomalyAlertScope forWholeSeries()
public static MetricAnomalyAlertScope forSeriesGroup(DimensionKey seriesGroupId)
seriesGroupId
- the specific series keys.public static MetricAnomalyAlertScope forTopNGroup(int top, int period, int minTopCount)
top
- Defines the top rank for anomalies, An alert is generated when rank of
minTopCount
data-sets are in top
.period
- The number of latest data-set to consider for ranking. One data-set
consists of data-points with the same timestamp across multiple
time series, i.e, one data-point from one time-series.minTopCount
- The anomalies occurred in the period
data-sets are ranked,
An alert is generated when rank of minTopCount
data-sets
are in top
.public static MetricAnomalyAlertScope forTopNGroup(TopNGroupScope topNGroup)
topNGroup
- Defines the top, period and minTopCount values.Copyright © 2021 Microsoft Corporation. All rights reserved.