Skip to content
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 30 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
4912a29
new trust signal page
mirnawong1 Dec 9, 2024
610e2ff
Update website/docs/docs/collaborate/trust-signals.md
mirnawong1 Dec 9, 2024
c09b89d
Update website/docs/docs/collaborate/trust-signals.md
mirnawong1 Dec 9, 2024
fe5478f
Update trust-signals.md
mirnawong1 Dec 9, 2024
6343f73
add links
mirnawong1 Dec 9, 2024
95495e6
Merge branch 'update-trust-signals' of github.com:dbt-labs/docs.getdb…
mirnawong1 Dec 9, 2024
c40f5c2
Update website/docs/docs/collaborate/trust-signals.md
mirnawong1 Dec 9, 2024
26a6754
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 9, 2024
ac14f56
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 10, 2024
2554c4f
roxi's feedback
mirnawong1 Dec 10, 2024
70e385d
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 10, 2024
3eebbb0
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 10, 2024
bedd6dd
Update website/docs/docs/dbt-versions/release-notes.md
mirnawong1 Dec 10, 2024
8425efb
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 11, 2024
68e9084
Update website/docs/docs/collaborate/data-health-signals.md
mirnawong1 Dec 11, 2024
b2eca9e
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 11, 2024
cbe4c6a
jarrod's feedback
mirnawong1 Dec 11, 2024
b930af1
fix
mirnawong1 Dec 11, 2024
e350bc9
consistent wording
mirnawong1 Dec 11, 2024
6a1fc0f
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 13, 2024
53233ca
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 16, 2024
bde23b3
Update data-health-signals.md
mirnawong1 Dec 16, 2024
0d1bfde
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 16, 2024
8e25daf
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 16, 2024
da2c934
remove and/or
mirnawong1 Dec 17, 2024
7246ab4
add freshness
mirnawong1 Dec 17, 2024
4e51b03
Merge branch 'current' into update-trust-signals
mirnawong1 Dec 17, 2024
483c64f
Update data-health-signals.md
mirnawong1 Dec 17, 2024
6ce21f9
Update website/docs/docs/collaborate/data-health-signals.md
runleonarun Dec 18, 2024
8a4ceea
Merge branch 'current' into update-trust-signals
runleonarun Dec 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 8 additions & 56 deletions website/docs/docs/collaborate/explore-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Discover data with dbt Explorer"
sidebar_label: "Discover data with dbt Explorer"
description: "Learn about dbt Explorer and how to interact with it to understand, improve, and leverage your dbt projects."
image: /img/docs/collaborate/dbt-explorer/example-project-lineage-graph.png
pagination_next: "docs/collaborate/access-from-dbt-cloud"
pagination_next: "docs/collaborate/trust-signals"
pagination_prev: null
---

Expand Down Expand Up @@ -31,6 +31,7 @@ Navigate the dbt Explorer overview page to access your project's resources and m
- **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.
- **Model query history** — Use [model query history](/docs/collaborate/model-query-history) to track consumption queries on your models for deeper insights.
- **Auto-exposures** — [Set up and view auto-exposures](/docs/collaborate/auto-exposures) to automatically expose relevant data models from Tableau to enhance visibility.
- **Trust signal icons** — View the [trust signal icons](/docs/collaborate/trust-signals) for each resource to understand its health and performance.

<Lightbox src="/img/docs/collaborate/dbt-explorer/explorer-main-page.gif" width="100%" title="Access dbt Explorer from dbt Cloud by clicking Explore in the navigation."/>

Expand Down Expand Up @@ -162,61 +163,8 @@ Under the the **Models** option, you can filter on model properties (access or m

</Expandable>

<Expandable alt_header="Trust signals for resources" lifecycle="preview">

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.

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.

To access trust signals:
- Use the search function or click on **Models**, **Sources** or **Exposures** under the **Resource** tab.
- View the icons under the **Health** column.
- Hover over or click the trust signal to see detailed information.
- For sources, the trust signal also indicates the source freshness status.

<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-health.jpg" width="60%" title="View trust signals for your models."/>

<!-- commenting out until further iteration on the content

<Tabs>
<TabItem value="healthy" label="Healthy">
A resource is considered Healthy if it meets the following criteria:
- Ran all tests successfully
- Successfully built in its last run
- Has a description and tests configured
- Has been built in the past 30 days
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-healthy.png" title="Healthy trust signal icon"/>
</TabItem>

<TabItem value="caution" label="Caution">
Any of the following conditions can trigger a caution status:
- Successfully built in its last run
- Is missing a description
- Does not have any tests configured
- Has not been built in the past 30 day
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-caution.png" title="Caution trust signal icon"/>
</TabItem>

<TabItem value="degraded" label="Degraded">
A resource is considered Degraded if it meets any of the following criteria:
- Last run failed or source freshness error
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signals-degraded.jpg" width="35%" title="Degraded trust signal icon"/>
</TabItem>

<TabItem value="unknown" label="Unknown">
The Unknown trust signal icon indicates that:
- Health information is unknown because the resource hasn't been run recently.
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-unknown.png" title="Unknown trust signal icon"/>

</TabItem>
</Tabs>

-->

</Expandable>

### Example of keyword search
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.
Example of results from searching on the keyword `customers` and applying the filters models, description, and code. [Trust signal icons](/docs/collaborate/trust-signals) are visible to the right of the model name in the search results.

<Lightbox src="/img/docs/collaborate/dbt-explorer/example-keyword-search.png" width="100%" title="Example of keyword search" />

Expand All @@ -225,6 +173,7 @@ Example of results from searching on the keyword `customers` and applying the fi
From the sidebar, you can browse your project's resources, its file tree, and the database.

- **Resources** tab &mdash; 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).
- [Trust signal icons](/docs/collaborate/trust-signals) are visible to the right of the resource name under the **Health** column.
- **File Tree** tab &mdash; All resources in the project organized by the file in which they are defined. This mirrors the file tree in your dbt project repository.
- **Database** tab &mdash; 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.

