Skip to content

docs: document the metric_stability test - #2343

Merged
joostboon merged 1 commit into
docsfrom
docs-metric-stability
Sep 9, 2026
Merged

joostboon merged 1 commit into
docsfrom
docs-metric-stability

Conversation

@joostboon

Copy link
Copy Markdown

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's docs/ 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 the volume-threshold page's structure.

It covers:

  • What the test detects: a settled bucket's own aggregate changing after the fact, which comparing different periods does not directly check.
  • min_bucket_age, and why measurements taken while a bucket is still settling are excluded from both baselines.
  • last_check vs first_check, including that last_check accepts each new value automatically while first_check keeps failing until the value returns within tolerance.
  • Coverage and cost: what days_back and backfill_days bound, and that the derived window is a convenience default rather than a retention policy.
  • Per-dimension history, since each bucket/dimension combination is its own metric with its own baseline.
  • Failure detail in test result samples, and the difference between value_changed and missing_bucket.

Also adds metric_stability to the Relevant tests line on the existing dimensions page, which the test supports.

Note on limits

The page states plainly that there is no accept-or-reset-baseline operation, that the first_check baseline 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

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>
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: fa8d89e0-2e43-447f-a5c4-8582fba7c2dd

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

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>
@joostboon
joostboon merged commit 8629749 into docs Sep 9, 2026
6 of 8 checks passed
@joostboon
joostboon deleted the docs-metric-stability branch September 9, 2026 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant