Intel® VTune™ Profiler

User Guide

ID 766319
Date 3/22/2024

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

Document Table of Contents


Run a custom hardware event-based sampling or user-mode sampling and tracing collection using your settings.

GUI Equivalent

Custom Analysis


-collect-with <collector_name>





Perform hardware event-based sampling collection.


Perform user-mode sampling and tracing collection.


Use the collect-with action when you want finer control over analysis settings than the collect action can offer. Specify both the collector type and the knob. The collector type determines the type of collection, and the knob determines the level or granularity. Lower levels are coarser grained, while higher levels are finer grained. The analysis process includes finalization of the result, and a summary report is displayed by default.

For the runsa (event-based sampling) collector, the event-config knob option specifies the list of events to collect. To display a list of events available on the target PMU, enter:

vtune -collect-with runsa -knob event-config=? <target>

The command returns names and short descriptions of available events. For more information on the events, use Intel Processor Events Reference

  • To access the most current command line documentation for the collect or collect-with action, enter vtune -help collect or vtune -help collect-with.

  • For the most current information on available knobs, enter vtune -help collect <analysis_type> or vtune -help collect-with <analysis_type>, where <analysis_type> is the type of analysis you wish to perform.

Alternate Options

Use the collect action with predefined settings.


This example runs the hardware event-based sampling collector for the sample Linux* application on the specified events and displays a summary report.

vtune -collect-with runsa -knob event-config=CPU_CLK_UNHALTED.CORE,CPU_CLK_UNHALTED.REF,INST_RETIRED.ANY /home/test/sample