docs: document the metric_stability test - #2343
Merged
Merged
Conversation
Covers the new `elementary.metric_stability` test from the dbt package: what it detects, how the two baselines behave, what `min_bucket_age` and the observation window do to coverage and cost, per-dimension history, and the failure detail written to test result samples. Placed under Other Tests next to the other threshold-style tests, and listed on the `dimensions` page, which the test also supports. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
joostboon
added a commit
to elementary-data/dbt-data-reliability
that referenced
this pull request
Sep 8, 2026
- Rename `_validate_metric_stability_arguments` to `_parse_and_validate_metric_stability_arguments`, since it also normalizes the arguments (scalar to list, column dedupe) rather than only checking them. - Drop docs/metric_stability.md. That directory holds the mintlify docs, so a standalone markdown file there was out of place. The content now lives at elementary-data/elementary#2343 against the docs branch, and the README and the test's header comment point at the published page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
joostboon
added a commit
to elementary-data/dbt-data-reliability
that referenced
this pull request
Sep 8, 2026
- Rename `_validate_metric_stability_arguments` to `_parse_and_validate_metric_stability_arguments`, since it also normalizes the arguments (scalar to list, column dedupe) rather than only checking them. - Drop docs/metric_stability.md. That directory holds the mintlify docs, so a standalone markdown file there was out of place. The content now lives at elementary-data/elementary#2343 against the docs branch, and the README and the test's header comment point at the published page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents
elementary.metric_stability, the new test added in dbt-data-reliability#1050. Opened here rather than in the package repo per review feedback on that PR: a lone markdown file in the package'sdocs/directory was out of place.Contents
New page
data-tests/metric-stability, registered under Other Tests beside the other threshold-style tests (execution-sla,data-freshness-sla,volume-threshold). Follows thevolume-thresholdpage's structure.It covers:
min_bucket_age, and why measurements taken while a bucket is still settling are excluded from both baselines.last_checkvsfirst_check, including thatlast_checkaccepts each new value automatically whilefirst_checkkeeps failing until the value returns within tolerance.days_backandbackfill_daysbound, and that the derived window is a convenience default rather than a retention policy.value_changedandmissing_bucket.Also adds
metric_stabilityto the Relevant tests line on the existingdimensionspage, which the test supports.Note on limits
The page states plainly that there is no accept-or-reset-baseline operation, that the
first_checkbaseline is the earliest retained measurement rather than an approved snapshot, and that the test is not a substitute for an auditable financial close. Worth a look to check that framing is how you want it said publicly.🤖 Generated with Claude Code