Skip to content

Commit 00de3bd

Browse files
authored
Merge pull request #215 from satti-hari-krishna-reddy/workflow-docs
Improve docs for Workflow Run Debugger
2 parents 013f52a + f396d24 commit 00de3bd

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

docs/workflows.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ The "valid" field will match our criteria, while the "invalid" part has everythi
537537
## Exploring Executions
538538
Executions in Shuffle can be explored by clicking the button of the "Running" person on the bottom of your screen while inside a workflow. This will open up a side-bar where you can see a list of the last executions as well as dig into details on why something did or didn't work (debugging). It will not always notify you when a new execution has happened, as these run in the background, but will open up when you attempt re-running an execution.
539539

540-
![image](https://user-images.githubusercontent.com/5719530/193847954-46334f96-f277-445f-9d84-c283c8552ff5.png)
540+
<img width="1021" height="200" alt="image" src="https://github.com/user-attachments/assets/1b469985-945f-49c3-8de8-2a9aefb21e5b" />
541541

542542
### Execution List
543543
After clicking the button, you will see a list of executions, which can be refreshed as you go along. This list is meant to help you find a previous execution, and to dig into it further. Here's a quick breakdown of what everything means:
@@ -599,14 +599,42 @@ The next part is a list of Action Results that were performed within the executi
599599
**PS: There's a handy Copy trick with JSON. By clicking the VALUE in JSON, it will copy the path to the Value itself (e.g. #nodename.success), while clicking the pink COPY ICON to the right of the value will copy the actual value (e.g. false in the image above)**
600600

601601
### Workflow Run Debugger
602-
The Workflow Run Debugger is a powerful tool that helps you debug your workflows. You can find it at [https://shuffler.io/workflows/debug](https://shuffler.io/workflows/debug).
602+
The Workflow Run Debugger is a powerful tool for debugging and managing large volumes of workflow executions. It is the recommended solution when you need to find past runs or **view more than the 100 executions**.You can find it at [https://shuffler.io/workflows/debug](https://shuffler.io/workflows/debug).
603603

604604
![Workflow Run Debugger](https://github.com/0x0elliot/Shuffle-docs/blob/master/assets/workflow_run_debugger.png?raw=true)
605605

606+
---
607+
608+
**How to Access the Workflow Run Debugger**
609+
610+
There are two ways to access the debugger. The recommended method is starting from your workflow, as it pre-filters the list for you.
611+
612+
**From a Specific Workflow:**
613+
1. Navigate to the workflow you want to check.
614+
2. Click the **"running person" icon** 🏃 (located next to the "Play" button) in the **bottom-left corner**.
615+
616+
<img width="1618" height="906" alt="image" src="https://github.com/user-attachments/assets/5b76e581-b46c-4a4d-b83f-c36cb2459fff" />
617+
618+
3. On the "All Workflow Runs" list that opens, click the **graph/search icon** (📈) in the **top-right corner**.
619+
620+
<img width="1087" height="895" alt="image" src="https://github.com/user-attachments/assets/69a8bfcf-e12d-4b55-98fb-e8a84451c169" />
621+
622+
623+
**Directly by URL:**
624+
625+
You can also access the debugger directly at:
626+
`https://shuffler.io/workflows/debug?workflow_id=<your-workflow-id>`
627+
628+
If you use this link, you may need the workflow id to find the specific executions you are looking for
629+
630+
---
631+
606632
With the Workflow Run Debugger, you can:
607-
- Filter executions by Workflow Name, Status, Execution Argument, and Results.
633+
- Filter executions by Workflow Name, Status, Execution Argument, Start and End date/time range, and Results.
634+
- The debugger's **"Max Results"** dropdown allows you to load and view up to **500** executions at once, Which allows to view large execution histories.
608635
- View all executions in your organization and sub-organizations.
609636
- See the execution status of visible executions.
637+
- Efficiently manage multiple runs. By using the checkboxes next to each run, you can select multiple executions and **mass abort** (stop) or **mass rerun** them simultaneously. This is ideal for handling a large number of failed or stuck workflows.
610638

611639
## Collaboration features
612640
Workflows have additional features that may be helpful when you start scaling, or want to collaborate.

0 commit comments

Comments
 (0)