Report mode

Output data from a capture to the command line or to a file. You can use options to filter and format the data.

Syntax

streamline -report [options] <capture.apc>

Options

-all

Output the contents of the Timeline, Call Paths, Functions, and Log views, including bookmarks and custom activity map tables. This option is the default.

-bookmarks

Output all bookmarks that are stored in a capture, listing the time index location of the bookmark and its text.

-bstart <name>

Filter the data to start at the first bookmark with the provided name. For example, if you enter -bstart redflag, all data before the first instance of the bookmark title redflag is filtered from the output.

-bstop <name>

Filter the data to end at the first bookmark with the provided name.

-callpath

Output the contents of the Call Paths view. Subordinate functions are indented.

-cam

Output the contents of custom activity map tables.

Note

To export custom activity map data, the report must contain custom activity map annotations.

-disasm[=<name>] <images> [<source>]

Output the disassembly view part of the Code view as a CSV file.

<images> is a comma-separated list of ELF images (as were attached to the capture for analysis) to include in the output.

<source>, if specified, is the name for the data to output that is given in the Code view. For example, 'Periodic Sampling' or 'SPE'.

-format <space|tab|csv>

The format of the output. Format the tables using spaces, tabs, or comma-separated values. This option is useful if you want to easily convert output text files to a spreadsheet application. The default format is spaces, making the tables easy to read when printed on the command line.

-function

Output the contents of the Functions view.

-heatmap "<source>"

Export the contents of the Heat Map to a text file. <source> must match the name of the activity source for the Heat Map in the capture. Default = "CPU Activity".

-individual-threads

Use this option with -timeline, -callpath, or -all, to produce report files specific to each thread. The thread ID is included in each generated filename. You must specify the process that the threads belong to using -process.

-log

Output the contents of the Log view.

-o, -output <output_directory>

Send all report text to files in the specified directory. If you specify multiple tables for export, each table is written to <output_directory> in a new file with an appropriate name. If you specify multiple captures, each capture is output to a subdirectory of <output_directory> with a name matching the capture.

-opencl

If there is an OpenCL table, output the contents.

-per_core

Output per-core data when used with the option.

-process <regex>#<PID>

A string specifying the process to inspect. The first part of the string is a regular expression that matches the name of the process. The second part is a '#' character followed by the numeric ID of the process. Both parts can be used together or individually.

Examples of valid arguments are:

  • -process=.sampleApp

  • -process=.sampleApp#1234

  • -process=#1234

-scale <number>

Set the number of bins per second to use in the report. Default = 1,000.

-start <seconds>

Filter output data to start at the specified time in the timeline. For example, if you enter -start 0.005, all data before the 5 millisecond mark is not included in the output.

-stop <seconds>

Filter output data to stop at the specified time in the timeline.

-template <name_or_path>

The template to apply. Streamline searches each template in the following order:

  1. In the file captured.xml.

  2. In the built-in templates.

  3. In the Templates directory.

  4. As a file path (*.st).

You can apply more than one -template option. To create a chart configuration template, see Create a chart configuration template.

-default-template

Ignore the templates from the capture and load Streamline's default template.

-thread <regex>#<TID>

A string specifying the thread to inspect. Like -process, it consists of two parts. The first part of the string is a regular expression that matches the name of the thread. The second part is a '#' character followed by the numeric ID of the thread. Both parts can be used together or individually. To use thread filtering, you must specify the process that the threads belong to using -process.

Examples of valid arguments are:

  • -thread=Thread(.*)

  • -thread=Thread(.*)#1234

  • -thread=#1234

-timeline

Output the contents of the Timeline view.

-warnings[=<name>]

Produce the warnings table. <name> specifies the filename to use for the output. Default = warnings.csv.

Returns

A capture analysis report.

Example: Output multiple report types.

To output the Call Paths and Functions data from the capture thread_001.apc, enter:

streamline -report -callpath -function thread_001.apc

Example: Output timeline data to a text file.

It can be useful to output very large reports to a file, then import the data into a spreadsheet application.

To output the timeline data from capture_001.apc to a file called output.txt, enter:

streamline -report -timeline capture_001.apc -o output.txt

If output.txt is an existing file, it is overwritten with the new data.

Timeline view data output to a text file