collect-with
collect-with
Run a
custom hardware event-based sampling or user-mode sampling and tracing
collection using your settings.
GUI Equivalent
Syntax
-collect-with
<collector_name>
Arguments
collector_name | Description |
runsa | Perform hardware event-based sampling
collection.
|
runss | Perform user-mode sampling and tracing
collection.
|
Modifiers
[no-]allow-multiple-runs,
analyze-kvm-guest,
[no-]analyze-system,
app-working-dir,
call-stack-mode,
cpu-mask,
data-limit,
discard-raw-data,
duration,
finalization-mode,
[no-]follow-child,
inline-mode,
knob,
mrte-mode,
quiet,
result-dir,
resume-after,
return-app-exitcode,
ring-buffer,
search-dir,
start-paused,
strategy,
[no-]summary,
target-duration-type,
target-pid,
target-process,
no-unplugged-mode,
user-data-dir,
verbose
Description
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
knob option specifies the list of events to collect. To display a list of
events available on the target PMU, enter:
vtune
<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 thecollectorcollect-withaction, enteror-help collectvtune.-help collect-withvtune
- For the most current information on available knobs, enteror-help collect <vtuneanalysis_type>, where-help collect-with <vtuneanalysis_type><analysis_type>is the type of analysis you wish to perform.
Alternate Options
Use the
collect action
with predefined settings.
Example
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