PREVIEW | Analyze: Execution

This page is no longer maintained (March 29, 2023). For the most current information, go to Analyze and Monitor Studio.

On this page:

Overview

Pipelines contain the logic to integrate and transform data. Tasks execute Pipelines on a schedule, in response to an HTTP or API call, or in the case of Ultra Tasks, in response to streaming data. Information on Pipeline execution is valuable for troubleshooting and fine-tuning performance during the development cycle and in production.

The Execution overview page reports on Pipeline executions for the selected time period. From this page, you can determine:

  • Which Pipelines are currently executing

  • Who executed a Pipeline

  • Which Task executed a Pipeline

  • What time an execution started and finished

  • Current and past execution status

  • How many documents were processed during an execution

  • What type of errors occurred

  • Optional columns contain the following information:

    • The Project Space and Project to which a Task belongs

    • The Snaplex and node that executed the Pipeline

Analyzing Pipeline Execution

In SnapLogic Studio, click Analyze > Execution to open the Execution overview:

Execution overview

Each row shows details for a Pipeline execution. Using controls on the Execution overview page, you can:

  • Select a time period in hours or by date range.

  • View execution status summary cards for the selected time period. Click a card to filter the execution list by that status.

  • Aggregate executions, grouped by Pipeline or by the Tasks that triggered them.

  • Resize, search, filter, and add or remove columns from the execution list.

  • Click a column name to sort the execution list by ascending or descending values.

  • Export the current results to a CSV file.

  • Refresh the execution list.

Click an execution to view its details. Pipeline execution details include information on its Snaps and parameters, and give you access to errors and logs. For each Snap, you can determine how long it took, how much data and the number of documents that were processed, and at what speed. Learn more about Execution details.

The following Pipeline details panel shows an execution that completed successfully:

Pipeline execution details

Finding Executions of Interest

Your Org might execute tens of thousands of Pipelines in a short time period. The Execution overview page provides controls for finding the executions of interest and viewing relevant details. Before using these controls, you can set the time period to the smallest window possible to reduce the number of executions in the list. After you run a search, the page URL contains the search string, filters, and column preferences. You can bookmark the URL to perform the same search later or copy it to share with colleagues.

The following sections provide procedures for:

Finding Executions That You Initiated

To view your Pipeline executions:

  1. In the Search bar, click the options icon:

  2. In Advanced Options, click Executed by and start entering your username.

  3. When your username displays, click + to select it.

  4. Click Apply.

The execution list updates to reflect the filter. The options icon has a red decorator to indicate a filter was applied. The filter remains until you remove it.

Finding a Failed Execution

To view the details of a failed Pipeline or Task:

  1. Click the Failed summary card:

  2. In the execution list, click the Pipeline or Task of interest to display details.

Using Advanced Filters

To use advanced filtering:

  1. In the Search bar, click the options icon to display the Advanced filtering dialog:

  2. In Advanced filtering, click the type of filter to apply.

    1. The first filters in the menu have pull-down options:

    2. The last filters in the menu accept text entries:

  3. Add filters and click Apply.

The filters apply to subsequent searches and to the execution list until you remove them. A red dot decorates the options icon to remind you that filters are applied.

To find executions for a Project:

  1. In the Search bar, click the options icon to display the Advanced filtering dialog:

  2. In Advanced filtering, click the type of filter to apply.

  3. Click Project to open the list of Project Spaces:

  4. Click a Project Space to open the list of Projects:

  5. Select the Project to search.

Viewing and Analyzing Execution Details

The following sections provide procedures for using the Execution overview for analysis and troubleshooting. Before using these controls, you can also set the time period to the smallest window possible to reduce the number of executions in the list.

Changing Table Columns

Specific execution details might be of particular interest to you, such as the duration and completion status. You can resize, rearrange, add, and remove columns from the execution list to more easily scan relevant information.

To add, remove, and rearrange columns:

  1. In the Search bar, click the options icon:

    The Advanced filtering dialog displays.

  2. In the Column Preferences section:

    1. Click x on a shaded column to remove it.

    2. Click + on an unshaded column to add it.

    3. Drag shaded columns to rearrange the order in which they display in the table.

  3. Click Apply.

Grouping by Pipeline or Task

Instead of single executions, you might be interested in a series of executions to analyze behavior over a specific time period. You can group the execution list by Pipeline to aggregate information for a Pipeline, which could have been executed by multiple Tasks, or by Task to show multiple executions of the same Pipeline.

The Group by: control aggregates executions by Pipelines or by the Tasks that initiated them. To aggregate executions, follow these steps:

  1. Next to Group by:, click Pipeline or Task.
    The execution list displays Pipelines or Tasks.

  2. Locate the Pipeline or Task of interest and click it.
    The details panel displays a list of Pipeline executions. This aggregated Pipeline example is sorted by Status to show failed executions at the top:

    Click an execution to view the Pipeline details:

To return to the unaggregated list of executions, click the selected Pipeline or Task button to clear it.