Skip to content

docs: add column_value_anomalies test documentation#2183

Open
devin-ai-integration[bot] wants to merge 3 commits intodocsfrom
devin/1775975833-column-value-anomalies-docs
Open

docs: add column_value_anomalies test documentation#2183
devin-ai-integration[bot] wants to merge 3 commits intodocsfrom
devin/1775975833-column-value-anomalies-docs

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot commented Apr 12, 2026

Summary

Adds documentation for a new column_value_anomalies test — a row-level anomaly detection test that operates directly on raw column values rather than on aggregate metrics (min, max, average) per time bucket.

This is a docs-first PR ahead of implementation in the dbt-data-reliability package. The new page:

  • Explains how the test works (z-score on individual row values against historical baseline)
  • Differentiates it from the existing column_anomalies test with a comparison table
  • Documents supported configuration parameters (timestamp_column, where_expression, anomaly_sensitivity, anomaly_direction, detection_period, training_period, detection_delay)
  • Provides YAML examples for models
  • Is added to the "Anomaly Detection Tests" navigation group in docs.json

Updates since last revision

  • Removed time_bucket and seasonality from the config block and examples. Since this test operates on raw individual values (no per-bucket aggregation), time bucketing is not applicable. The test uses training_period and detection_period directly to define the historical baseline and evaluation windows.
  • Updated all YAML examples to use training_period/detection_period instead of time_bucket.

Screenshots

Mintlify preview: https://elementary-devin-1775975833-column-value-anomalies-docs.mintlify.app/data-tests/anomaly-detection-tests/column-value-anomalies

Note: Screenshots below were captured before the time_bucket removal. Use the Mintlify preview link above for the current rendered page.

Page top — title, description, how it works

Page middle — note, when to use table, config block

Review & Testing Checklist for Human

  • Verify the described behavior matches the intended design — the doc states the test computes mean+stddev from training period values and z-scores each row in the detection period. Confirm this is the correct detection approach before the implementation PR lands.
  • Confirm time_bucket and seasonality should be excluded — these were intentionally removed since this test doesn't aggregate per bucket. Verify this aligns with the planned implementation.
  • Check that timestamp_column should be required — this doc says it's required, unlike other anomaly tests where it's "highly recommended." Confirm this is desired.
  • Review which config params are included/excluded — the config block omits ignore_small_changes, anomaly_exclude_metrics, and dimensions that other anomaly tests support. Verify whether these should be supported for this test type.
  • Preview the rendered page — use the Mintlify preview link to confirm the table, <Note> block, and <pre> config block render correctly.

Notes

  • The corresponding implementation PR for dbt-data-reliability has not been created yet — this PR documents the intended API surface.
  • The test is scoped to numeric columns only as stated in the <Note> block.
  • Mintlify deployment and link-rot CI checks passed. The two failing checks (code-quality, create_pylon_issue) are pre-existing issues unrelated to this PR.

Link to Devin session: https://app.devin.ai/sessions/97ebe636d57244fb82a7452e1521604e
Requested by: @arbiv

Co-Authored-By: Yosef Arbiv <yosef.arbiv@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 12, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
elementary 🟢 Ready View Preview Apr 12, 2026, 6:40 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 12, 2026

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: Pro

Run ID: 55abfd64-46fd-4b40-933c-1c0975002100

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch devin/1775975833-column-value-anomalies-docs

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

Copy link
Copy Markdown
Contributor Author

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

…config

Co-Authored-By: Yosef Arbiv <yosef.arbiv@gmail.com>
Co-Authored-By: Yosef Arbiv <yosef.arbiv@gmail.com>
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