Configuration controls how often the monitor reads statistics, which problems it detects, and what it includes in samples. Start with the defaults, then change settings for a concrete requirement: faster local feedback, less traffic, or a detector that needs different thresholds for your product.

Configure a monitor#

const monitor = new ClientMonitor({
  clientId: 'participant-42',
  callId: 'room-123',
  collectingPeriodInMs: 1000,
  samplingPeriodInMs: 5000,
  congestionDetector: null,
});

This example collects every second, sends a sample every five seconds, and disables the deprecated congestion detector. It leaves the other detectors at their defaults. Faster collection increases the work done by getStats() and changes how much time a detection window covers.

Identity and local application data#

Collection and sample settings#

See collection and sampling for manual collection and sample boundaries.

Browser integration settings#

Sample detail settings#

How detection windows work#

A single bad measurement can be a brief fluctuation. Detection windows keep a recent sequence of measurements so detectors can judge sustained behavior. Recovery windows let them check whether a problem has settled before clearing it. These windows hold collected values, not outgoing samples.

With the default five-second collection interval, three values span two intervals, or about 10 seconds between the oldest and newest value. Four values span about 15 seconds. Collecting every second shortens those spans to two and three seconds. A detector can also use an independent time threshold or require other evidence, so these spans are not promises of an exact alert delay.

maxAllowedGapInMs defaults to four times a positive collection interval (20 seconds at the normal cadence). A gap larger than this prevents stale measurements from being treated as a continuous run. Think of a laptop waking from sleep: measurements before sleep should not be joined to the first measurement after wake as if the call had been continuously observed.

const monitor = new ClientMonitor({
  collectingPeriodInMs: 1000,
  inboundTrackWindow: {
    numberOfSamples: {
      detection: 3,
      recovery: 3,
      flowDetection: 4,
      flowRecovery: 3,
    },
    maxAllowedGapInMs: 4000,
  },
});

Supply the complete window object when overriding it. Tune against real sessions: shorter windows respond sooner but can react to transient fluctuations; longer windows need more evidence and react later.

Enable, disable, or tune a detector#

Nested objects are not deep-merged. Copy the complete detector configuration before changing a threshold; {} is only appropriate when that detector has no required tunables. BlockedInboundMediaDetector is off by default because its evidence is not generally available with browser RTCP multiplexing. The deprecated CongestionDetector remains enabled by default in 4.10.1.

Detector option reference#

The table below lists every detector option and its complete default settings in Client Monitor 4.10.1. Values ending in InMs are milliseconds; ratios are fractions unless the detector guide states otherwise. Use the detector catalog to understand the evidence before tuning a number. Newer installed versions can add or change options; their TypeScript configuration is the authority for that version.

Detailed detector types and implementation evidence.

Sources: ClientMonitor constructor, ClientMonitorConfig, Detectors.