You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Data health signals <Lifecyclestatus="preview" />
10
+
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**.
11
+
12
+
- Supported resources are [models](/docs/build/models), [sources](/docs/build/sources), and [exposures](/docs/build/exposures).
13
+
- For accurate health data, ensure the resource is up-to-date and had a recent job run.
14
+
- 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)
15
+
16
+
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/data-health-signal.jpg"width="55%"title="View data health signals for your models."/>
17
+
18
+
## Access data health signals
19
+
20
+
Access data health signals in the following places:
21
+
- In the [search function](/docs/collaborate/explore-projects#search-resources) or under **Models**, **Sources**, or **Exposures** in the **Resource** tab.
22
+
- For sources, the data health signal also indicates the [source freshness](/docs/deploy/source-freshness) status.
23
+
- 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.
24
+
- In the **Health** column of public models tables.
25
+
- 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.
26
+
- In [Data health tiles](/docs/collaborate/data-tile) through an embeddable iFrame and visible in your BI dashboard.
27
+
28
+
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/data-health-signal.gif"width="95%"title="Access data health signals in multiple places in dbt Explorer."/>
29
+
30
+
## Data health signal criteria
31
+
32
+
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.
33
+
<Tabs>
34
+
<TabItemvalue="models"label="Models">
35
+
36
+
The health state of a model is determined by the following criteria:
37
+
<!-- TODO: remove the 'tbd' lines in the table once meta 4025 is done -->
38
+
|**Health state**|**Criteria**|
39
+
|-------------------|---------------|
40
+
| ✅ **Healthy**| All of the following must be true:<br /><br /> - Built successfully in the last run<br />- Built in the last 30 days<br />- Model has tests configured<br />- All tests passed<br />- All upstream [sources are fresh](/docs/build/sources#source-data-freshness) or freshness is not applicable (set to `null`)<br />- Has a description |
41
+
| 🟡 **Caution**| One of the following must be true: <br /><br />- Not built in the last 30 days<br />- Tests are not configured<br />- Tests return warnings<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 |
42
+
| 🔴 **Degraded**| One of the following must be true: <br /><br />- Model failed to build<br />- Model has failing tests<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 |
43
+
| ⚪ **Unknown**| - Unable to determine health of resource; no job runs have processed the resource. |
44
+
45
+
</TabItem>
46
+
47
+
<TabItemvalue="sources"label="Sources">
48
+
49
+
The health state of a source is determined by the following criteria:
50
+
51
+
|**Health state**|**Criteria**|
52
+
|-------------------|---------------|
53
+
| ✅ Healthy | All of the following must be true: <br /><br />- Freshness check configured<br />- Freshness check passed<br />- Freshness check ran in the past 30 days<br />- Has a description |
54
+
| 🟡 Caution | One of the following must be true: <br /><br />- Freshness check returned a warning<br />- Freshness check not configured<br />- Freshness check not run in the past 30 days<br />- Missing a description |
55
+
| 🔴 Degraded | - Freshness check returned an error |
56
+
| ⚪ Unknown | Unable to determine health of resource; no job runs have processed the resource. |
57
+
58
+
</TabItem>
59
+
60
+
<TabItemvalue="exposures"label="Exposures">
61
+
62
+
The health state of an exposure is determined by the following criteria:
63
+
64
+
|**Health state**|**Criteria**|
65
+
|-------------------|---------------|
66
+
| ✅ Healthy | All of the following must be true: <br /><br />- Underlying sources are fresh<br />- Underlying models built successfully<br />- Underlying models’ tests passing<br /><!-- - Freshness must be applicable <br /> - (TBD) Underlying models built in the last 30 days -->|
67
+
| 🟡 Caution | One of the following must be true: <br /><br />- At least one underlying source’s freshness checks returned a warning<br />- At least one underlying model was skipped<br />- At least one underlying model’s tests returned a warning<br /><!-- - (TBD) At least one model not built in the last 30 days -->|
68
+
| 🔴 Degraded | One of the following must be true: <br /><br />- At least one underlying source’s freshness checks returned an error<br />- At least one underlying model did not build successfully<br />- At least one model’s tests returned an error |
69
+
70
+
</TabItem>
71
+
72
+
<!-- TODO: Add source collection health once META-3973/3971 are completed
The health state of a source collection is determined by the following criteria:
76
+
77
+
Functions as an aggregate of underlying sources
78
+
79
+
| **Health state** | **Criteria** |
80
+
|-------------------|---------------|
81
+
| ✅ 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 |
82
+
| 🟡 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 |
83
+
| 🔴 Degraded | - One or more underlying sources’ freshness checks returned error |
With data health tiles, stakeholders will get an at-a-glance confirmation on whether the data they’re looking at is stale or degraded. This trust signal allows teams to immediately go back into Explorer to see more details and investigate issues.
9
+
With data health tiles, stakeholders will get an at-a-glance confirmation on whether the data they’re looking at is stale or degraded. It allows teams to immediately go back into Explorer to see more details and investigate issues.
10
10
11
11
The data health tile:
12
12
13
-
- Distills trust signals for data consumers.
13
+
- Distills [data health signals](/docs/collaborate/data-health-signals) for data consumers.
14
14
- Deep links you into dbt Explorer where you can further dive into upstream data issues.
15
15
- Provides richer information and makes it easier to debug.
16
16
- Revamps the existing, [job-based tiles](#job-based-data-health).
17
17
18
-
Data health tiles rely on [exposures](/docs/build/exposures) to surface trust signals in your dashboards. When you configure exposures in your dbt project, you are explicitly defining how specific outputs—like dashboards or reports—depend on your data models.
18
+
Data health tiles rely on [exposures](/docs/build/exposures) to surface data health signals in your dashboards. When you configure exposures in your dbt project, you are explicitly defining how specific outputs—like dashboards or reports—depend on your data models.
19
19
20
20
<DocCarouselslidesPerView={1}>
21
21
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/data-tile-pass.jpg"width="60%"title="Example of passing Data health tile in your dashboard." />
22
-
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/data-tiles.png"width="60%"title="Embed data health tiles in your dashboards to distill trust signals for data consumers." />
22
+
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/data-tiles.png"width="60%"title="Embed data health tiles in your dashboards to distill data health signals for data consumers." />
@@ -31,6 +31,7 @@ Navigate the dbt Explorer overview page to access your project's resources and m
31
31
-**Marts and public models**— View the [marts](/best-practices/how-we-structure/1-guide-overview#guide-structure-overview) and [public models](/docs/collaborate/govern/model-access#access-modifiers) in your project. You can also navigate to all public models in your account through this view.
32
32
-**Model query history**— Use [model query history](/docs/collaborate/model-query-history) to track consumption queries on your models for deeper insights.
33
33
-**Auto-exposures**—[Set up and view auto-exposures](/docs/collaborate/auto-exposures) to automatically expose relevant data models from Tableau to enhance visibility.
34
+
-**Data health signals**— View the [data-health-signals](/docs/collaborate/data-health-signals) for each resource to understand its health and performance.
34
35
35
36
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/explorer-main-page.gif"width="100%"title="Access dbt Explorer from dbt Cloud by clicking Explore in the navigation."/>
36
37
@@ -162,61 +163,8 @@ Under the the **Models** option, you can filter on model properties (access or m
162
163
163
164
</Expandable>
164
165
165
-
<Expandablealt_header="Trust signals for resources"lifecycle="preview">
166
-
167
-
Trust signal icons offer a quick, at-a-glance view of data health when browsing your resources in dbt Explorer. These icons keep you informed on the status of your resource's health using the indicators **Healthy**, **Caution**, **Degraded**, and **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. Supported resources are models, sources, and exposures.
168
-
169
-
Each trust signal icon reflects key data health components, such as test success status, missing resource descriptions, absence of builds in 30-day windows, and more.
170
-
171
-
To access trust signals:
172
-
- Use the search function or click on **Models**, **Sources** or **Exposures** under the **Resource** tab.
173
-
- View the icons under the **Health** column.
174
-
- Hover over or click the trust signal to see detailed information.
175
-
- For sources, the trust signal also indicates the source freshness status.
176
-
177
-
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/trust-signal-health.jpg"width="60%"title="View trust signals for your models."/>
178
-
179
-
<!-- commenting out until further iteration on the content
180
-
181
-
<Tabs>
182
-
<TabItem value="healthy" label="Healthy">
183
-
A resource is considered Healthy if it meets the following criteria:
184
-
- Ran all tests successfully
185
-
- Successfully built in its last run
186
-
- Has a description and tests configured
187
-
- Has been built in the past 30 days
188
-
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-healthy.png" title="Healthy trust signal icon"/>
189
-
</TabItem>
190
-
191
-
<TabItem value="caution" label="Caution">
192
-
Any of the following conditions can trigger a caution status:
193
-
- Successfully built in its last run
194
-
- Is missing a description
195
-
- Does not have any tests configured
196
-
- Has not been built in the past 30 day
197
-
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-caution.png" title="Caution trust signal icon"/>
198
-
</TabItem>
199
-
200
-
<TabItem value="degraded" label="Degraded">
201
-
A resource is considered Degraded if it meets any of the following criteria:
202
-
- Last run failed or source freshness error
203
-
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signals-degraded.jpg" width="35%" title="Degraded trust signal icon"/>
204
-
</TabItem>
205
-
206
-
<TabItem value="unknown" label="Unknown">
207
-
The Unknown trust signal icon indicates that:
208
-
- Health information is unknown because the resource hasn't been run recently.
209
-
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-unknown.png" title="Unknown trust signal icon"/>
210
-
211
-
</TabItem>
212
-
</Tabs>
213
-
214
-
-->
215
-
216
-
</Expandable>
217
-
218
166
### Example of keyword search
219
-
Example of results from searching on the keyword `customers` and applying the filters models, description, and code. Trust signals are visible to the right of the model name in the search results.
167
+
Example of results from searching on the keyword `customers` and applying the filters models, description, and code. [Data health signals](/docs/collaborate/data-health-signals) are visible to the right of the model name in the search results.
220
168
221
169
<Lightboxsrc="/img/docs/collaborate/dbt-explorer/example-keyword-search.png"width="100%"title="Example of keyword search" />
222
170
@@ -225,6 +173,7 @@ Example of results from searching on the keyword `customers` and applying the fi
225
173
From the sidebar, you can browse your project's resources, its file tree, and the database.
226
174
227
175
-**Resources** tab — All resources in the project organized by type. Select any resource type in the list and all those resources in the project will display as a table in the main section of the page. For a description on the different resource types (like models, metrics, and so on), refer to [About dbt projects](/docs/build/projects).
176
+
-[Data health signals](/docs/collaborate/data-health-signals) are visible to the right of the resource name under the **Health** column.
228
177
-**File Tree** tab — All resources in the project organized by the file in which they are defined. This mirrors the file tree in your dbt project repository.
229
178
-**Database** tab — All resources in the project organized by the database and schema in which they are built. This mirrors your data platform's structure that represents the [applied state](/docs/dbt-cloud-apis/project-state) of your project.
230
179
@@ -253,7 +202,7 @@ In the upper right corner of the resource details page, you can:
253
202
254
203
<Expandablealt_header="What details are available for a model?">
255
204
256
-
-Trust signal icon—Icons offering a quick, at-a-glance view of data health. These icons indicate whether a model is Healthy, Caution, Degraded, or Unknown. Hover over an icon to view detailed information about the model's health.
205
+
-**Data health signals**—[Data health signals](/docs/collaborate/data-health-signals) offer a quick, at-a-glance view of data health. These icons indicate whether a model is Healthy, Caution, Degraded, or Unknown. Hover over an icon to view detailed information about the model's health.
257
206
-**Status bar** (below the page title) — Information on the last time the model ran, whether the run was successful, how the data is materialized, number of rows, and the size of the model.
258
207
-**General** tab includes:
259
208
-**Lineage** graph — The model’s lineage graph that you can interact with. The graph includes one upstream node and one downstream node from the model. Click the Expand icon in the graph's upper right corner to view the model in full lineage graph mode.
@@ -270,6 +219,7 @@ In the upper right corner of the resource details page, you can:
270
219
<Expandablealt_header="What details are available for an exposure?">
271
220
272
221
-**Status bar** (below the page title) — Information on the last time the exposure was updated.
222
+
-**Data health signals**—[Data health signals](/docs/collaborate/data-health-signals) offer a quick, at-a-glance view of data health. These icons indicate whether a resource is Healthy, Caution, or Degraded. Hover over an icon to view detailed information about the exposure's health.
273
223
-**General** tab includes:
274
224
-**Data health**— The status on data freshness and data quality.
275
225
-**Status** section — The status on data freshness and data quality.
@@ -303,6 +253,7 @@ Example of the Tests view:
303
253
<Expandablealt_header="What details are available for each source table within a source collection?">
304
254
305
255
-**Status bar** (below the page title) — Information on the last time the source was updated and the number of tables the source uses.
256
+
-**Data health signals**—[Data health signals](/docs/collaborate/data-health-signals) offer a quick, at-a-glance view of data health. These icons indicate whether a resource is Healthy, Caution, or Degraded. Hover over an icon to view detailed information about the source's health.
306
257
-**General** tab includes:
307
258
-**Lineage** graph — The source’s lineage graph that you can interact with. The graph includes one upstream node and one downstream node from the source. Click the Expand icon in the graph's upper right corner to view the source in full lineage graph mode.
308
259
-**Description** section — A description of the source.
@@ -323,6 +274,7 @@ Example of the details view for the model `customers`:<br /> <Lightbox src="/img
323
274
324
275
</DocCarousel>
325
276
277
+
326
278
## Staging environment
327
279
328
280
dbt Explorer supports views for [staging deployment environments](/docs/deploy/deploy-environments#staging-environment), in addition to the production environment. This gives you a unique view into your pre-production data workflows, with the same tools available in production, while providing an extra layer of scrutiny.
0 commit comments