Skip to content

Commit 3e42437

Browse files
authored
[DOCS-1700] Update docs for automation history (#1803)
1 parent c4ab5f5 commit 3e42437

File tree

8 files changed

+69
-23
lines changed

8 files changed

+69
-23
lines changed

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,7 @@
332332
"models/automations/create-automations/webhook"
333333
]
334334
},
335+
"models/automations/view-automation-history",
335336
"models/automations/automation-events"
336337
]
337338
},
206 Bytes
Loading
-17.3 KB
Binary file not shown.
-31.4 KB
Binary file not shown.

models/automations/automation-events.mdx

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,6 @@ An automation can start when a specific event occurs within a project or registr
1212
## Registry
1313
This section describes the scopes and events for an automation in a [Registry](/models/registry/).
1414

15-
1. Navigate to the W&B Registry at `https://wandb.ai/registry/`.
16-
1. Click the name of a registry, then view and create automations in the **Automations** tab.
17-
18-
<Frame>
19-
![Screenshot of the Registry Automations tab with an automation](/images/automations/registry_automations_tab.png)
20-
</Frame>
21-
22-
Learn more about [creating automations](/models/automations/create-automations/).
23-
2415
### Scopes
2516
A [Registry](/models/registry/) automation watches for the event taking place on any collection within a specific registry, including collections added in the future.
2617

@@ -32,22 +23,13 @@ A Registry automation can watch for these events:
3223
## Project
3324
This section describes the scopes and events for an automation in a [project](/models/track/project-page/).
3425

35-
1. Navigate to your W&B project on the W&B App at `https://wandb.ai/<team>/<project-name>`.
36-
1. View and create automations in the **Automations** tab.
37-
38-
<Frame>
39-
![Screenshot of the Project Automations tab with an automation](/images/automations/project_automations_tab.png)
40-
</Frame>
41-
42-
Learn more about [creating automations](/models/automations/create-automations/).
43-
4426
### Scopes
4527
A project-level automation watches for the event taking place on any collection in the project. Depending on the event you specify, you can further limit the scope of the automation.
4628

4729
### Artifact events
4830
This section describes the events related to an artifact that can trigger an automation.
4931

50-
- **A new version is added to an artifact**: Apply recurring actions to each version of an artifact. For example, start a training job when a new dataset artifact version is created. To limit the automation's scope, select a specific artifact in the **Artifact filter** field.
32+
- **A new version is added to an artifact**: Apply recurring actions to each version of an artifact. For example, start a training job when a new dataset artifact version is created.
5133
- **An artifact alias is added**: Trigger a specific step of your workflow when a new artifact version in a project has an alias applied that matches the **Alias regex** you specify. For example, run a series of downstream processing steps when an artifact has the `test-set-quality-check` alias applied, or run a workflow each time a new artifact version has the `latest` alias. Only one artifact version can have a given alias at a point in time.
5234
- **An artifact tag is added**: Trigger a specific step of your workflow when an artifact version in a project has a tag applied that matches the **Tag regex** you specify. For example, specify `^europe.*` to trigger a geo-specific workflow when a tag beginning with the string `europe` is added to an artifact version. Artifact tags are used for grouping and filtering, and a given tag can be assigned to multiple artifact versions simultaneously.
5335

models/automations/create-automations.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ For details, refer to:
4747
View and manage automations from a project or registry's **Automations** tab.
4848

4949
- To view an automation's details, click its name.
50+
- To view an automation's execution history, click its name and select the **History** tab. See [View an automation's history](/models/automations/view-automation-history) for details.
5051
- To edit an automation, click its action `...` menu, then click **Edit automation**.
5152
- To delete an automation, click its action `...` menu, then click **Delete automation**.
5253

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: View an automation's history
3+
---
4+
5+
<Note>
6+
This feature requires an Enterprise license. It is available only for:
7+
- W&B Multi-tenant Cloud
8+
- W&B Dedicated Cloud
9+
- W&B Self-Managed v0.75.0+
10+
</Note>
11+
12+
This page describes how to view and understand the execution history of your W&B [automations](/models/automations), including what triggered an automation, what actions were taken, and whether they succeeded or failed.
13+
14+
Each executed automation generates a record that includes:
15+
- **Execution timestamp**: When the automation was triggered.
16+
- **Triggering event**: The specific event triggered the automation.
17+
- **Status**: The execution's status. See [Execution status](#execution-status).
18+
- **Action details**: Information about what action was performed, such as notifying a Slack channel or running a webhook.
19+
- **Result details**: Additional information, if any, about the final outcome of executing the automation, including the error for a failed execution.
20+
21+
Based on your use case, select the **Registry** or **Project** tab for detailed instructions for viewing automation history.
22+
23+
<Tabs>
24+
<Tab title="Registry">
25+
1. Navigate to your registry by clicking on **Registry** in the left sidebar.
26+
1. Select your registry from the list.
27+
1. View the registry's automations in the **Automations** tab. Click the **Last execution** timestamp to view the execution history details. 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.
28+
1. View the registry's automation executions in reverse chronological order in the **Automations history** tab, including the event, action, and status. Click an execution timestamp to view details about a particular execution.
29+
30+
<Tip>If a collection has associated automation executions, the icon ![Collection automation execution symbol, a circle with a right-pointing arrow](/images/automations/collection-automation-execution-icon.png) displays, along with the number of associated executions.</Tip>
31+
</Tab>
32+
<Tab title="Project">
33+
1. Click the **Automations** tab in the left navigation. The project's automations display. Click the **Last execution** timestamp to view the execution history details. 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.
34+
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. Click an execution timestamp to view details about a particular execution.
35+
</Tab>
36+
</Tabs>
37+
38+
## Understanding execution details
39+
40+
Each automation execution has one of the following statuses:
41+
42+
- **Finished**: The automation completed all actions successfully.
43+
- **Failed**: The automation encountered an error and terminated unsuccessfully.
44+
- **Pending**: The automation is queued for execution.
45+
46+
Click on any execution in the history to view details:
47+
48+
- **Event details**: The specific event that triggered the automation, including:
49+
- Event type (e.g., "New artifact version", "Run completed")
50+
- Entity information (run ID, artifact name, etc.)
51+
- User who triggered the event (if applicable)
52+
53+
- **Action details**: Information about what the automation attempted to do:
54+
- Action type (Slack notification or webhook)
55+
- Target (Slack channel or webhook URL)
56+
- Payload sent (for webhooks)
57+
58+
- **Result information**:
59+
- Response status (for webhooks)
60+
- Any error messages or stack traces (for failed executions)
61+
62+
## Next steps
63+
64+
- [Create an automation](/models/automations/create-automations)
65+
- Learn about [Automation events and scopes](/models/automations/automation-events)
66+
- [Create a secret](/platform/secrets)

models/track/project-page.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,6 @@ Click the **Group** button above the table to group all rows by the value in a p
189189
## Automations tab
190190
Automate downstream actions for versioning artifacts. To create an automation, define trigger events and resulting actions. Actions include executing a webhook or launching a W&B job. For more information, see [Automations](/models/automations/).
191191

192-
<Frame>
193-
<img src="/images/automations/project_automations_tab.png" alt="Automation tab" />
194-
</Frame>
195-
196192
## Sweeps tab
197193

198194
Start a new [sweep](/models/sweeps/) from your project.

0 commit comments

Comments
 (0)