Get Started with Intel® VTune™ Profiler-Platform Profiler for Linux*

Configure the Host

1. Source vpp-server-vars.sh in the server directory.

   $ source <vtune_install_dir>/vpp/server/vpp-server-vars.sh 

2. Run the configuration script.

   Host Configuration for VTune Profiler Installation with a Non-privileged Account

   If you use a non-privileged account to install VTune Profiler, you have full control over the installation directory. To configure the Platform Profiler server, type:

   $vpp-server config

   This configuration does not require a sudo password.

   Host Configuration for VTune Profiler Installation using an Account with Root or Sudo Privileges

   If you use install VTune Profiler using an account with root or sudo privileges, the installation directory requires sudo permissions for modifications. To configure the Platform Profiler server, type:

   $sudo vpp-server config

   Note:

   If you use $sudo vpp-server config for an installation requiring sudo or root privileges, although the configuration does not prompt you for a sudo password, it will fail in the absence of sudo permissions.

Start and Stop Platform Profiler Host

To start Platform Profiler host, run

$vpp-server start

Navigate to the Platform Profiler homepage on a web browser (Google Chrome* recommended)

http://localhost:6543

To stop Platform Profiler host, run:

$vpp-server stop

Configure the Collector

Follow these steps to configure the collector. If you installed VTune Profiler with sudo privilege, you do not need to configure the collector.

1. Source vpp-collect-vars.sh in the collector directory.

   $source <vtune_install_dir>/vpp/collector/vpp-collect-vars.sh 

2. Run the configuration script:

   $ vpp-collect config

   At this stage, you will be prompted to enter the sudo password.

Configure the Collector with a Target Package

You can use Platform Profiler to collect data on a system under test (SUT) using a target package. This allows you to collect data with a small footprint collector without having to install the full VTune Profiler package.

1. From a machine which has VTune Profiler installed, copy the collector target package. Type:

   <vtune_install_dir>/target/linux/<vtune_profiler_target_x86_64.tgz>

   or

   <vtune_install_dir>/target/linux/<vtune_profiler_target_x86.tgz>

2. Untar vtune_amplifier_target_x86.tgz or vtune_profiler_target_x86_64.tgz:

   $ tar -xvf /path/to/vpp_target_file.tgz 

3. Source vpp-collect-vars.sh in the collector directory:

   $ source <vtune_target_dir>/vpp/collector/vpp-collect-vars.sh

4. Run the configuration script:

   $ vpp-collect config

   At this stage, you will be prompted to enter the sudo password.

Start and Stop Platform Profiler Collector

1. Source vpp-collect-vars.sh.

   Source <vtune_install_dir>/vpp/collector/vpp-collect-vars.sh

   This sets up the environment by putting commands in the path.
2. Start data collection:

   $vpp-collect start

   Tip: When starting a collection, use the -c option to add a comment to your result file. The comment is visible after you upload the result. Comments can help differentiate between results collected on the same system. For example, you can use comments to add a description of your workload.

   When the collection is running, add timeline markers to your result at intervals where you need them:

   $vpp-collect mark "comment"

   You can use a comment to add an optional label to your timeline marker.

3. Stop data collection:

   $vpp-collect stop

Collection results are available in a compressed file in the active directory (<machine-name>_<datetime>tar.gz).