Page tree

Versions Compared

Key

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

CSV or JSON-style stream of Stream metric data to a file and/or to the console.

...

An advanced "print" listener outputting a CSV report with optional live data written in JSON format, with the option for an end-of-render CSV outputstreamed to the console.

Configuration

Required type for configuring the Telemetry listener from an ini file.

type "telemetry"

Options

Listener Options

Type

Description

Required?

Default

type

string

Must be "telemetry"

y


name

string

Unique name of the listener

y

""

outputFilename

string
File name
The filename of the final report.y""
streamToConsoleboolSet true for live streaming of metric values to stdoutn0

Metric Rules





regexp

string

One or more metrics to be observed. If this is empty no metrics are reported.

n

""

samplingInterval

integer

Sampling interval in MS for the metrics requested in preceding regexp param.

n

6000 (1 minute)


Configuration Example

Enable streaming telemetry output , sampled 2x pre second, with final CSV report written to: roz_telemetry.csv. Report all of the "numRays" metrics, sampling 4x per second, and report process memory and time once per second.

Code Block
languagejava
titletelemetry_stats.ini
[Listener]
    type "telemetry"
    name "telemetryListener"
    outputFilename "roz_telemetry.csv"
	streamToConsole 1


[MetricRules]
    # Sample raytracing "numRays" metrics 4x a second
    [Rule]
    regexp "/rman/raytracing.*numRays"
    samplingInterval 250
 
    # Sample process memory and time once a second
    [Rule]
    regexp "/system.processMemory|/system.processTime"
    samplingInterval 1000

...