Intel® VTune™ Profiler

Cookbook

Download PDF
ID 766316
Date 6/03/2024
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
Cookbook
Cookbook x
Methodologies Configuration Recipes Tuning Recipes Notices and Disclaimers
Methodologies x
Analyzing Uncore Perfmon Events for Use of Intel® Data Direct I/O Technology in Intel® Xeon® Processors (NEW) Top-down Microarchitecture Analysis Method OpenMP* Code Analysis Method Custom Data Collection for Performance Analysis (NEW) Software Optimization for Intel® GPUs (NEW) Core Utilization in DPDK Apps PCIe Traffic in DPDK Apps DPDK Event Device Profiling Effective Utilization of Intel® Data Direct I/O Technology Compile a Portable Optimized Binary with the Latest Instruction Set
Configuration Recipes x
Profiling OpenVINO™ Applications (NEW) Profiling High Bandwidth Memory Performance on Intel® Xeon® CPU Max Series (NEW) Profiling Windows* Applications for Hybrid CPU Platforms (NEW) Viewing Analysis Results on a Web Browser (NEW) Profiling Machine Learning Applications (NEW) Profiling Single-Node Kubernetes* Applications (NEW) Analyzing Hot Code Paths Using Flame Graphs (NEW) Improving Hotspot Observability in a C++ Application Using Flame Graphs Measuring Performance Impact of NUMA in Multi-Processor Systems Profiling Games built with Unity* (NEW) Profiling Games built with Unreal Engine* (NEW) Profiling Java Applications as a Remote User (NEW) Profiling JavaScript* Code in Node.js* Analyzing CPU and FPGA (Intel® Arria® 10 GX) Interaction Profiling a .NET* Core Application Profiling Applications in Amazon Web Services* (AWS) EC2 Instances Enabling Performance Profiling in GitLab* CI Configuring a Hyper-V* Virtual Machine for Hardware-Based Hotspots Analysis Profiling an Application for Performance Anomalies (NEW) Profiling an OpenMP* Offload Application running on a GPU Profiling a SYCL* Application running on a GPU Profiling an FPGA-driven SYCL* Application Profiling Hardware Without Intel Sampling Drivers Profiling MPI Applications Profiling Docker* Containers Profiling a Remote Target Through a Proxy Server (NEW) Ingredients Windows Host Configuration Linux/macOS Host Configuration See Also Profiling in an Apptainer* Container Profiling Linux*, Android*, and QNX* System Boot Time Using Intel® VTune™ Profiler Server with Visual Studio Code and Intel® DevCloud for oneAPI (NEW) Using Intel® VTune™ Profiler Server in HPC Clusters Using the Command-Line Interface to Analyze the Performance of a SYCL* Application running on a GPU (NEW)
Tuning Recipes x
Cache-Related Latency Issues in Segmented Cache Environment False Sharing Frequent DRAM Accesses Poor Port Utilization Page Faults Instruction Cache Misses OS Thread Migration OpenMP* Imbalance and Scheduling Overhead Processor Cores Underutilization: OpenMP* Serial Time Scheduling Overhead in an Intel® oneAPI Threading Building Blocks Application PMDK Application Overhead
Cookbook

Profiling a Remote Target Through a Proxy Server (NEW)

This recipe describes how to run Intel® VTune™ Profiler through a proxy server to profile remote targets.

When you need to profile remote target systems, follow this recipe to run Intel® VTune™ Profiler through a proxy server. The recipe describes host configurations for Windows or Linux* systems.

Ingredients

This section lists the software used for the performance analysis scenario.

  • Operating system: Windows, Linux, or macOS systems

  • Tools:Intel® VTune™ Profiler

Windows Host Configuration

Prerequisites:

If you do not already have RSA private/public keys for passwordless SSH access, follow this procedure to generate them using the internal Intel® VTune™ Profiler generator.

  1. Create a python script called generator.py. In this script, replace USER with your username and HOSTNAME with the name of your target machine. 

    import sys
import pythonhelpers1.genhelpers as genhelpers
if len(sys.argv) < 2:
    print("Usage: amplxe-python generator.py USER@HOSTNAME")
    sys.exit(1)
private_key = "id_rsa_vtune_" + str(sys.argv[1])
genhelpers.ssh_keygen(private_key, private_key + '.pub')

  2. In a command window, run this command: 

    VTUNE_INSTALL_DIR\bin64\amplxe-python generator.py USER@HOSTNAME

The private and public keys should get created in the current directory.

Run Intel® VTune™ Profiler on Windows Host through Proxy Server

  1. Copy these keys to the %USERPROFILE%\.ssh directory on the host system:

    • id_rsa_vtune_USER@HOSTNAME
    • id_rsa_vtune_USER@HOSTNAME.pub

  2. Add the content of the public key to ~/.ssh/authorized_keys on the target system and ~ - USER home directory.

  3. Install the Ncat third-party utility on the Windows host for remote connection through a proxy server. You can download this from https://nmap.org/ncat.

  4. Create %USERPROFILE%\.ssh\config with these lines: 

    Host HOSTNAME
    ProxyCommand 'PATH\TO\NCAT\ncat.exe' --proxy-type <TYPE> --proxy <PROXYADDR[:PORT]> %h %p

    Here,

    • TYPE refers to the type of proxy server.
    • PROXYADDR refers to the address of the proxy server.
    • PORT refers to the port number.

  5. Fix permissions for the config and private key. 

    icacls %USERPROFILE%\.ssh\id_rsa_vtune_USER@HOSTNAME /inheritance:r 
icacls %USERPROFILE%\.ssh\id_rsa_vtune_USER@HOSTNAME /grant:r "%USERNAME%":"(R)"
icacls %USERPROFILE%\.ssh\config /inheritance:r 
icacls %USERPROFILE%\.ssh\config /grant:r "%USERNAME%":"(R)"

  6. Check the connection by calling the uname command. 

    VTUNE_INSTALL_DIR\bin64\ssh.exe -i "%USERPROFILE%\.ssh\id_rsa_vtune_USER@HOSTNAME" USER@HOSTNAME uname

You are now ready to run Intel® VTune™ Profiler on the Windows host to profile the remote target.

Linux/macOS Host Configuration

Prerequisites: If you do not already have RSA private/public keys for passwordless SSH access, generate them using an empty passphrase : 

host> ssh-keygen -t rsa

Run Intel® VTune™ Profiler on Linux Host through Proxy Server

  1. Add the content of the public key to ~/.ssh/authorized_keys on the target system, ~ - USER home directory. Replace USER with your username.

  2. If you do not already have it on the host machine, download and install Ncat or Netcat third-party utilities on the host for remote connection through proxy. You can download them from:

  3. Create ~/.ssh/config with these lines. The nc option depends on your version. 

    Host HOSTNAME
    ProxyCommand nc -X <TYPE> –x <PROXYADDR[:PORT]> %h %p

    or 

    Host HOSTNAME
    ProxyCommand nc --proxy-type <TYPE> --proxy <PROXYADDR[:PORT]> %h %p

    where:

    • HOSTNAME refers to the name of the target machine.
    • TYPE refers to the type of proxy server.
    • PROXYADDR refers to the address of the proxy server.
    • PORT refers to the port number.

  4. Check the connection by calling the uname command. 

    ssh USER@HOSTNAME uname

You are now ready to run Intel® VTune™ Profiler on the Linux host to profile the remote target.

Parent topic: Configuration Recipes
Level Two Title