Page tree

Versions Compared

Key

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

...

Listener Options

Type

Description

Required?

Default

type

string

Must be "telemetry"

y


name

string

Unique name of the listener

y

""

outputFilename

stringThe 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 the preceding regexp param.

n

1000ms

The outputFilename setting can include environment variables which will be expanded when processed by the Listener. Standard environment variable formats are supported, as well as Linux shell variable expansion syntax:

    $VAR
${VAR}
${VAR:-fallback}
${VAR:=fallback}

Configuration Example

Enable streaming telemetry output 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.

...