-
Notifications
You must be signed in to change notification settings - Fork 34
[DOCS-1700] Update docs for automation history #1803
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
27
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 6 commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
5413e4c
[DOCS-1700] Update docs for automation history
mdlinville 5da67c0
Tony's feedback
mdlinville 16d83ed
Update models/automations/view-automation-history.mdx
mdlinville 00686cf
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville e89b5d1
Restructure Automation Events page to be less bifurcated
mdlinville d6235c8
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville b3f6979
Copyedits
mdlinville 23d2c89
Update models/automations/view-automation-history.mdx
mdlinville 8b7be23
Remove reference to now deleted image
mdlinville e66b146
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville a004f44
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville e919ec5
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 94a75c9
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 7d08e81
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville a582a02
Copyedits
mdlinville 7097e70
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 0b45bb0
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville 7766bcc
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville bec7347
Apply suggestions from code review
mdlinville b5cc9e8
Force public API filenames to lowercase
mdlinville 3918e61
Merge remote-tracking branch 'origin/main' into cursor/update-docs-fo…
mdlinville a0756dd
Further adjustments to events / scopes page
mdlinville e69c0a4
Corrections
mdlinville d3b162b
Merge remote-tracking branch 'origin/main' into cursor/update-docs-fo…
mdlinville 71d101b
Reduce the detail in the overview
mdlinville 9167fad
Revert unrelated overview updates
mdlinville 5aece55
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
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
Binary file not shown.
Binary file not shown.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| --- | ||
| title: View an automation's history | ||
| --- | ||
|
|
||
| <Note> | ||
| This feature requires an Enterprise license. It is available only for: | ||
| - W&B Multi-tenant Cloud | ||
| - W&B Dedicated Cloud | ||
| - W&B Self-Managed v0.75.0+ | ||
| </Note> | ||
|
|
||
| This page describes how to view and understand the execution history of your W&B [automations](/models/automations) and track what triggered an automation, what actions were taken, and whether they succeeded or failed. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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: | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### From the Automations tab | ||
|
|
||
| <Tabs> | ||
| <Tab title="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 title="Project"> | ||
| 1. Navigate to your project from the W&B home page or by using the project selector. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Click the **Automations** tab in the project navigation bar (located alongside Overview, Workspace, Runs, etc.). The project's automations display. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - 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. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### From the automation details page | ||
|
|
||
| 1. Navigate to your project or registry. | ||
| 1. Click the **Automations** tab. | ||
| 1. Click on an automation name to open its details page. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. The **Execution history** section shows all executions for this specific automation. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### From a specific entity | ||
|
|
||
| <Tabs> | ||
| <Tab title="Registry"> | ||
| 1. Navigate to your registry. | ||
| 1. Select a specific registered model or artifact collection. | ||
| 1. Click the **...** menu in the top right. | ||
| 1. Select **View history** to see all automation executions related to this entity. | ||
| </Tab> | ||
| <Tab title="Project"> | ||
| 1. Navigate to your project. | ||
| 1. Select a specific run or artifact. | ||
| 1. In the Overview tab, look for the **Triggered automations** section. | ||
| 1. Click on any listed automation to view its execution details. | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Understanding execution details | ||
|
|
||
| ### Execution status | ||
|
|
||
| Each automation execution has one of the following statuses: | ||
|
|
||
| - **Finished**: The automation completed all actions successfully. | ||
| - **Failed**: The automation encountered an error and could not complete. | ||
| - **Pending**: The automation is queued for execution. | ||
|
|
||
|
|
||
| ### Detailed execution information | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Click on any execution in the history to view: | ||
|
|
||
| - **Event details**: The specific event that triggered the automation, including: | ||
| - Event type (e.g., "New artifact version", "Run completed") | ||
| - Entity information (run ID, artifact name, etc.) | ||
| - User who triggered the event (if applicable) | ||
|
|
||
| - **Action details**: Information about what the automation attempted to do: | ||
| - Action type (Slack notification or webhook) | ||
| - Target (Slack channel or webhook URL) | ||
| - Payload sent (for webhooks) | ||
|
|
||
| - **Result information**: | ||
| - Response status (for webhooks) | ||
| - Any error messages or stack traces (for failed executions) | ||
|
|
||
| ## Searching | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| To find an automation execution, you can search by automation name, or you can sort the list of executions by any column. | ||
|
|
||
| ## Troubleshooting failed executions | ||
|
|
||
| When an automation fails, the execution history provides debugging information: | ||
|
|
||
|
|
||
| ### Debugging steps | ||
|
|
||
| 1. Click on the failed execution to view details. | ||
| 1. Review the error message and stack trace. | ||
| 1. Check the event and action configuration. | ||
| 1. Verify that any required secrets are properly configured. | ||
| 1. For webhooks, confirm the endpoint is accessible and accepting requests. | ||
| 1. For Slack notifications, verify the channel exists and the bot has permission to post. | ||
mdlinville marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Next steps | ||
mdlinville marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - [Create an automation](/models/automations/create-automations) | ||
| - Learn about [Automation events and scopes](/models/automations/automation-events) | ||
| - [Create a secret](/platform/secrets) | ||
Oops, something went wrong.
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.