Get Started

  • XX.XX
  • 06/18/2020
  • Public Content

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

Use
Intel® VTune™
Profiler
-Platform Profiler to collect system data over an extended period of time(minutes or hours vs seconds). You can use this information to get a holistic view of system behavior including CPU, memory, network, and disk usage.
Platform Profiler enables you to gain insights into system configuration, performance, and behavior. Use this application to focus on these aspects:
  • Platform-level memory
  • Storage
  • I/O
  • Interconnect bottlenecks
  • Imbalances
You can also collect data on a deployed system running a full load over an extended period of time. In the typical workflow, use Platform Profiler to perform these steps:
  1. Read performance data collected using a data collector component on a target system.
  2. Analyze the data.
  3. Display the data through web APIs and an HTML user interface.
Platform Profiler is available pre-installed as part of
VTune
Profiler
. You can download this software application from https://software.intel.com/en-us/vtune .

Prerequisites

Before you begin collecting data, set up Platform Profiler.
Configure the Host
  1. Source
    vpp-server-vars.sh
    in the server directory.
    $ source <vtune_install_dire>/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
    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
).

Learn More

Document
Description
The
VTune
Profiler
user guide has additional documentation for
VTune
Profiler
-Platform Profiler and other performance analysis opportunities.
This article introduces
VTune
Profiler
-Platform Profiler and provides an example interpretation of results collected for a movie recommendation system application.

Legal Information

Intel, the Intel logo, Intel Atom, Intel Core, Intel Xeon Phi, VTune and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries.
*Other names and brands may be claimed as the property of others.
© Intel Corporation
This software and the related documents are Intel copyrighted materials, and your use of them is governed by the express license under which they were provided to you (
License
). Unless the License provides otherwise, you may not use, modify, copy, publish, distribute, disclose or transmit this software or the related documents without Intel's prior written permission.
This software and the related documents are provided as is, with no express or implied warranties, other than those that are expressly stated in the License.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804