-
Notifications
You must be signed in to change notification settings - Fork 978
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add new data health signal page #6621
Merged
Merged
Changes from 24 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
4912a29
new trust signal page
mirnawong1 610e2ff
Update website/docs/docs/collaborate/trust-signals.md
mirnawong1 c09b89d
Update website/docs/docs/collaborate/trust-signals.md
mirnawong1 fe5478f
Update trust-signals.md
mirnawong1 6343f73
add links
mirnawong1 95495e6
Merge branch 'update-trust-signals' of github.com:dbt-labs/docs.getdb…
mirnawong1 c40f5c2
Update website/docs/docs/collaborate/trust-signals.md
mirnawong1 26a6754
Merge branch 'current' into update-trust-signals
mirnawong1 ac14f56
Merge branch 'current' into update-trust-signals
mirnawong1 2554c4f
roxi's feedback
mirnawong1 70e385d
Merge branch 'current' into update-trust-signals
mirnawong1 3eebbb0
Merge branch 'current' into update-trust-signals
mirnawong1 bedd6dd
Update website/docs/docs/dbt-versions/release-notes.md
mirnawong1 8425efb
Merge branch 'current' into update-trust-signals
mirnawong1 68e9084
Update website/docs/docs/collaborate/data-health-signals.md
mirnawong1 b2eca9e
Merge branch 'current' into update-trust-signals
mirnawong1 cbe4c6a
jarrod's feedback
mirnawong1 b930af1
fix
mirnawong1 e350bc9
consistent wording
mirnawong1 6a1fc0f
Merge branch 'current' into update-trust-signals
mirnawong1 53233ca
Merge branch 'current' into update-trust-signals
mirnawong1 bde23b3
Update data-health-signals.md
mirnawong1 0d1bfde
Merge branch 'current' into update-trust-signals
mirnawong1 8e25daf
Merge branch 'current' into update-trust-signals
mirnawong1 da2c934
remove and/or
mirnawong1 7246ab4
add freshness
mirnawong1 4e51b03
Merge branch 'current' into update-trust-signals
mirnawong1 483c64f
Update data-health-signals.md
mirnawong1 6ce21f9
Update website/docs/docs/collaborate/data-health-signals.md
runleonarun 8a4ceea
Merge branch 'current' into update-trust-signals
runleonarun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
title: "Data health signals" | ||
sidebar_label: "Data health signals" | ||
id: data-health-signals | ||
description: "Learn how data health signals offer a quick, at-a-glance view of data health when browsing your resources in dbt Explorer." | ||
image: /img/docs/collaborate/dbt-explorer/data-health-signal.jpg | ||
--- | ||
|
||
# Data health signals <Lifecycle status="preview" /> | ||
Data health signals offer a quick, at-a-glance view of data health when browsing your resources in dbt Explorer. They keep you informed on the status of your resource's health using the indicators **Healthy**, **Caution**, **Degraded**, or **Unknown**. | ||
|
||
- Supported resources are [models](/docs/build/models), [sources](/docs/build/sources), and [exposures](/docs/build/exposures). | ||
- For accurate health data, ensure the resource is up-to-date and had a recent job run. | ||
- Each data health signal reflects key data health components, such as test success status, missing resource descriptions, missing tests, absence of builds in 30-day windows, [and more](#data-health-signal-criteria) | ||
|
||
<Lightbox src="/img/docs/collaborate/dbt-explorer/data-health-signal.jpg" width="55%" title="View data health signals for your models."/> | ||
|
||
## Access data health signals | ||
|
||
Access data health signals in the following places: | ||
- In the [search function](/docs/collaborate/explore-projects#search-resources) or under **Models**, **Sources**, or **Exposures** in the **Resource** tab. | ||
- For sources, the data health signal also indicates the source freshness status. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hiya @mirnawong1 This is a non-blocker suggestion / Would it be good to link out source freshness to a source freshness page: https://docs.getdbt.com/docs/deploy/source-freshness or https://docs.getdbt.com/docs/build/sources#snapshotting-source-data-freshness Kind Regards
runleonarun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- In the **Health** column on [each resource's details page](/docs/collaborate/explore-projects#view-resource-details). Hover over or click the signal to view detailed information. | ||
- In the **Health** column of public models tables. | ||
- In the [DAG lineage graph](/docs/collaborate/explore-projects#project-lineage). Click any node to open the node details panel where you can view it and its details. | ||
- In [Data health tiles](/docs/collaborate/data-tile) through an embeddable iFrame and visible in your BI dashboard. | ||
|
||
<Lightbox src="/img/docs/collaborate/dbt-explorer/data-health-signal.gif" width="95%" title="Access data health signals in multiple places in dbt Explorer."/> | ||
|
||
## Data health signal criteria | ||
|
||
Each resource has a health state that is determined by specific set of criteria. Select the following tabs to view the criteria for that resource type. | ||
<Tabs> | ||
<TabItem value="models" label="Models"> | ||
|
||
The health state of a model is determined by the following criteria: | ||
<!-- TODO: remove the 'tbd' lines in the table once meta 4025 is done --> | ||
| **Health state** | **Criteria** | | ||
|-------------------|---------------| | ||
| ✅ **Healthy** | - Built successfully in the last run AND<br />- Built in the last 30 days AND<br />- Model has tests configured AND<br />- All tests passed AND<br />- All upstream sources are fresh or freshness is not applicable (set to `null`) AND<br />- Has a description | | ||
| 🟡 **Caution** | - Not built in the last 30 days OR<br />- Tests are not configured OR<br />- Tests return warnings OR<br />- One or more upstream sources are stale:<br /> - Has a freshness check configured<br /> - Freshness check ran in the past 30 days<br /> - Freshness check returned a warning<br />- Missing a description | | ||
| 🔴 **Degraded** | - Model failed to build OR<br />- Model has failing tests OR<br />- One or more upstream sources are stale:<br /> - Freshness check hasn’t run in the past 30 days<br /> - Freshness check returned an error | | ||
| ⚪ **Unknown** | - Unable to determine health of resource; no job runs have processed the resource. | | ||
|
||
</TabItem> | ||
|
||
<TabItem value="sources" label="Sources"> | ||
|
||
The health state of a source is determined by the following criteria: | ||
|
||
| **Health state** | **Criteria** | | ||
|-------------------|---------------| | ||
| ✅ Healthy | - Freshness check configured AND<br />- Freshness check passed AND<br />- Freshness check ran in the past 30 days AND<br />- Has a description | | ||
| 🟡 Caution | - Freshness check returned a warning OR<br />- Freshness check not configured OR<br />- Freshness check not run in the past 30 days OR<br />- Missing a description | | ||
| 🔴 Degraded | - Freshness check returned an error | | ||
| ⚪ Unknown | Unable to determine health of resource; no job runs have processed the resource. | | ||
|
||
</TabItem> | ||
|
||
<TabItem value="exposures" label="Exposures"> | ||
|
||
The health state of an exposure is determined by the following criteria: | ||
|
||
| **Health state** | **Criteria** | | ||
|-------------------|---------------| | ||
| ✅ Healthy | - Underlying sources are fresh AND<br />- Underlying models built successfully AND<br />- Underlying models’ tests passing AND<br /><!-- - (TBD) Underlying models built in the last 30 days --> | | ||
| 🟡 Caution | - At least one underlying source’s freshness checks returned a warning OR<br />- At least one underlying model was skipped OR<br />- At least one underlying model’s tests returned a warning OR<br /><!-- - (TBD) At least one model not built in the last 30 days --> | | ||
| 🔴 Degraded | - At least one underlying source’s freshness checks returned an error OR<br />- At least one underlying model did not build successfully OR<br />- At least one model’s tests returned an error | | ||
|
||
</TabItem> | ||
|
||
<!-- TODO: Add source collection health once META-3973/3971 are completed | ||
<TabItem value="source-collection" label="Source collection health"> | ||
|
||
The health state of a source collection is determined by the following criteria: | ||
|
||
Functions as an aggregate of underlying sources | ||
|
||
| **Health state** | **Criteria** | | ||
|-------------------|---------------| | ||
| ✅ Healthy | - All underlying sources have freshness checks configured OR<br />- All passed their freshness checks OR<br />- All freshness checks ran in the past 30 days OR<br /> - All sources have a description | | ||
| 🟡 Caution | - One or more sources lack freshness checks OR<br />- One or more freshness checks returned a warning OR<br />- One or more freshness checks not run in the past 30 days OR<br />- One or more sources missing a description | | ||
| 🔴 Degraded | - One or more underlying sources’ freshness checks returned error | | ||
|
||
</TabItem> | ||
--> | ||
|
||
</Tabs> |
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.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For exposures, trust signals are also present in embedded health tiles which is an iframe that users can put into their BI dashboards to view the health of their exposures
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's a great question and i asked @rpourzand the same in the comments earlier! this is what she said:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jcserv - do you see 'trust signal' and 'trust signal icons' mentioned in the docs? i thought i removed references to it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh i see, you mean we say trust signal in the data health tile doc -- good flag!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
per Mirna's Slack note: