The data coming out of the stats system can be translated and presented in any number of ways depending on the analysis needs. The Listener 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.
Configurable diagnostic report written in JSON format at render exit and on checkpoint exits.
A "Hello World" example Listener which prints raw data to the console.
Prints a snapshot of stats on demand or at the end of a render. The snaphshot is a summary plus a configurable set of additional metrics.
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.
Listener Type | Description | Use | Notes |
---|
jsonreport | Write 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 | print | Write metric data to std::out. | Writes raw output to the console. | The "Hello World" of example listeners. | snapshot | Write 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. | telemetry | Stream of data or report to CSV | Benchmarks or debugging | Can 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. |
|
Live StreamLive streaming is enabled at the Session level which then allows any supporting client to attach. |