Skip to content

Commit

Permalink
Retry jobs (#4213)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Add docs and release notes for Retry jobs:
- Add new Retry jobs page
- Update sidebar with new page under Deploy > Monitor jobs and alerts 
- Add release note 



## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] Needs review from product team
- [ ] Needs this PR https://github.com/dbt-labs/cloud-ui/pull/2508 to
merge

Adding new pages (delete if not applicable):
- [x] Add page to `website/sidebars.js`
- [x] Provide a unique filename for the new page
  • Loading branch information
nghi-ly authored Oct 9, 2023
2 parents d4fbdbe + e27dd55 commit cabb074
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 0 deletions.
1 change: 1 addition & 0 deletions website/docs/docs/collaborate/git-version-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ When you develop in the command line interface (CLI) or Cloud integrated develo
- [Merge conflicts](/docs/collaborate/git/merge-conflicts)
- [Connect to GitHub](/docs/cloud/git/connect-github)
- [Connect to GitLab](/docs/cloud/git/connect-gitlab)
- [Connect to Azure DevOps](/docs/cloud/git/connect-azure-devops)
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Enhancement: Native support for the dbt retry command"
description: "October 2023: Rerun errored jobs from start or from the failure point"
sidebar_label: "Enhancement: Support for dbt retry"
tags: [Oct-2023, Scheduler]
date: 2023-10-06
sidebar_position: 10
---

Previously in dbt Cloud, you could only rerun an errored job from start but now you can also rerun it from its point of failure.

You can view which job failed to complete successully, which command failed in the run step, and choose how to rerun it. To learn more, refer to [Retry jobs](/docs/deploy/retry-jobs).


<Lightbox src="/img/docs/deploy/native-retry.gif" width="70%" title="Example of the Rerun options in dbt Cloud"/>
32 changes: 32 additions & 0 deletions website/docs/docs/deploy/retry-jobs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Retry your dbt jobs"
sidebar_label: "Retry jobs"
description: "Rerun your errored jobs from start or the failure point."
---

If your dbt job run completed with a status of `result:error` , you can rerun it from start or from the point of failure in dbt Cloud.

## Prerequisites

- You have a [dbt Cloud account](https://www.getdbt.com/signup).
- You must be using [dbt version](/docs/dbt-versions/upgrade-core-in-cloud) 1.6 or newer.
- The most recent run of the job hasn't completed successfully. The latest status of the run is `error`.
- The job command that failed in the run must be one that supports the [retry command](/reference/commands/retry).

## Rerun an errored job

1. Select **Deploy** from the top navigation bar and choose **Run History.**
2. Choose the job run that has errored.
3. In the **Run Summary** tab on the job’s **Run** page, expand the run step that failed. An :x: denotes the failed step.
4. Examine the error message and determine how to fix it. After you have made your changes, save and commit them to your [Git repo](/docs/collaborate/git-version-control).
5. Return to your job’s **Run** page. In the upper right corner, click **Rerun** and choose **Rerun from start** or **Rerun from failure**.

If you chose to rerun from the failure point, a **Rerun failed steps** modal opens. The modal lists the run steps that will be invoked: the failed step and any skipped steps. To confirm these run steps, click **Rerun from failure**. The job reruns from the failed command in the previously failed run. A banner at the top of the **Run Summary** tab captures this with the message, "This run resumed execution from last failed step".

<Lightbox src="/img/docs/deploy/native-retry.gif" width="70%" title="Example of the Rerun options in dbt Cloud"/>

## Related content

- [Run visibility](/docs/deploy/run-visibility)
- [Jobs](/docs/deploy/jobs)
- [Job commands](/docs/deploy/job-commands)
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ const sidebarSettings = {
link: { type: "doc", id: "docs/deploy/monitor-jobs" },
items: [
"docs/deploy/run-visibility",
"docs/deploy/retry-jobs",
"docs/deploy/job-notifications",
"docs/deploy/webhooks",
"docs/deploy/artifacts",
Expand Down
Binary file added website/static/img/docs/deploy/native-retry.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cabb074

Please sign in to comment.