PREVIEW | Analyze: Metrics

This page is no longer maintained (March 29, 2023). For the most current information, go to https://docs.snaplogic.com/studio/analyze-metrics.html.

Overview

The Metrics page displays charts for a Snaplex node. The charts reveal trends for key metrics. Use the Metrics page to:

  • Analyze the behavior of a Snaplex node

  • Improve Task scheduling by finding under-utilized and over-utilized time periods

  • Troubleshoot performance issues by identifying usage spikes

  • View trends and individual data points

  • Zoom in on charts to focus on a shorter time period

  • Expand a chart to determine which Pipelines ran during a specific time period and view the execution details

  • Review Snap statistics, Pipeline logs, and Pipeline parameters

  • Download files for:

    • Chart values in JSON format

    • Pipeline logs in JSON format

    • Runtime details in CSV format

The Metrics and Infrastructure pages provide complementary information, as described in the following table:

Attributes:

Metrics Page

Infrastructure Page

Attributes:

Metrics Page

Infrastructure Page

Scope

Single Snaplex node

All Snaplexes and their nodes

Metrics Reported

Memory, CPU, and Disk utilization, system load, active threads, and network traffic

Memory, CPU, and Disk utilization

Type of Visualization

Plotted

Color-coded average and maximum usage

Analyzing Node Behavior

Open the Studio Metrics page to monitor and troubleshoot node behavior:

  1. In the navigation pane under Analyze, select Metrics:

    Analyze Metrics Navigation Menu
  2. Select a node in one of the following ways:

    Select a node
    • Start entering text to search for a node by name.

    • Click the node dropdown arrow to browse by Snaplex and click a Snaplex to display its nodes.
      The Metrics page displays:

The charts report the average value, maximum value, and trends for:

  • Percentage of CPU, disk, and memory use

  • Percentage of system load

  • Number of active threads and active Pipelines

  • Size of network requests received and sent

For time periods of seven days or less, each data point represents the average value of that metric in one-minute intervals. For time periods of more than seven days, each data point represents the average value of that metric over fifteen-minute intervals.

Working with Charts

The default Metrics layout includes nine charts. You can add, remove, and expand charts. The following table lists the controls available for the page, the charts, and an expanded chart:

Page Controls

Chart Controls

Expanded Chart

Page Controls

Chart Controls

Expanded Chart

Select a node

Expand the chart

Return to normal size

Change the time period

Remove the chart

Download chart data

Refresh chart data

Download chart data

Display Pipeline executions for a selected time period and view the details

Add a chart that was removed

View individual data points

View individual data points

 

Zoom in to view more details

Zoom in to view more details

Viewing Data Point Values

In a regular or expanded chart, hover over the plot to view values for individual data points. For example, to determine why memory use spiked, you might want to check the number of pipelines that were running at the same time. Do that on the Studio Metrics page by hovering over a chart to view data point values. The value indicator tracks the same point in time for all charts:

 

You can also drag your cursor to zoom in on a shorter period of time, as shown in the following video:

Viewing and Downloading Pipeline Details and Logs

To view details for a Pipeline execution during a specific time period:

  1. In the chart of interest, click to expand it.

  2. Drag your cursor across the plot to select a time period as shown in the video in the section above.

    A table of Pipeline executions displays:

  3. Click to download the Pipeline data in .csv format.

  4. To view more details, do one of the following:

    • Open the Execution overview (filtered to show these Pipelines) by clicking Open in execution view.

    • Click a Pipeline name to open its execution details. From the Pipeline execution details, select the Pipeline Logs tab to view and download logs.

Downloading Chart Data

To download chart data:

  • For standard charts, click the ellipsis and select Download chart data:

  • For an expanded chart, from the toolbar, click Download:

Adding or Removing a Chart

The Metrics page offers nine charts. They are all shown by default, so the Add button is disabled until you remove a chart.

To remove a chart, click the ellipsis and select Remove chart:

To add a chart, from the toolbar, click Add and select the chart to add:

Related Content