Configure and Use Platform Profiler
Follow these instructions to configure and use
Intel® VTune™
-Platform Profiler on Windows or Linux machines.
Profiler
Configure the Host
(Linux*)
(Linux*)
- Sourcevpp-server-vars.shin the server directory.source <vtune_install_dire>/vpp/server/vpp-server-vars.sh
- Run the configuration script.Host Configuration forVTuneInstallation with a Non-privileged AccountProfilerIf you use a non-privileged account to installVTune, you have full control over the installation directory. To configure the Platform Profiler server, type:Profiler$vpp-server configThis configuration does not require a sudo password.Host Configuration forVTuneInstallation using an Account with Root or Sudo PrivilegesProfilerIf you use installVTuneusing an account with root or sudo privileges, the installation directory requires sudo permissions for modifications. To configure the Platform Profiler server, type:Profiler$sudo vpp-server configIf you use$sudo vpp-server configfor 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
(Linux*)
(Linux*)
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
(Linux*)
(Linux*)
Follow these steps to configure the collector. If you installed
VTune
with sudo privilege, you do not need to configure the collector.
Profiler
- Sourcevpp-collect-vars.shin the collector directory.source <vtune_install_dir>/vpp/collector/vpp-collect-vars.sh
- Run the configuration script:vpp-collect configAt this stage, you will be prompted to enter the sudo password.
Configure the Collector with a Target Package(Linux*)
(Linux*)
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
package.
Profiler
- From a machine which hasVTuneinstalled, copy the collector target package. Type:Profiler<vtune_install_dir>/target/linux/<vtune_profiler_target_x86_64.tgz>or<vtune_install_dir>/target/linux/<vtune_profiler_target_x86.tgz>
- Untarvtune_profiler_target_x86.tgzorvtune_profiler_target_x86_64.tgz:tar -xvf /path/to/vpp_target_file.tgz
- Sourcevpp-collect-vars.shin the collector directory:source <vtune_target_dir>/vpp/collector/vpp-collect-vars.sh
- Run the configuration script:vpp-collect configAt this stage, you will be prompted to enter the sudo password.
Start and Stop Platform Profiler Collector(Linux*)
(Linux*)
- Sourcevpp-collect-vars.sh.
This sets up the environment by putting commands in the path.source <vtune_install_dir>/vpp/collector/vpp-collect-vars.sh - Start data collection:vpp-collect startTip:When starting a collection, use the-coption 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.
- Stop data collection:vpp-collect stop
Collection results are available in a compressed file in the active directory (
<machine-name>_<datetime>tar.gz
).
Configure the Host(Windows*)
(Windows*)
- OpenVTune.Profiler
- Create or open a project.
- Click theConfigure Analysisbutton on the Welcome screen.
- In theHOWpane, click the
Browse button. In the
Platform Analysisgroup, selectPlatform Profiler. - ClickSet up Platform Profilerto configure Platform Profiler. This can take a few minutes to complete.If you see theLaunch Platform Profilerbutton instead, Platform Profiler is already configured. You can click the button to launch the application.
Start and Stop Platform Profiler Host(Windows*)
(Windows*)
To start Platform Profiler host, click the
Launch Platform Profiler
button. A browser opens the Platform Profiler user interface.
To stop Platform Profiler host, use the
VTune
icon on the task bar.
Profiler
Configure the Collector(Windows*)
(Windows*)
- At the command prompt, navigate to this directory:cd C:\Program Files(x86)\IntelSWTools\VTune Profiler\vpp\collector\
- Run this script to set up the environment. You will need administrator privilege.vpp-collect-vars.cmd
- Before you start data collection, disable Hyper-V. Then type:vpp-collect-start.cmd
- To stop data collection, type:vpp-collect-stop.cmd
Collection results are available in a compressed file in the active directory (
<machine-name>_<datetime>.zip
).