Expand Down Expand Up @@ -253,7 +202,7 @@ In the upper right corner of the resource details page, you can:

<Expandable alt_header="What details are available for a model?">

- Trust signal icon &mdash; 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.
- **Trust signals** &mdash; [Trust signal icons](/docs/collaborate/trust-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.
- **Status bar** (below the page title) &mdash; 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.
- **General** tab includes:
- **Lineage** graph &mdash; 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.
Expand All @@ -270,6 +219,7 @@ In the upper right corner of the resource details page, you can:
<Expandable alt_header="What details are available for an exposure?">

- **Status bar** (below the page title) &mdash; Information on the last time the exposure was updated.
- **Trust signals** &mdash; [Trust signal icons](/docs/collaborate/trust-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.
- **General** tab includes:
- **Data health** &mdash; The status on data freshness and data quality.
- **Status** section &mdash; The status on data freshness and data quality.
Expand Down Expand Up @@ -303,6 +253,7 @@ Example of the Tests view:
<Expandable alt_header="What details are available for each source table within a source collection?">

- **Status bar** (below the page title) &mdash; Information on the last time the source was updated and the number of tables the source uses.
- **Trust signals** &mdash; [Trust signal icons](/docs/collaborate/trust-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.
- **General** tab includes:
- **Lineage** graph &mdash; 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.
- **Description** section &mdash; A description of the source.
Expand All @@ -323,6 +274,7 @@ Example of the details view for the model `customers`:<br /> <Lightbox src="/img

</DocCarousel>


## Staging environment

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.
Expand Down
87 changes: 87 additions & 0 deletions website/docs/docs/collaborate/trust-signals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: "Trust signals"
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
sidebar_label: "Trust signals"
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
id: trust-signals
description: "Learn about dbt Explorer and how to interact with it to understand, improve, and leverage your dbt projects."
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
image: /img/docs/collaborate/dbt-explorer/trust-signal-health.jpg
---

# Trust signals <Lifecycle status="preview" />

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**, or **Unknown**.

- Supported resources are models, sources, and exposures.
- For accurate health data, ensure the resource is up-to-date and had a recent job run.
- Each trust signal icon reflects key data health components, such as test success status, missing resource descriptions, missing tests, absence of builds in 30-day windows, [and more](#trust-signal-criteria)

<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-health.jpg" width="55%" title="View trust signals for your models."/>

## Access trust signals

Access trust signal icons in the following places:
- Search function or click on **Models**, **Sources** or **Exposures** under the **Resource** tab.
- For sources, the trust signal also indicates the source freshness status.
- View the icons under the **Health** column in [each resource's details page](#view-resource-details). Hover over or click the trust signal to view detailed information.
- Public models tables under the **Health** column.
- DAG lineage graph
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved


<Lightbox src="/img/docs/collaborate/dbt-explorer/icons-trust-signal.gif" width="95%" title="Access trust signal icons in multiple places in dbt Explorer."/>

## Trust 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:

| **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 />&nbsp;&nbsp;&nbsp;&nbsp;- Has a freshness check configured<br />&nbsp;&nbsp;&nbsp;&nbsp;- Freshness check ran in the past 30 days<br />&nbsp;&nbsp;&nbsp;&nbsp;- 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 />&nbsp;&nbsp;&nbsp;&nbsp;- Freshness check hasn’t run in the past 30 days<br />&nbsp;&nbsp;&nbsp;&nbsp;- Freshness check returned an error |
| ⚪ **Unknown** | - Unable to determine health of resource; ingestion hasn't run |
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

</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; ingestion has not run |

</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 |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

are these still TBD?
Screenshot 2024-12-09 at 15 10 09

Copy link
Contributor

Choose a reason for hiding this comment

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

Let me check!

Copy link
Member

Choose a reason for hiding this comment

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

Yes, this is still TBD. This can be added in once META-4025 is done

| 🟡 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>

<TabItem value="source-collection" label="Source collection health">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rpourzand @jcserv - what does 'source collection health' mean here and what's the diff between this and sources?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is just specific to sources?

Copy link
Contributor

@rpourzand rpourzand Dec 9, 2024

Choose a reason for hiding this comment

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

Source collections represent multiple sources, all mapping to different tables. We aggregate the information across the source.

@jcserv we don't actually show source collection health signal so I wonder if we even need this yet? We should file a backlog task to show this in the app though.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, this should not be added to the docs yet until META-3973/3971 are completed


The health state of a source collection is determined by the following criteria:

Functions as an aggregate of underlying sources
Copy link
Contributor Author

Choose a reason for hiding this comment

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

what does this mean?

Functions as an aggregate of underlying sources

Copy link
Contributor

Choose a reason for hiding this comment

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

If we did show it, we are essentially just aggregating all the respective sources in the source collection


| **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>
4 changes: 2 additions & 2 deletions website/docs/docs/dbt-versions/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo
- **New**: The [`hard_deletes`](/reference/resource-configs/hard-deletes) config gives you more control on how to handle deleted rows from the source. Supported options are `ignore` (default), `invalidate` (replaces the legacy `invalidate_hard_deletes=true`), and `new_record`. Note that `new_record` will create a new metadata column in the snapshot table.

## November 2024
- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing resources. To view trust signal icons, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/explore-projects#trust-signals-for-resources) for more info.
- **Enhancement**: Trust signal icons in dbt Explorer are now available for Exposures, providing a quick view of data health while browsing resources. To view trust signal icons, go to dbt Explorer and click **Exposures** under the **Resource** tab. Refer to [Trust signal for resources](/docs/collaborate/trust-signals) for more info.
- **Bug**: Identified and fixed an error with Semantic Layer queries that take longer than 10 minutes to complete.
- **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored.
- **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies).
Expand Down Expand Up @@ -87,7 +87,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo
- **Enhancement**: In the "Latest" release track in dbt Cloud, snapshots defined in SQL files can now use `config` defined in `schema.yml` YAML files. This update resolves the previous limitation that required snapshot properties to be defined exclusively in `dbt_project.yml` and/or a `config()` block within the SQL file. This will also be released in dbt Core 1.9.
- **New**: In the "Latest" release track in dbt Cloud, the `snapshot_meta_column_names` config allows for customizing the snapshot metadata columns. This feature allows an organization to align these automatically-generated column names with their conventions, and will be included in the upcoming dbt Core 1.9 release.
- **Enhancement**: the "Latest" release track in dbt Cloud infers a model's `primary_key` based on configured data tests and/or constraints within `manifest.json`. The inferred `primary_key` is visible in dbt Explorer and utilized by the dbt Cloud [compare changes](/docs/deploy/run-visibility#compare-tab) feature. This will also be released in dbt Core 1.9. Read about the [order dbt infers columns can be used as primary key of a model](https://github.com/dbt-labs/dbt-core/blob/7940ad5c7858ff11ef100260a372f2f06a86e71f/core/dbt/contracts/graph/nodes.py#L534-L541).
- **New:** dbt Explorer now includes trust signal icons, which is currently available as a [Preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Trust signals offer a quick, at-a-glance view of data health when browsing your dbt models in Explorer. These icons indicate whether a model is **Healthy**, **Caution**, **Degraded**, or **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. Refer to [Trust signals](/docs/collaborate/explore-projects#trust-signals-for-resources) for more information.
- **New:** dbt Explorer now includes trust signal icons, which is currently available as a [Preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Trust signals offer a quick, at-a-glance view of data health when browsing your dbt models in Explorer. These icons indicate whether a model is **Healthy**, **Caution**, **Degraded**, or **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run. Refer to [Trust signals](/docs/collaborate/trust-signals) for more information.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- **New:** Auto exposures are now available in Preview in dbt Cloud. Auto-exposures helps users understand how their models are used in downstream analytics tools to inform investments and reduce incidents. It imports and auto-generates exposures based on Tableau dashboards, with user-defined curation. To learn more, refer to [Auto exposures](/docs/collaborate/auto-exposures).


Expand Down
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,7 @@ const sidebarSettings = {
link: { type: "doc", id: "docs/collaborate/explore-projects" },
items: [
"docs/collaborate/explore-projects",
"docs/collaborate/trust-signals",
"docs/collaborate/access-from-dbt-cloud",
"docs/collaborate/column-level-lineage",
"docs/collaborate/model-performance",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading