Overview

This tool is designed to export raw data collected by NVIDIA Nsight Systems. It does no data processing other than conversion to the selected format. It’s available as nsys-exporter binary in Windows and Linux distributions of Nsight Systems.

Currently all events can be exported as JSON or text, while SQLite export supports only subset of collected data: NVTX, CUDA, OpenGL, OSRT.

Required Software

NVIDIA nsys-exporter doesn’t require any third-party software to work, but it uses some resources from the parent Nsight Systems project.

Usage

If invoked with -h, --help option the tool will print usage instructions:

Usage: nsys-exporter [OPTIONS] INPUT-FILE [OUTPUT-FILE]

Export events from .qdrep files into selected format.
If output file name is omitted, then it's created in current directory with
the name of input file and the extension replaced depending on output format.
If '-' is specified as an output file name then stdout is used instead.

NOTICE: This tool is BETA. Output format and available options may change in the future.

nsys-exporter options:
  -h [ --help ]           Print help message.
  -i [ --target-info ]    Print targets properties in JSON format.
  -f [ --force ]          Force overwriting of output file in case it exists.
                          Default - print error message and exit.
  -s [ --export-sqlite ]  Export into sqlite3 database.
  --export-hdf            Export into HDF5 database. (experimental)
  -t [ --export-text ]    Print all events, strings, thread names in text
                          format.
  -j [ --export-json ]    Print all events, strings, thread names in JSON
                          format: one object per line as in JSON Lines format.
  -l [ --line-by-line ]   Split strings, thread names onto separate lines. This
                          affects JSON and text output only.

Typically, you will only need to pass the path to Nsight Systems report file and desired output format: ./nsys-exporter path/to/some.qdrep -s. This will export given report into SQLite database file located in current directory and named some.sqlite.

For text and JSON formats using stdout may be preferred. In that case invoke exporter as: ./nsys-exporter path/to/some.qdrep -j -- -.