Skip to content

Document sourceCodeLocation facet requirement for dbt Core CI/CD #38327

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.

Sign up for GitHub

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

Open
himakolavennu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document sourceCodeLocation facet requirement for dbt Core CI/CD #38327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions content/en/data_observability/cicd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ Impact lineage generates a graph of the downstream assets that may be affected b

Drift detection compares the current state of your data on the branch to a baseline and flags any deviations. For Datadog to understand which models ran as part of a CI pipeline, you must send OpenLineage events from your CI job. Datadog uses these events as triggers for drift detection checks. See the [OpenLineage setup documentation][6] for instructions on how to set up OpenLineage.

For **dbt Core**, drift detection also requires the pull request number to be attached to your OpenLineage events through the `sourceCodeLocation` facet. This requires `openlineage-dbt` version 1.46.0 or later and the `OPENLINEAGE__FACETS__SOURCE_CODE_LOCATION__DISABLED=false` environment variable. See [Set the environment variables][7].

##### General settings

| Setting | Description |
Expand Down
13 changes: 13 additions & 0 deletions content/en/data_observability/jobs_monitoring/dbt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,18 @@ Follow the steps below to connect dbt Core to Datadog.

# Optional, for debugging purposes
export OPENLINEAGE_CLIENT_LOGGING=DEBUG

# Required for CI/CD Drift Detection (requires openlineage-dbt >= 1.46.0).
# Attaches the sourceCodeLocation facet (repository URL, commit SHA, and pull
# request number) so Datadog can associate the dbt run with a pull request.
# Disabled by default; not required for job monitoring alone.
export OPENLINEAGE__FACETS__SOURCE_CODE_LOCATION__DISABLED=false
```

For [CI/CD checks][8], the pull request number is detected automatically when the run exposes `GITHUB_REF` (GitHub Actions workflows triggered by a pull request) or `CI_MERGE_REQUEST_IID` (GitLab merge request pipelines). If neither variable is present, set the pull request number explicitly:

```shell
export OPENLINEAGE__FACETS__SOURCE_CODE_LOCATION__PULL_REQUEST_NUMBER=<PR_NUMBER>
```

## Update the dbt invocation
Expand Down Expand Up @@ -148,6 +160,7 @@ After your next dbt job run, you should start seeing job run and lineage data in
[5]: https://openlineage.io/docs/client/python/#predefined-datadog-sites
[6]: https://app.datadoghq.com/data-obs/catalog?integration=dbt
[7]: https://docs.getdbt.com/docs/running-a-dbt-project/run-your-dbt-projects
[8]: /data_observability/cicd/

{{% /tab %}}
{{< /tabs >}}
Expand Down
Loading