Skip to content

Clarify CI Job Descriptions #38132

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

Draft
spiicy-sauce wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −15
Draft

Clarify CI Job Descriptions #38132

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
30 changes: 15 additions & 15 deletions content/en/data_observability/cicd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,34 +70,34 @@

##### General settings

| Setting | Description |
| - | - |
| Setting | Description |
| ---------------------------------- | -------------------------------------------------------------------- |
| `Run on Draft Pull/Merge Requests` | Enable this option to run the check on draft pull or merge requests. |

#### Drift Detection

Drift detection compares the current state of your data 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. See the [OpenLineage setup documentation][6] for more information.
Drift detection compares the branch state of your data to a baseline and flags any deviations. For Datadog to understand which models ran as part of a CI pipeline, you _must_ send Open Lineage 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 Open Lineage.

Check notice on line 79 in content/en/data_observability/cicd.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

##### General settings

| Setting | Description |
| - | - |
| `Run on Draft Pull/Merge Requests` | Enable this option to run the check on draft pull or merge requests. |
| `Threshold` | The threshold for drift detection (for example, `0.1` for 10% drift). If a metric exceeds this threshold, it shows up as a warning in the check results. |
| `Downstream Checks` | When a dbt model changes, drift detection checks are generated for it and any downstream dbt models. This setting controls how far downstream the checks run. |
| Setting | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Run on Draft Pull/Merge Requests` | Enable this option to run the check on draft pull or merge requests. |
| `Threshold` | The threshold for drift detection (for example, `0.1` for 10% drift). If a metric exceeds this threshold, it shows up as a warning in the check results. |
| `Downstream Checks` | When a dbt model changes, drift detection checks are generated for it and any downstream dbt models. This setting controls how far downstream the checks run. |

##### dbt Cloud

| Setting | Description |
| - | - |
| `CI Job URL` | The locator for your dbt Cloud CI job. These typically look like `https://cloud.getdbt.com/...`. |
| Setting | Description |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CI Job URL` | The locator for your dbt Cloud CI job: this is the job that's triggered by pull requests, materializes dbt models for CI, and sends Open Lineage events to Datadog. These typically look like `https://cloud.getdbt.com/...`. |

##### dbt Core

| Setting | Description |
| - | - |
| `CI Job Name` | The name of the job that runs whenever you update a pull or merge request and materializes your dbt models. This may be the same as the job you selected earlier, but you must specify it again here. |
| `CI Job Namespace` | The `OPENLINEAGE_NAMESPACE` variable specified when running the job. See [Set the environment variables][7]. If you don't set this variable when sending OpenLineage events, you don't need to specify it here. |
| Setting | Description |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CI Job Name` | The name of the job that's triggered by pull requests, materializes dbt models for CI, and sends Open Lineage events to Datadog. |
| `CI Job Namespace` | The `OPENLINEAGE_NAMESPACE` variable specified when sending Open Lineage from the specified above job. See [Set the environment variables][7]. If you don't set this variable when sending Open Lineage events, you don't need to specify it here. |

## Further reading

Expand Down
Loading