- Troubleshooting
- Resources
startree-matrix-profile-query-dx
Description
Detect an anomaly if the anomaly score returned by a matrix profile(opens in a new tab) algorithm is above the threshold. Aggregation function with 1 operand: SUM, MAX,etc… Use the enumeratorQuery
property to feed in a query that outputs different dimensions to explore.
Flowchart

name | description | default value | |
---|---|---|---|
aggregationColumn |
| – | |
aggregationFunction |
| – | |
dataSource |
| – | |
dataset |
| – | |
monitoringGranularity |
| – | |
timezone | Timezone used to group by time. In TZ-identifier(opens in a new tab) format. For instance, | UTC | |
timeColumn |
| AUTO | |
timeColumnFormat | Required if timeColumn is not AUTO. Learn more(opens in a new tab) | ||
completenessDelay | The time for your data to be considered complete and ready for anomaly detection. In ISO-8601 format. Example: | P0D | |
queryFilters |
| ${queryFilters} | |
queryLimit |
| 100000001 |
name | description | default value | |
---|---|---|---|
lookback | Historical time period to use to train the model. In ISO-8601 format. Example: | – | |
seasonalityPeriod | Biggest seasonality period to learn. In ISO-8601 format. Example: | ||
matrixProfileDistance | For advanced users. Type of distance to use for the matrix profile computation. | NORMALIZED | |
sensitivity | Anomaly score threshold. If the anomaly score returned by the algorithm is bigger than this threshold, return an anomaly. The smaller, the more anomalies are detected. | 1 | |
computeBounds |
| true
| |
scoringMethod | Experimental. Post-processing of the matrix profile anomaly scores.
| FIRST_ORDER_DIFFERENCE |
name | description | default value |
---|---|---|
daysOfWeek | Used to ignore anomalies that happen at specific time periods. A list of days. Anomalies happening on these days are ignored if timeOfWeekIgnore is true. Example: | [] |
hoursOfDay | Used to ignore anomalies that happen at specific time periods. A list of hours. Anomalies happening on these hours are ignored. Example: | [] |
dayHoursOfWeek | Used to ignore anomalies that happen at specific time periods. A mapping of
| {}
|
name | description | default value |
---|---|---|
thresholdFilterMin | Used to ignore anomalies that don’t meet the thresholdFilter min and max. Example: set | -1 |
thresholdFilterMax | Used to ignore anomalies that don’t meet the thresholdFilter min and max. Example: set | -1 |
name | description | default value |
---|---|---|
guardrailMetricMin | Used to ignore anomalies that don’t meet the guardrail threshold. Minimum threshold of the guardrail metric. If | -1 |
guardrailMetricMax
| Used to ignore anomalies that don’t meet the guardrail threshold. Maximum threshold of guardrailMetric. If | -1 |
guardrailMetric | Used to ignore anomalies that don’t meet the guardrail threshold. Metric to use as a threshold guardrail. Example: | COUNT(*) |
Simple baseline
name | description | default value | |
---|---|---|---|
| Used to ignore anomalies that are not detected as anomalies by a simple model. Whether to detect an anomaly if it’s a drop, a spike or any of the two. | UP_OR_DOWN | |
offsetBaselineFilterSensitivity
| Used to ignore anomalies that are not detected as anomalies by a simple model. Detection sensitivity. For instance with | -1 | |
offsetBaselineFilterIntervalsMethod | Used to ignore anomalies that are not detected as anomalies by a simple model. Method to compute intervals. |
| |
offsetBaselineFilterModelOffsets | Used to ignore anomalies that are not detected as anomalies by a simple model. A list of offsets in ISO-8601 format to use as baseline. Eg | [‘P7D’] | |
offsetBaselineFilterModelAggregation | Used to ignore anomalies that are not detected as anomalies by a simple model. The aggregation function to use to combine historical values. In | MEDIAN |
name | description | default value | |||
---|---|---|---|---|---|
eventFilterSqlFilter | Used to ignore anomalies that happen during events. Sql filter to apply on the events. Learn more | ||||
eventFilterLookaround | Used to ignore anomalies that happen during events. Offset to apply on startTime and endTime to look around the timeframe. In ISO-8601 format. Example: | P2D | |||
| Used to ignore anomalies that happen during events. List of event types to fetch by. Example: | [‘__NO_EVENTS’] | |||
eventFilterBeforeEventMargin | Used to ignore anomalies that happen during events. A period in ISO-8601 format that corresponds to a period that is also impacted by the event. Example: if beforeEventMargin is | P0D | |||
|
|
|
Impact
name | description | default value | |
---|---|---|---|
impactThreshold |
| -1 |
name | description | default value | |
---|---|---|---|
mutabilityPeriod | Use if your data is mutable. ThirdEye will maintain the detection results up to date on the mutable period. For instance, if your last 10 days of data is mutable, set | P0D | |
| For detection replay when data is mutable. If the percentage difference between an existing anomaly and a new anomaly on the same time frame is above this threshold, renotify. Combined with | -1 | |
reNotifyAbsoluteThreshold | For detection replay when data is mutable. If the absolute difference between an existing anomaly and a new anomaly on the same time frame is above this threshold, renotify. Combined with | -1 |
Anomaly merger
name | description | default value |
---|---|---|
mergeMaxGap | Maximum gap between 2 anomalies for anomalies to be merged. In ISO-8601 format. Example: | |
mergeMaxDuration | Maximum duration of an anomaly merger. At merge time, if an anomaly merger would get bigger than this limit, the anomalies are not merged. In ISO-8601 format. Example: |
RCA
name | description | default value |
---|---|---|
rcaAggregationFunction |
| |
rcaIncludedDimensions | List of the dimensions (columns in the dataset) to use in RCA drill-downs. If not set or empty, all dimensions of the table are used. Learn more(opens in a new tab). | [] |
rcaExcludedDimensions
| List of dimensions (columns in the dataset) to ignore in RCA drill-downs. If not set or empty, all dimensions of the table are used. rcaExcludedDimensions and rcaIncludedDimensions cannot be used at the same time. | [] |
rcaEventTypes | A list of type to filter on for RCA. Only events that match such types will be shown in the RCA related events tab. Learn more(opens in a new tab). | [] |
rcaEventSqlFilter | A Sql filter for RCA events. Only events that match the filter will be shown in the RCA related events tab. Learn more(opens in a new tab).
|
name | description | default value |
---|---|---|
enumeratorQuery | This is a SQL query that will run on the data source and build enumeration items from that queryExample: “SELECT DISTINCT country, device from pageviews LIMIT 100”. In this case, the enumerator will generate one enumeration item for each country/device combination. | – |
enumerationItemIdKeys | List of keys to use to identify the enumeration. The format is the following:
“queryFilters” ]
The keys must be present in the The keys will be used to generate the dimension exploration id. The id will be used to identify the enumeration in the detection pipeline. | [‘queryFilters’] |