Skip to content

Commit

Permalink
[docs] Data freshness guide (#23937)
Browse files Browse the repository at this point in the history
## Summary & Motivation

## How I Tested These Changes

## Changelog [New | Bug | Docs]
NOCHANGELOG
---------

Co-authored-by: Erin Cochran <[email protected]>
  • Loading branch information
clairelin135 and erinkcochran87 authored Aug 28, 2024
1 parent ef1da09 commit c501b3d
Show file tree
Hide file tree
Showing 7 changed files with 139 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,49 @@
---
title: "Test for data freshness"
title: "Check for data freshness"
sidebar_position: 20
---
---
Freshness checks provide a way to identify data assets that are overdue for an update.

This guide covers how to construct freshness checks for materializable [assets](/todo) and [external assets](/todo).

<details>
<summary>Prerequisites</summary>

To follow the steps in this guide, you'll need:

- Familiarity with [assets](/todo)
- Familiarity with [asset checks](/todo)

</details>

## Check data freshness for materializable assets

The example below defines a freshness check on an asset that fails if the asset's latest materialization occurred more than one hour before the current time.

Defining a schedule or sensor is required to ensure the freshness check executes. If the check only runs after the asset has been materialized, the check won't be able to detect the times materialization fails.

<CodeExample filePath="guides/data-assets/quality-testing/freshness-checks/materializable-asset-freshness-check.py" language="python" title="Check data freshness for materializable assets" />

## Check data freshness for external assets

To run freshness checks on external assets, the checks need to know when the external assets were last updated. Emitting these update timestamps as values for the [`dagster/last_updated_timestamp`](/todo) observation metadata key allows Dagster to calculate whether the asset is overdue.

The example below defines a freshness check and adds a schedule to run the check periodically.

<CodeExample filePath="guides/data-assets/quality-testing/freshness-checks/external-asset-freshness-check.py" language="python" title="Check data freshness for external assets" />

### Use anomaly detection to test data freshness (Dagster+ Pro)

Instead of applying policies on an asset-by-asset basis, Dagster+ Pro users can take advantage of a time series anomaly detection model to determine if data is arriving later than expected.

<CodeExample filePath="guides/data-assets/quality-testing/freshness-checks/anomaly-detection.py" language="python" title="Use anomaly detection to detect overdue assets" />

:::note
If the asset hasn't been updated enough times, the check will pass with a message indicating that more data is needed to detect anomalies.
:::

## Next steps

- Explore more [asset checks](/todo)
- Explore how to [raise alerts when assets are overdue](/todo) (Dagster+ Pro)
- Explore more about [anomaly detection](/todo) (Dagster+ Pro)
1 change: 1 addition & 0 deletions docs/vale/styles/config/vocabularies/Dagster/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Declarative Automation
dagster-.*
gRPC
[Mm]aterializations
[Mm]aterializable
[Mm]emoization
REST API
[Ss]ubprocess
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
from dagster_cloud.anomaly_detection import build_anomaly_detection_freshness_checks

import dagster as dg


@dg.observable_source_asset
def hourly_sales(): ...


freshness_checks = build_anomaly_detection_freshness_checks(
assets=[hourly_sales], params=None
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
from datetime import timedelta

import dagster_snowflake as dg_snowflake

import dagster as dg


@dg.observable_source_asset
def hourly_sales(snowflake: dg_snowflake.SnowflakeResource):
table_name = "hourly_sales"
with snowflake.get_connection() as conn:
freshness_results = dg_snowflake.fetch_last_updated_timestamps(
snowflake_connection=conn.cursor(),
tables=[table_name],
schema="PUBLIC",
)
return dg.ObserveResult(
asset_key=table_name,
metadata={
"dagster/last_updated_timestamp": dg.MetadataValue.timestamp(
freshness_results[table_name]
)
},
)


freshness_check_schedule = dg.ScheduleDefinition(
job=dg.define_asset_job(
"hourly_sales_observation_job",
selection=dg.AssetSelection.keys("hourly_sales"),
),
# Runs every minute. Usually, a much less frequent cadence is necessary,
# but a short cadence makes it easier to play around with this example.
cron_schedule="* * * * *",
)


hourly_sales_freshness_check = dg.build_last_update_freshness_checks(
assets=[hourly_sales],
lower_bound_delta=timedelta(hours=1),
)


defs = dg.Definitions(
assets=[hourly_sales],
asset_checks=hourly_sales_freshness_check,
schedules=[freshness_check_schedule],
resources={
"snowflake": dg_snowflake.SnowflakeResource(
user=dg.EnvVar("SNOWFLAKE_USER"),
account=dg.EnvVar("SNOWFLAKE_ACCOUNT"),
password=dg.EnvVar("SNOWFLAKE_PASSWORD"),
)
},
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
from datetime import timedelta

import dagster as dg


@dg.asset
def hourly_sales(context: dg.AssetExecutionContext):
context.log.info("Fetching and emitting hourly sales data")
...


hourly_sales_freshness_check = dg.build_last_update_freshness_checks(
assets=[hourly_sales], lower_bound_delta=timedelta(hours=1)
)
freshness_checks_sensor = dg.build_sensor_for_freshness_checks(
freshness_checks=hourly_sales_freshness_check
)
defs = dg.Definitions(
assets=[hourly_sales],
asset_checks=hourly_sales_freshness_check,
sensors=[freshness_checks_sensor],
)
2 changes: 1 addition & 1 deletion examples/docs_beta_snippets/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
],
packages=find_packages(exclude=["test"]),
install_requires=["dagster-cloud", "dagster-aws"],
extras_require={"test": ["pytest", "mock", "path"]},
extras_require={"test": ["pytest", "mock", "path", "dagster_snowflake"]},
)
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from airflow.operators.bash import BashOperator
from dagster_airlift.in_airflow import mark_as_dagster_migrating
from dagster_airlift.migration_state import load_migration_state_from_yaml

from dbt_example.shared.lakehouse_utils import load_csv_to_duckdb
from dbt_example.shared.load_iris import CSV_PATH, DB_PATH, IRIS_COLUMNS

Expand Down

2 comments on commit c501b3d

@github-actions
Copy link

@github-actions github-actions bot commented on c501b3d Aug 28, 2024

Choose a reason for hiding this comment

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

Deploy preview for dagster-docs-beta ready!

✅ Preview
https://dagster-docs-beta-hr5cqbdaa-elementl.vercel.app
https://dagster-docs-beta.dagster-docs.io

Built with commit c501b3d.
This pull request is being automatically deployed with vercel-action

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for dagster-docs ready!

✅ Preview
https://dagster-docs-rb6j8aaap-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit c501b3d.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.