Page tree

Versions Compared

Key

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

...

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

type "snapshot"

Options

Listener Options

Description

Required?

Default

type

Must be "snapshot"

y


name

Unique name of the listener

y

""

samplingInterval

Sampling interval in MS for built-in summary stats.

n

1000 (1 second)

triggerEvents

Regular expression of event-based metrics that will trigger a snapshot to be written

n

""

Metric Rules




regexp

Additional metric to include in the snapshot summary

n

""

samplingInterval

Sampling interval in MS for the auxiliary snapshot stats requested in regexp param.

n

6000 (1 minute)

Note

To receive triggered snapshots with auxiliary metrics care must be taken to ensure the sampling interval of the auxiliary metrics is less than or equal to the reporting cadence of the trigger event(s). If the snapshot shows missing aux data, try lowering the samplingInterval for that metric's rule.

...