Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The data coming out of the stats system can be translated and presented in any number of ways depending on the analysis needs. The most basic listener is the example "Hello World" Print Listener which will write data directly to the console as it is receivedListener plugin framework is designed for extensibility but there is some basic functionality that is built into the system.

Built-in Listeners

Below is the list of built-in Listeners provided with the new system.

JSON Report Listener

Configurable diagnostic report written in JSON format at render end exit and on checkpoint exits.

Print Listener

...

Formatted output for testing, debugging, or benchmarks. Can stream JSON-formatted data to the console during a render, or write a final-report CSV file.


Comment
Listener TypeDescriptionUseNotes
jsonreportWrite hierarchical metric data to a JSON file.An end-of render JSON report, including checkpoint/resume support.Default is currently to write all checkpoints but this can be disabled in the listener configuration. See JSON Report Listener reference
printWrite metric data to std::out.Writes raw output to the console.The "Hello World" of example listeners.
snapshotWrite a summary of render stats to the console.An end-of-render summary that is comparable with the legacy stats summary, plus optional extra metric data. The summary is also available mid-render by specifying "trigger" events.For RIB or Preview renders only, does not yet write a snapshot when Live/IPR renders are canceled.
telemetryStream of data or report to CSVBenchmarks or debuggingCan be an end-of-render CSV report written to disk, or can be a live stream of metrics to the console as the render progresses.
Comment

Live Stream

Live streaming is enabled at the Session level which then allows any supporting client to attach.