Intel VTune Profiler

https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/
Admin
Intel VTune Profiler is a performance analysis tool that helps developers optimize application...
Tokens:7,427
Snippets:157
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure and Install via Zypper

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/package-managers.html

Add the Intel repository and install the VTune Profiler package using Zypper.

```bash
sudo zypper addrepo https://yum.repos.intel.com/oneapi oneAPI
```

```bash
sudo zypper install intel-oneapi-vtune
```

--------------------------------

### Install VTune Profiler via APT

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/package-managers.html

Update package lists and install the VTune Profiler package.

```bash
sudo apt update
```

```bash
sudo apt install intel-oneapi-vtune
```

--------------------------------

### Install Sampling Drivers on Windows

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/windows.html

Run this command with administrative privileges to install sampling drivers if they are missing.

```batch
amplxe-sepreg.exe -i
```

--------------------------------

### Install VTune Profiler via DNF

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/package-managers.html

Install the VTune Profiler package using DNF.

```bash
sudo dnf install intel-oneapi-vtune
```

--------------------------------

### Install VTune Profiler via YUM

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/package-managers.html

Install the VTune Profiler package using YUM.

```bash
sudo yum install intel-oneapi-vtune
```

--------------------------------

### Enable Installer Execution on Linux

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/update-your-intel-vtune-profiler.html

Grant execution permissions to the installer script before running it.

```bash
chmod +x <installer-package-name>.sh
```

--------------------------------

### Start VTune Profiler Server with Separate Key File

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/set-up-transport-security.html

Command to launch the server when the certificate and private key are stored in separate files.

```bash
vtune-backend --tls-certificate /path/to/vtune.lab01.myorg.com.crt --tls-certificate-key /path/to/vtune.lab01.myorg.com.key
```

--------------------------------

### Run Linux Installer as Superuser

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/update-your-intel-vtune-profiler.html

Execute the installer script with root privileges to initiate the update process.

```bash
sudo ./<installer-package-name>.sh
```

--------------------------------

### Start VTune Profiler Server with Reverse Proxy

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/configure-user-authentication-authorization.html

Commands for starting the server when deployed behind a reverse proxy, either on the same host or a different host.

```bash
vtune-backend --web-port=8080  
Serving GUI at https://127.0.0.1:8080  
warn: Server access is limited to localhost only. To enable remote access, restart with --allow-remote-ui.
```

```bash
vtune-backend --allow-remote-ui --client-certificate /path/to/public/reverse/proxy/cert.crt
```

--------------------------------

### Start VTune Profiler Server with TLS Certificate

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/set-up-transport-security.html

Commands to launch the server using a PFX certificate file with either a password file or interactive password entry.

```bash
vtune-backend --tls-certificate /path/to/vtune.lab01.myorg.com.pfx --tls-certificate-password-path /path/to/cert_password.txt
```

```bash
vtune-backend --tls-certificate /path/to/vtune.lab01.myorg.com.pfx --tls-certificate-password

Certificate password:
```

--------------------------------

### Run VTune Self-Checker Script

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/windows.html

Execute the self-checker script from the bin64 directory to verify the installation and troubleshoot potential issues.

```batch
vtune-self-checker.bat
```

--------------------------------

### Run VTune Self-Checker Script

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/regular-install.html

Command to execute the self-check script for verifying the installation.

```bash
vtune-self-checker.sh
```

--------------------------------

### Configure APT Repository

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/package-managers.html

Commands to download the Intel public key, add it to the keyring, and configure the APT source list.

```bash
cd /tmp
```

```bash
wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
```

```bash
sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
```

```bash
rm GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
```

```bash
echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list
```

```bash
sudo add-apt-repository "deb https://apt.repos.intel.com/oneapi all main"
```

--------------------------------

### Configure YUM/DNF Repository

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/package-managers.html

Create and move the oneAPI repository configuration file for YUM or DNF.

```bash
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
```

```bash
sudo mv /tmp/oneAPI.repo /etc/yum.repos.d
```

--------------------------------

### Set Environment Variables for VTune Profiler

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/regular-install.html

Commands to initialize environment variables for different shell types.

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

```csh
source /opt/intel/oneapi/vtune/latest/env/vars.csh
```

--------------------------------

### Add user to vtune group

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/regular-install.html

Grant the necessary permissions to use VTune Profiler drivers by adding the user account to the vtune group.

```bash
$ sudo usermod -aG vtune <username>
```

--------------------------------

### Set Environment Variables

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/windows.html

Run the vars.bat script to configure environment variables for the VTune Profiler command line interface.

```batch
C:"Program Files (x86)"\Intel\oneAPI\vtune\latest\env\vars.bat
```

--------------------------------

### Verify Sampling Driver Status

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/regular-install.html

Commands to navigate to the driver source directory and check if sampling drivers are loaded.

```bash
$ cd <install-dir>/sepdk/src

$ ./insmod-sep -q
```

--------------------------------

### Locate Collector Packages

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/install-collectors-remote-targets.html

Paths to the directory containing collector packages for Windows and Linux target systems.

```text
C:"Program Files (x86)"\Intel\oneAPI\vtune\latest\target
```

```text
/opt/Intel/oneAPI/vtune/latest/target
```

--------------------------------

### Check Sampling Driver Status

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/windows.html

Verify if the sampling drivers are currently loaded on the system.

```batch
amplxe-sepreg.exe -s
```

--------------------------------

### Verify Hardware Event-Based Sampling Requirements

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/windows.html

Check if the system meets the requirements for hardware event-based sampling (HEBS) collection.

```batch
amplxe-sepreg.exe -c
```

--------------------------------

### Update VTune Profiler via Package Managers

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/update-your-intel-vtune-profiler.html

Commands to update the VTune Profiler package using common Linux package managers.

```bash
sudo apt install intel-oneapi-vtune
```

```bash
yum upgrade intel-oneapi-vtune
```

```bash
dnf upgrade intel-oneapi-vtune
```

```bash
zypper up intel-oneapi-vtune
```

--------------------------------

### Reset Passphrase for VTune Profiler Server

Source: https://www.intel.com/content/www/us/en/docs/vtune-profiler/installation-guide/2025-0/configure-user-authentication-authorization.html

Use this command to reset a forgotten passphrase. The server generates a one-time token URL for setting a new passphrase.

```bash
vtune-backend --reset-passphrase  
Serving GUI at https://127.0.0.1:65417?one-time-token=e2ed7c1365c972ec1024ac4e53179a08
```
Tokens:
Raw