custom-collector

Launch an external collector to gather custom interval and counter statistics for your target in parallel with the VTune Amplifier.

GUI Equivalent

Analysis Target window

Syntax

-custom-collector=<string>

Arguments

<string>

Command line launching an external collection tool.

Actions Modified

collect,collect-with

Description

Your custom collector can be an application you analyze with the VTune Amplifier or a collector that can be launched with the VTune Amplifier.

Use the -custom-collector option to specify an external collector other than a target analysis application.

When you start a collection, the VTune Amplifier does the following:

Launches the target application in the suspended mode.
Launches the custom collector in the attach (or system-wide) mode.
Switches the application to the active mode and starts profiling.

If your custom collector cannot be launched in the attach mode, the collection may produce incomplete data.

You can later import custom collection data (time intervals and counters) in a CSV format to the VTune Amplifier result.

Example

This example runs Basic Hotspots analysis and also launches an external script collecting custom statistics for the specified application:

Windows:

>amplxe-cl -collect hotspots -custom-collector="python.exe C:\work\custom_collector.py" -- notepad.exe

Linux:

>amplxe-cl -collect hotspots -custom-collector="python /home/my_collectors/custom_collector.py" -- my_app

This example runs VTune Amplifier event-based sampling collector and also uses an external system collector to identify product environment variables: