Collect queryable GPU Trace report
collect_gpu_trace_reportRun a GPU Trace replay to obtain a report ID for querying metrics, ranges, and shader occupancy.
Instructions
Run a feature-rich Nsight GPU Trace replay, retain its report and auto-export tables in a report session, and return a report_id. Query that id with the metric, range, trace-information, and shader-occupancy tools. Collection executes instrumented GPU work and can take several minutes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gpu_clocks | No | GPU clock policy during collection. | unaltered |
| architecture | No | Optional Nsight architecture override. By default it is inferred from capture metadata. | |
| capture_path | Yes | Absolute or working-directory-relative path to an .ngfx-capture or .ngfx-bincap file. | |
| timeout_seconds | No | ||
| output_directory | No | Optional parent directory for persistent report artifacts. Without it, artifacts are created under the OS temp directory and deleted by release_gpu_trace_report; an abnormal process exit can leave temp files behind. | |
| time_every_action | No | Ask Nsight to collect per-action timings. This adds profiler overhead. | |
| collect_screenshot | No | Include the profiler screenshot artifact used by Nsight's Summary view. | |
| collect_external_shader_debug_info | No | Allow Nsight to resolve external shader debug information for source and line correlation. Availability still depends on the captured shaders. |