...
Below is the list of built-in Listeners provided with the new system.
JSON Report
...
Configurable diagnostic report written in JSON format listener: a configurable report that writes diagnostic data to a hierarchical JSON document at render exit and on checkpoint exits.
Print Listener
A "Hello World" example Listener which prints raw data to the console.
Snapshot Listener
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.
Telemetry 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 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. |
|
| Comment |
|---|
Live StreamLive streaming is enabled at the Session level which then allows any supporting client to attach. |
...
