Intel® VTune™ Profiler

Install Intel® VTune™ Profiler

ID 767438
Date 6/24/2024
Public

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

Install with Package Managers

On Linux* OS, learn how to install Intel® VTune™ Profiler using the APT, YUM, DNF, or Zypper package managers.

Before You Begin

  • Make sure that your operating system is supported. Check System Requirements.

  • If you have not installed Intel® oneAPI software products using package managers previously, configure your package manager to work with the repository. Follow instructions in the sections below.

APT

Add the Intel oneAPI Repository

If you have not installed Intel® oneAPI Toolkits or components previously, configure your package managers to use Intel repositories:

  1. (Optional) Switch to any directory with write access. This example uses /tmp:
    cd /tmp
  2. Download the Intel repository public key. Use wget:
    wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
  3. Add the public key to your apt keyring:
    sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
  4. (Optional) Remove the public key file, since this is no longer required:
    rm GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
  5. Configure the APT client to use the Intel repository:
    echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list

    If the add-apt-repository utility is installed, run this command instead:

    sudo add-apt-repository "deb https://apt.repos.intel.com/oneapi all main"
Install the VTune Profiler Package
  1. Update the APT package lists:
    sudo apt update
  2. Install the VTune Profiler standalone package:
    sudo apt install intel-oneapi-vtune

YUM

Add the Intel oneAPI Repository

If you have not installed Intel® oneAPI Toolkits or components previously, configure your package managers to use Intel repositories:

  1. In a directory that has write access, create a YUM/DNF .repo file. This example uses /tmp:
    tee > /tmp/oneAPI.repo << EOF
    [oneAPI]
    name=Intel® oneAPI repository
    baseurl=https://yum.repos.intel.com/oneapi
    enabled=1
    gpgcheck=1
    repo_gpgcheck=1
    gpgkey=https://yum.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
    EOF
  2. Move the oneAPI.repo file that you just created, to the YUM/DNF configuration directory (/etc/yum.repos.d):
    sudo mv /tmp/oneAPI.repo /etc/yum.repos.d
Install the VTune Profiler Package

Run this command:

sudo yum install intel-oneapi-vtune

DNF

Add the Intel oneAPI Repository

If you have not installed Intel® oneAPI Toolkits or components previously, configure your package managers to use Intel repositories:

  1. In a directory that has write access, create a YUM/DNF .repo file. This example uses /tmp:
    tee > /tmp/oneAPI.repo << EOF
    [oneAPI]
    name=Intel® oneAPI repository
    baseurl=https://yum.repos.intel.com/oneapi
    enabled=1
    gpgcheck=1
    repo_gpgcheck=1
    gpgkey=https://yum.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
    EOF
  2. Move the oneAPI.repo file that you just created, to the YUM/DNF configuration directory (/etc/yum.repos.d):
    sudo mv /tmp/oneAPI.repo /etc/yum.repos.d
Install the VTune Profiler Package

Run this command:

sudo dnf install intel-oneapi-vtune

Zypper

Add the Intel oneAPI Repository

If you have not installed Intel® oneAPI Toolkits or components previously, configure your package managers to use Intel repositories.

Run this command to add the Intel repository key:

sudo zypper addrepo https://yum.repos.intel.com/oneapi oneAPI
Install the VTune Profiler Package

Run this command:

sudo zypper install intel-oneapi-vtune

After you Install VTune Profiler

Set Environment Variables:

To use the command line interface of VTune Profiler, set environment variables first. Run these scripts:

bash:

source /opt/intel/oneapi/vtune/latest/env/vars.sh

csh/tcsh:

source /opt/intel/oneapi/vtune/latest/env/vars.csh
Verify Your Installation:

To verify if you installed VTune Profiler correctly or troubleshoot issues with the installation, use the self-check script (vtune-self-checker.sh) available in the package. This script runs a set of analyses on a sample application, and reports the progress interactively.

  1. Before you run the self-check script, make sure to set environment variables.

  2. Next, open a terminal window.

  3. Go to this location: /opt/intel/oneapi/vtune/latest/bin64/

  4. Run the vtune-self-checker.sh script:

    vtune-self-checker.sh

    The self-check script may take several minutes to run all necessary checks.

  5. Once the script completes all checks, review the summary. Check if any analyses failed, and see the log file for additional information.

Configure Data Collection Without Sampling Drivers (Optional):

If you install VTune Profiler without superuser privileges, you must complete additional configuration steps to enable hardware analyses through Linux Perf*.

To learn about these steps and possible limitations, see this technical recipe on Profiling Hardware Without Intel Sampling Drivers.

Learn More