Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

ClientMonitorConfig: { accumulator?: AccumulatorConfig; collectingPeriodInMs?: number; collectors?: CollectorConfig; maxListeners?: number; sampler: SamplerConfig; samplingPeriodInMs?: number; sender?: SenderConfig; sendingPeriodInMs?: number; statsExpirationTimeInMs?: number }

Type declaration

  • Optional accumulator?: AccumulatorConfig

    If the sender component is configured, accumulator sets the buffer between sampling and sending.

  • Optional collectingPeriodInMs?: number

    By setting it, the observer calls the added statsCollectors periodically and pulls the stats.

    DEFAULT: undefined

  • Optional collectors?: CollectorConfig

    Collector Component related configurations

  • Optional maxListeners?: number

    Sets the maximum number of listeners for event emitters

  • sampler: SamplerConfig

    Sampling Component Related configurations

  • Optional samplingPeriodInMs?: number

    By setting it, the observer make samples periodically.

    DEFAULT: undefined

  • Optional sender?: SenderConfig

    Sending Component Related congurations

    default: undefined, means no sample is sent

  • Optional sendingPeriodInMs?: number

    By setting it, the observer sends the samples periodically.

    DEFAULT: undefined

  • Optional statsExpirationTimeInMs?: number

    By setting it stats items and entries are deleted if they are not updated.

    DEFAULT: undefined

Functions

  • setLogLevel(level: LogLevelDesc): void
  • Sets the level of logging of the module

    possible values are: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "SILENT"

    Parameters

    • level: LogLevelDesc

    Returns void

Generated using TypeDoc