Docs

ObserveRTC is an open-source toolkit for monitoring WebRTC applications: a browser library that turns getStats() into actionable verdicts, a Node.js library that correlates those verdicts across participants, and a versioned schema that ties them together.

Start here

Introduction

What ObserveRTC is, what it gives you, and who it is for.

Architecture

How the pieces fit together, and where the client/server line is drawn.

The libraries

client-monitor-js

Browser-side monitoring: derived metrics, quality scores, and detectors that raise and resolve issues with hysteresis.

observer-js

Server-side analysis: a live model of every call plus cross-participant detection that answers what no single browser can.

sample-encoder-js

Compress samples before upload.

sample-decoder-js

Decode them on the server.

The schema

Schema overview

One contract shared by every component, generated from Avro.

ClientSample reference

Every record and field, generated from schema 3.3.0.

Version history

What changed in each release since 3.0.0, field by field.

Quick install

npm install @observertc/client-monitor-js

import { ClientMonitor } from "@observertc/client-monitor-js";

const monitor = new ClientMonitor({ clientId, callId, samplingPeriodInMs: 4000 });
monitor.addSource(peerConnection);
monitor.on("sample-created", (sample) => transport.send(sample));

npm install @observertc/observer-js

import { Observer } from "@observertc/observer-js";

const observer = new Observer({ closeClientIfIdleForMs: 60_000 });
observer.on("client-issue-resolved", ({ resolvedIssue }) => log.info(resolvedIssue));

transport.on("sample", (sample) => observer.accept(sample));

npm install @observertc/client-monitor-js @observertc/samples-encoder   # browser
npm install @observertc/observer-js @observertc/samples-decoder         # server