-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into release/v0.11.0
- Loading branch information
Showing
6 changed files
with
465 additions
and
349 deletions.
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
37 changes: 37 additions & 0 deletions
37
docs/guides/anomaly-detection-configuration/fail_on_zero.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,37 @@ | ||
--- | ||
title: "fail_on_zero" | ||
sidebarTitle: "fail_on_zero" | ||
--- | ||
|
||
`fail_on_zero: true/false` | ||
|
||
Elementary anomaly detection tests will fail if there is a zero metric value within the detection period. | ||
If undefined, default is false. | ||
|
||
- _Default: false_ | ||
- _Relevant tests: All anomaly detection tests_ | ||
|
||
<RequestExample> | ||
|
||
```yml test | ||
models: | ||
- name: this_is_a_model | ||
tests: | ||
- elementary.volume_anomalies: | ||
fail_on_zero: true | ||
``` | ||
```yml model | ||
models: | ||
- name: this_is_a_model | ||
config: | ||
elementary: | ||
fail_on_zero: true | ||
``` | ||
```yml dbt_project.yml | ||
vars: | ||
fail_on_zero: true | ||
``` | ||
</RequestExample> |
64 changes: 64 additions & 0 deletions
64
docs/guides/anomaly-detection-configuration/ignore_small_changes.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,64 @@ | ||
--- | ||
title: "ignore_small_changes" | ||
sidebarTitle: "ignore_small_changes" | ||
--- | ||
|
||
``` | ||
ignore_small_changes: | ||
spike_failure_percent_threshold: [int] | ||
drop_failure_percent_threshold: [int] | ||
``` | ||
|
||
If defined, an anomaly test will fail only if all the following conditions hold: | ||
|
||
- The z-score of the metric within the detection period is anomoulous | ||
- One of the following holds: | ||
- The metric within the detection period is higher than `spike_failure_percent_threshold` percentages of the mean value in the training period, if defined. | ||
- The metric within the detection period is lower than `drop_failure_percent_threshold` percentages of the mean value in the training period, if defined | ||
|
||
Those settings can help to deal with situations where your metrics are stable and small changes causes to high z-scores, and therefore to anomaly. | ||
|
||
If undefined, default is null for both spike and drop. | ||
|
||
- _Default: none_ | ||
- _Relevant tests: All anomaly detection tests_ | ||
|
||
<RequestExample> | ||
|
||
```yml test | ||
models: | ||
- name: this_is_a_model | ||
tests: | ||
ignore_small_changes: | ||
spike_failure_percent_threshold: 2 | ||
drop_failure_percent_threshold: 50 | ||
``` | ||
```yml model | ||
models: | ||
- name: this_is_a_model | ||
config: | ||
elementary: | ||
ignore_small_changes: | ||
spike_failure_percent_threshold: 2 | ||
``` | ||
```yml source | ||
sources: | ||
- name: my_non_dbt_tables | ||
schema: raw | ||
tables: | ||
- name: source_table | ||
meta: | ||
elementary: | ||
ignore_small_changes: | ||
drop_failure_percent_threshold: 50 | ||
``` | ||
```yml dbt_project.yml | ||
vars: | ||
ignore_small_changes: | ||
spike_failure_percent_threshold: 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
Oops, something went wrong.