-
Notifications
You must be signed in to change notification settings - Fork 32
[DOCS-1700] Update docs for automation history #1563
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
Open
mdlinville
wants to merge
21
commits into
main
Choose a base branch
from
cursor/update-docs-for-automation-history-81f2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
be89d34
[DOCS-1700] Add documentation for viewing automation execution history
mdlinville 72f13cc
Tony's feedback
mdlinville fccc2b6
More Tony's feedback
mdlinville 68193c4
Update content/en/guides/core/automations/view-automation-history.md
mdlinville 05bcebb
Update content/en/guides/core/automations/view-automation-history.md
mdlinville bf19387
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 8b40ee4
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 7e3f5a3
Apply suggestions from code review
mdlinville 5a97746
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville a7633d0
Merge remote-tracking branch 'origin/main' into cursor/update-docs-fo…
mdlinville e77a7ee
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 204d87c
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 4eb0ecc
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 0118a76
Merge remote-tracking branch 'origin/cursor/update-docs-for-automatio…
mdlinville 7b43bec
Remove hallucinated details
mdlinville 8fcd70c
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 22f7d28
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 8bae807
Merge remote-tracking branch 'origin/main' into cursor/update-docs-fo…
mdlinville 784ac9e
Tony's feedback
mdlinville 3834583
Apply suggestions from code review
mdlinville fc35254
Merge remote-tracking branch 'origin/cursor/update-docs-for-automatio…
mdlinville File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
content/en/guides/core/automations/view-automation-history.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| menu: | ||
| default: | ||
| identifier: view-automation-history | ||
| parent: automations | ||
| title: View an automation's history | ||
| weight: 3 | ||
| --- | ||
| {{% pageinfo color="info" %}} | ||
| {{< readfile file="/_includes/enterprise-cloud-only.md" >}} | ||
| {{% /pageinfo %}} | ||
|
|
||
| This page describes how to view and understand the execution history of your W&B [automations]({{< relref "/guides/core/automations/">}}) and track what triggered an automation, what actions were taken, and whether they succeeded or failed. | ||
|
|
||
| ## Overview | ||
|
|
||
| Each executed automation generates a record that includes: | ||
| - **Execution timestamp**: When the automation was triggered. | ||
| - **Triggering event**: The specific event triggered the automation. | ||
| - **Status**: The execution's status. See [Execution status](#execution-status). | ||
| - **Action details**: Information about what action was performed, such as notifying a Slack channel or running a webhook. | ||
| - **Result details**: Additional information, if any, about the final outcome of executing the automation, including the error for a failed execution. | ||
|
|
||
| ## View automation history | ||
|
|
||
| You can view automation history from multiple locations in the W&B interface: | ||
|
|
||
| ### From the Automations tab | ||
|
|
||
| {{< tabpane text=true >}} | ||
| {{% tab "Registry" %}} | ||
| 1. Navigate to your registry by clicking on **Registry** in the left sidebar. | ||
| 1. Select your registry from the list. | ||
| 1. Click **Automations** tab to view the registry's automations. In each row, the **Last execution** column shows when the automation last executed. | ||
| 1. In the **Automations history** tab, view all executions of the registry's automations in reverse chronological order, starting with the most recent execution. Each execution's metadata displays, including the event, action, and status. | ||
|
|
||
| {{% /tab %}} | ||
| {{% tab "Project" %}} | ||
| 1. Navigate to your project from the W&B home page or by using the project selector. | ||
| 1. Click the **Automations** tab in the project navigation bar (located alongside Overview, Workspace, Runs, etc.). The project's automations display. | ||
|
|
||
| - Find the automation you want to investigate. You can use the search bar to filter by automation name, and you can sort by the last triggered date to find recently executed automations. | ||
|
|
||
| - Click an automation name to open its details page. | ||
| 1. In the **History** tab, view all executions of the project's automations in reverse chronological order, starting with the most recent execution. Each execution's metadata displays, including the event, action, and status. | ||
|
|
||
| {{% /tab %}} | ||
| {{< /tabpane >}} | ||
|
|
||
| ### From the automation details page | ||
|
|
||
| When viewing an individual automation: | ||
|
|
||
| 1. Navigate to the automation details page by clicking an automation name from the Automations tab. | ||
| 1. Click the **History** tab to view a chronological list of all executions. | ||
| 1. Each entry shows: | ||
| - Execution date and time. | ||
| - Triggering event details. | ||
| - Status indicator (finished, failed, or pending). | ||
|
|
||
| ## Understanding execution details | ||
|
|
||
| Click any automation execution entry to view detailed information. The details shown depend on the execution's status. | ||
|
|
||
| ### Execution status | ||
|
|
||
| | Status | Description | | ||
| |:-------|:------------| | ||
| | **Finished** | A green checkmark indicates that the automation completed successfully. | | ||
| | **Failed** | A red X indicates that the automation terminated unsuccessfully for any reason. | | ||
| | **Pending** | A spinning arrow icon indicates that the automation is running. | | ||
|
|
||
| ### Execution metadata | ||
| Find detailed information about an execution by clicking its timestamp in the **Automation** or **Automation history** tab. | ||
|
|
||
| - **Overview**: The automation's name and scope, execution timestamp, and status. | ||
| - **Event details**: Details about what triggered the automation. For example, an alias was added to an artifact. | ||
| - **Action details**: Details about the automation's action, such as whether the automation notified a Slack channel or ran a webhook, as well as the payload that was sent. For webhooks, the full response body is included, but request and response headers are omitted. For a failed execution, an error summary and a detailed error message are included. | ||
| - **Result details**: Whether the automation failed, succeeded, or was cancelled. | ||
|
|
||
| ## Filter and search automation history | ||
| If you have a large number of automations or executions: | ||
| - Use the search bar to filter or search for automations by name. | ||
| - Click a column name to sort by that column. Click a second time to reverse the sort order. | ||
|
|
||
| ## Troubleshooting | ||
mdlinville marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Automation not appearing in history | ||
| If an expected automation execution doesn't appear: | ||
|
|
||
| - After an automation runs, it may take a few minutes to appear in the history. Refresh the page, then check the **Last checked** column to verify that the automation ran. | ||
| - Confirm that the automation is turned on. If the automation has a **Disabled** badge, it won't run unless you turn it back on using the [Automations API]({{< relref "/ref//python/automations/_index.md" >}}). | ||
| - Verify that the triggering event occurred or the triggering conditions were met. For example: | ||
| - For an automation triggered by artifact events, such as when an artifact has an alias applied, check the artifact's version history. | ||
| - For an automation triggered by a run metric, confirm that the run logged the expected metric values. | ||
| - For an automation with a filter, verify the details. For example, for a regex filter, verify the regex. | ||
|
|
||
| ### Missing execution details | ||
| Some execution details may be limited if the automation was created before history tracking was turned on. | ||
|
|
||
| ## Next steps | ||
| - Learn about [automation events]({{< relref "/guides/core/automations/automation-events.md" >}}) that can trigger automations | ||
| - [Create a Slack automation]({{< relref "/guides/core/automations/create-automations/slack.md" >}}) | ||
| - [Create a webhook automation]({{< relref "/guides/core/automations/create-automations/webhook.md" >}}) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.