Run Logs
Run logs help you analyze the execution details of a playbook and the run details for each node that is defined in the playbook. This is helpful for debugging purposes. For example, if a playbook execution fails, you can view the playbook's run log to see the exact node at which it failed. Each run log is identified by its 12-digit unique ID. For example, RL6e5daa85-0
Run logs are used by analysts to do the following:
Analyze the overall status (For example, success, error, and more) of the playbook executions.
View the execution time of each node to analyze and optimize node performance.
View details of the execution of individual nodes.
View the inputs and outputs of each node.
View errors at a node level.
View details of the playbook executio,n such as run duration, and the date and time of the Playbook’s latest execution.
View Run Logs
You can view the run logs for playbooks by navigating to Main Menu > Playbooks > Run Logs and opening a run log. To view run logs, ensure that you have the View Run Logs permission.
Note
By default, in the listing page, run logs are filtered to display only the current day's run logs and exclude sub-playbook run logs. You can remove the filters to view all the run logs.
You can also access the run logs of a playbook in the Run Logs tab of a playbook.
Run logs display the following information:
Run Log ID: A 12-digit unique ID to identify a run log. For example, RL6e5daa85-0
Playbook Name: View the name of the playbook.
Sub-Playbooks: View the number of sub-playbooks added to the playbooks.
Status: View the run status of a playbook and playbook node. For more information on the run statuses, see Playbook Run Status.
Last Run: View the date and time of when the playbook was last executed. For example, Jan 16, 2023, 03:28 PM.
Run by: View the user, scheduler, master playbook, or event that has run the playbook. For example, John Doe
Note
When you open the sub-playbook run logs, the Run By Playbook field includes the link to the master playbook run logs. Select the link to view the master playbook's run log in a new tab.
Run Time: The run time of the playbook in seconds. For example, 3s.
Playbook Nodes Processed: View the nodes and the execution status, along with the run time of each playbook node in seconds to analyze and optimize node performance.
I/O View: Click I/O View and select a node to view the node's input and output values. You can switch between JSON View and Table View using the dropdown. The input and output preview displays data up to 4 MB. You can click More > Download to download the complete data up to 64 MB for offline analysis. To copy input and output, click More > Copy.
Note
To copy the dynamic path of a key in the output, hover over the key and click
. You can also use the search bar to find a specific key, or use the keyboard shortcut Command + F (Mac) or Control + F (Windows) to search.You can customize the input and output view by clicking
and selecting Split Editor to Right and Split Editor to Left. Click the Expand icon to see the input and output in a detailed view.Note
You cannot download the output data of the following nodes. However, you can preview the complete node output of up to 64 MB.
Playbook nodes
App action nodes that are Cyware Agent compatible
Playbook View: Click this to view the playbook and all the nodes.
You can choose the view for the input and the output values as either a JSON format or a table view. You can also copy the input or output values by clicking either Copy Input or Copy Output. After the value is copied, you can use it to define the input parameter for any other node in a playbook.
Playbook Run Status
You can view the following run status depending on the execution of the playbooks.
Success: Displays Success status if the Playbook has successfully performed the defined actions and produced the output.
Partial Success: Displays PartialSuccess status if the user has not configured Abort Playbook if this Action Fails for any of the playbook nodes, and the Playbook execution has been interrupted in an intermediate node. To rerun a Playbook from Run Logs, see Rerun Playbooks from Run Logs.
Error: Displays Error status if the playbook has failed to execute the configured workflow. This condition occurs when the nodes cannot exchange the configured input or output data. To rerun a playbook from Run Logs, see Rerun Playbooks from Run Logs.
On Hold: Displays On Hold status if the playbook is waiting for the user to manually input data. This condition occurs only for playbooks configured with manual input actions.
Waiting: Displays Waiting status if a particular node is yet to complete execution despite the completion of the playbook workflow. This condition occurs when a node is configured to Run Asynchronously independent of the playbook workflow. For example, Sub-Playbooks can be configured in the node of a parent Playbook to run asynchronously.
In Progress: Displays In Progress status if the playbook workflow is in progress and yet to be completed.
System Error: Displays SystemError status if the playbook workflow could not execute due to failure of multiple functions in the defined workflow. To rerun a Playbook from Run Logs, see Rerun Playbooks from Run Logs.
Terminated: Displays Terminated status if the playbook workflow is manually terminated or stopped while execution. A terminated playbook will skip the remaining nodes in the playbook workflow and stop the execution.
In Queue: Displays In Queue status if the playbook is waiting for other tasks to be completed. Once the preceding tasks are completed the Playbook status will change to In Progress status.
Supported Actions for Run Logs
You can sort the run logs based on playbooks latest execution time, run activity, and run duration.
You can filter and view specific run logs as per your requirement. You can also save the filter and reuse it by clicking Save Filter.
You can clear out the applied filters by clicking the cross icon or Clear All in the Filters view.
You can use the following filters to view specific run logs:
Quick Filters: Filter based on its activation (Active or Inactive) status.
Playbook Run Status: Filter based on the overall execution status (Example: success, partial success, error, and more) of playbooks.
Playbook Status: Filter based on its activation (Active or Inactive) status.
Sub-Playbook Run Logs: Choose the preference to include or exclude the run logs of sub-Playbooks.
Playbook: Filter based on playbook name.
Apps: Filter based on the app name.
Action: Filter based on app action names.
Run by User: Filter based on the user who has executed the Playbook.
Playbook Type: Filter based on the schedule type of playbooks.
Date Range of Run: Filter run logs by one of the following criteria:
Current Day: Filters the run logs of the current day. This is the default selection.
Last Week: Filters the run logs for the last 7 days.
Last Month: Filters the run logs for the last 31 days.
Last Year: Filters the run logs for the last 365 days.
Custom Date Range: Filters the run logs based on the selected date range.