Application Performance Snapshot User Guide for Linux* OS

Download PDF
ID 772048
Date 3/31/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Application Performance Snapshot User's Guide for Linux* OS
Application Performance Snapshot User's Guide for Linux* OS x
Introducing Application Performance Snapshot Analyzing Applications Detailed Analyses Metrics Reference Known Issues and Limitations Notices and Disclaimers
Analyzing Applications x
Prerequisites Analyzing Shared Memory Applications Analyzing MPI Applications Controlling Amount of Collected Data
Detailed Analyses x
Common Analyses MPI Analyses Outlier Detection
MPI Analyses x
Analysis Charts Filtering Capabilities Region Control with MPI_Pcontrol Creating Configuration File for Intel® Trace Collector
Analysis Charts x
Function Summary for All Ranks MPI Time per Rank Message Sizes Summary for All Ranks Data Transfers per Rank-to-Rank Communication Data Transfers per Rank Data Transfers per Function Node-to-Node Data Transfers Communicator List Detailed Information for Specific Ranks
Filtering Capabilities x
Filtering by Key Metric Filtering by Number of Lines Using Filter Combinations
Application Performance Snapshot User's Guide for Linux* OS

Analyzing Applications

Prerequisites

(Optional) Use the following software to get an advanced metric set when running Application Performance Snapshot:

  • Recommended compilers: Intel® C++ Compiler Classic, Intel® oneAPI DPC++/C++ Compiler or Intel® Fortran Compiler Classic and Intel® Fortran Compiler (other compilers can be used, but information about OpenMP* imbalance is only available from the Intel OpenMP library)

Before running the tool, you need to set up your environment. In the terminal, run the following command to set the environment variables: 

source /opt/intel/oneapi/vtune/latest/apsvars.sh
TIP:

Launch apsvars.sh with the --help option for a list of available setup options.

Analyzing Shared Memory Applications

  1. Run the following command: 

    $ aps <my app> [<app parameters>]

    where <my app> is the path to your application and <app parameters> are your application parameters.

    Application Performance Snapshot launches the application and runs the data collection.

  2. After the analysis completes, a report appears in the command window. You can also open an HTML report with the same information in a supported browser. The path to the HTML report is included in the command window. For example: 

     firefox ./aps_report_01012017_1234.html &

  3. Analyze the data shown in the report. Hover over a metric in the HTML report for more information.

  4. Determine appropriate next steps based on result analysis. Common next steps may include application tuning or using another performance analysis tool for more detailed information, such as Intel® VTune™ Profiler or Intel® Advisor.

Analyzing MPI Applications

  1. Run the following command to collect data about your MPI application: 

    $ <mpi launcher> <mpi parameters> aps <my app> [<app parameters>]

    where:

    • <mpi launcher> is an MPI job launcher, such as mpirun, srun, or aprun.

    • <mpi parameters> are the MPI launcher parameters.

      NOTE:

      aps must be the last <mpi launcher> parameter.

    • <my app> is the path to your application.

    • <app parameters> are your application parameters.

    Application Performance Snapshot launches the application and runs the data collection. After the analysis completes, a aps_result_<date> directory is created.

  2. Run the following command to complete the analysis: 

    $ aps --report=aps_result_<date>

    After the analysis completes, a report appears in the command window. You can also open an HTML report with the same information in a web browser.

  3. Analyze the data shown in the report. Hover over a metric in the HTML report for more information.

  4. Determine appropriate next steps based on result analysis.

    Common next steps may include communication tuning with the mpitune utility or using another performance analysis tool for more detailed information, such as Intel® Trace Analyzer and Collector or Intel® VTune™ Profiler.

Application Performance Snapshot also provides advanced capabilities for MPI analysis. See Detailed MPI Analysis for details.

Parent topic: Application Performance Snapshot User's Guide for Linux* OS
Level Two Title