JSON file output, checkpoint/resume support

Description

Metric data gathered is written to a hierarchical JSON file. A final report is written at render termination, with intermediary stats written on checkpoint-exit events. Optionally (default: True) the data from each checkpoint will also be written.

Configuration

Required type for configuring the JSON report listener from an ini file.

type "jsonreport"

Options

Configuration Example

The following excerpt from a configuration file will enable the JSON report output, writing to: checkpoint_stats.json. The MetricRules section indicates that all metrics should be gathered, with data sampled once per second. See below for an example output for this configuration.

[Listener]
    type "json"
    name "jsonListener"
    outputFilename "checkpoint_stats.json"
	keepAllCheckpoints 1

[MetricRules]
    # Save all metrics to the JSON file, sampled once per second
    [Rule]
    regexp ".*"
    samplingInterval 1000

Output Example

prman -statsconfig checkpoint_stats.ini -recover 1 scene.rib

Metric data block omitted for brevity. Actual iteration values will vary depending on your run.

{
  "header": {
    "version": "24.0b1"
  },
  "frame": {
    "attempts": [
      {
        "iteration": 20,
        "metrics": {...},
        "reason": "checkpoint"
      },
      {
        "iteration": 62,
        "metrics": {...},
        "reason": "checkpoint"
      },
      {
        "iteration": 83,
        "metrics": {...},
        "reason": "exiting"
      },
      {
        "metrics": {...},
      }
    ]
  }
}