-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ELE-3044: New dimensions features docs (#1520)
* exclude insignificant * add dimensions to column anomalies tests
- Loading branch information
Showing
5 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
docs/data-tests/anomaly-detection-configuration/exclude-final-results.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: "exclude_final_results" | ||
sidebarTitle: "exclude_final_results" | ||
--- | ||
|
||
`exclude_final_results: [SQL where expression on fields value / average]` | ||
|
||
Failures in dimension anomaly tests consist of outliers in row counts across all dimensions during the training period. | ||
Some dimensions may contribute metrics that are considered insignificant compared to others, and you may prefer not to receive alerts for them. | ||
With this parameter, you can disregard such failures. | ||
|
||
1. `value` - Outlier row count of a dimension during the detection period. | ||
2. `average` - The average rows count of a dimension during the training period. | ||
|
||
- _Supported values: valid SQL where expression on the columns value / average_ | ||
- _Relevant tests: Dimension anomalies _ | ||
|
||
<RequestExample> | ||
|
||
```yml test | ||
models: | ||
- name: model_name | ||
config: | ||
elementary: | ||
timestamp_column: updated_at | ||
tests: | ||
- elementary.dimension_anomalies: | ||
dimensions: | ||
- device_os | ||
- device_browser | ||
exclude_final_results: 'value > 1000 or average > 10' | ||
``` | ||
</RequestExample> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters