Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StatsEventListener

Package version

An interface that describes the possible events that will be emitted from a Stats instance. Stats exporters should implement this interface.

Hierarchy

  • StatsEventListener

Index

Methods

onRecord

  • Is called whenever a new measurement is recorded.

    deprecated

    since version 0.0.9 - use start instead

    Parameters

    • views: View[]

      The views related to the measurement

    • measurement: Measurement

      The recorded measurement

    • tags: Map<TagKey, TagValue>

      The tags to which the value is applied

    Returns void

onRegisterView

  • onRegisterView(view: View): void
  • Is called whenever a new view is registered

    deprecated

    since version 0.0.9 - use start instead

    Parameters

    • view: View

      The registered view

    Returns void

start

  • start(): void
  • Starts the exporter that polls Metric from Metrics library and send batched data to backend.

    Returns void

stop

  • stop(): void
  • Stops the exporter.

    Returns void

Generated using TypeDoc