Skip to content
Open
Show file tree
Hide file tree
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 Aug 27, 2025
72f13cc
Tony's feedback
mdlinville Aug 29, 2025
fccc2b6
More Tony's feedback
mdlinville Aug 29, 2025
68193c4
Update content/en/guides/core/automations/view-automation-history.md
mdlinville Aug 29, 2025
05bcebb
Update content/en/guides/core/automations/view-automation-history.md
mdlinville Aug 29, 2025
bf19387
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Aug 29, 2025
8b40ee4
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Sep 2, 2025
7e3f5a3
Apply suggestions from code review
mdlinville Sep 2, 2025
5a97746
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Sep 3, 2025
a7633d0
Merge remote-tracking branch 'origin/main' into cursor/update-docs-fo…
mdlinville Sep 12, 2025
e77a7ee
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Sep 12, 2025
204d87c
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Sep 15, 2025
4eb0ecc
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Sep 24, 2025
0118a76
Merge remote-tracking branch 'origin/cursor/update-docs-for-automatio…
mdlinville Sep 24, 2025
7b43bec
Remove hallucinated details
mdlinville Sep 24, 2025
8fcd70c
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Sep 24, 2025
22f7d28
Merge branch 'main' into cursor/update-docs-for-automation-history-81f2
mdlinville Oct 6, 2025
8bae807
Merge remote-tracking branch 'origin/main' into cursor/update-docs-fo…
mdlinville Oct 10, 2025
784ac9e
Tony's feedback
mdlinville Oct 10, 2025
3834583
Apply suggestions from code review
mdlinville Oct 10, 2025
fc35254
Merge remote-tracking branch 'origin/cursor/update-docs-for-automatio…
mdlinville Oct 10, 2025
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
3 changes: 2 additions & 1 deletion content/en/guides/core/automations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,14 @@ To [create an automation]({{< relref "create-automations/" >}}), you:
1. If required, configure [secrets]({{< relref "/guides/core/secrets.md" >}}) for sensitive strings the automation requires, such as access tokens, passwords, or sensitive configuration details. Secrets are defined in your **Team Settings**. Secrets are most commonly used in webhook automations to securely pass credentials or tokens to the webhook's external service without exposing it in plain text or hard-coding it in the webhook's payload.
1. Configure team-level webhook or Slack integrations to authorize W&B to post to Slack or run the webhook on your behalf. A single automation action (webhook or Slack notification) can be used by multiple automations. These actions are defined in your **Team Settings**.
1. In the project or registry, create the automation:
1. Define the [event]({{< relref "#automation-events" >}}) to watch for, such as when a new artifact version is added.
1. Define the [event]({{< relref "#automation-events" >}}) to watch for, such as when a new artifact version is added.
1. Define the action to take when the event occurs (posting to a Slack channel or running a webhook). For a webhook, specify a secret to use for the access token and/or a secret to send with the payload, if required.

## Limitations
[Run metric automations]({{< relref "automation-events.md#run-metrics-events">}}) are currently supported only in [W&B Multi-tenant Cloud]({{< relref "/guides/hosting/#wb-multi-tenant-cloud" >}}).

## Next steps
- [Create an automation]({{< relref "create-automations/" >}}).
- [View an automation's history]({{< relref "view-automation-history.md" >}}) to track executions and debug issues.
- Learn about [Automation events and scopes]({{< relref "automation-events.md" >}}).
- [Create a secret]({{< relref "/guides/core/secrets.md" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ cascade:
This page gives an overview of creating and managing W&B [automations]({{< relref "/guides/core/automations/">}}). For more detailed instructions, refer to [Create a Slack automation]({{< relref "/guides/core/automations/create-automations/slack.md" >}}) or [Create a webhook automation]({{< relref "/guides/core/automations/create-automations/webhook.md" >}}).

{{% alert %}}
Looking for companion tutorials for automations?
Looking for companion tutorials for automations?
- [Learn to automatically triggers a Github Action for model evaluation and deployment](https://wandb.ai/wandb/wandb-model-cicd/reports/Model-CI-CD-with-W-B--Vmlldzo0OTcwNDQw).
- [Watch a video demonstrating automatically deploying a model to a Sagemaker endpoint](https://www.youtube.com/watch?v=s5CMj_w3DaQ).
- [Watch a video series introducing automations](https://youtube.com/playlist?list=PLD80i8An1OEGECFPgY-HPCNjXgGu-qGO6&feature=shared).
Expand All @@ -31,7 +31,7 @@ Looking for companion tutorials for automations?
Create an automation from the project or registry's **Automations** tab. At a high level, to create an automation, follow these steps:

1. If necessary, [create a W&B secret]({{< relref "/guides/core/secrets.md" >}}) for each sensitive string required by the automation, such as an access token, password, or SSH key. Secrets are defined in your **Team Settings**. Secrets are most commonly used in webhook automations.
1. Configure the webhook or Slack integration to authorize W&B to post to Slack or run the webhook on your behalf. A single webhook or Slack integration can be used by multiple automations. These actions are defined in your **Team Settings**.
1. Configure the webhook or Slack integration to authorize W&B to post to Slack or run the webhook on your behalf. A single webhook or Slack integration can be used by multiple automations. These actions are defined in your **Team Settings**.
1. In the project or registry, create the automation, which specifies the event to watch for and the action to take (such as posting to Slack or running a webhook). When you create a webhook automation, you configure the payload it sends.

Or, from a line plot in the workspace, you can quickly create a [run metric automation]({{< relref "/guides/core/automations/automation-events.md#run-events" >}}) for the metric it shows:
Expand All @@ -50,6 +50,7 @@ For details, refer to:
View and manage automations from a project or registry's **Automations** tab.

- To view an automation's details, click its name.
- To view an automation's execution history, click its name and select the **History** tab. See [View an automation's history]({{< relref "/guides/core/automations/view-automation-history.md" >}}) for details.
- To edit an automation, click its action `...` menu, then click **Edit automation**.
- To delete an automation, click its action `...` menu, then click **Delete automation**.

Expand Down
104 changes: 104 additions & 0 deletions content/en/guides/core/automations/view-automation-history.md
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

### 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" >}})