@observertc/client-monitor-js 3.3.1 → 3.4.1-e6caa47.0

package/README.md

@@ -1,23 +1,22 @@
-Javascript library to monitor WebRTC applications
----
+## Javascript library to monitor WebRTC applications
 
 @observertc/client-monitor-js is a client side library to monitor [WebRTCStats](https://www.w3.org/TR/webrtc-stats/) and to integrate your app to observertc components.
 
 Table of Contents:
 
- * [Quick Start](#quick-start)
- * [Integrations](#integrations)
-    - [Mediasoup](#mediasoup)
- * [Detectors and Alerts](#detectors-and-alerts)
-    - [Audio Desync Detector](#audio-desync-detector)
-    - [CPU Performance Detector](#cpu-performance-detector)
- * [Calculated updates](#calculated-updates)
- * [Configurations](#configurations)
- * [NPM package](#npm-package)
- * [API docs](#api-docs)
- * [Schemas](#schemas)
- * [Getting Involved](#getting-involved)
- * [License](#license)
+-   [Quick Start](#quick-start)
+-   [Integrations](#integrations)
+    -   [Mediasoup](#mediasoup)
+-   [Detectors and Alerts](#detectors-and-alerts)
+    -   [Audio Desync Detector](#audio-desync-detector)
+    -   [CPU Performance Detector](#cpu-performance-detector)
+-   [Calculated updates](#calculated-updates)
+-   [Configurations](#configurations)
+-   [NPM package](#npm-package)
+-   [API docs](#api-docs)
+-   [Schemas](#schemas)
+-   [Getting Involved](#getting-involved)
+-   [License](#license)
 
 ## Qucik Start
 
@@ -38,7 +37,7 @@ const config = {
 const monitor = createClientMonitor(config);
 const statsCollector = monitor.collectors.collectFromRTCPeerConnection(peerConnection);
 
-monitor.on('stats-collected', () => {
+monitor.on("stats-collected", () => {
     const storage = monitor.storage;
     for (const inboundRtp of storage.inboundRtps()) {
         const trackId = inboundRtp.getTrackId();
@@ -51,11 +50,11 @@ statsCollector.close();
 ```
 
 The above example do as follows:
- 1. create a client monitor, which collect stats every 5s
- 2. setup a stats collector from a peer connection
- 3. register an event called after stats are collected
- 4. print out the inbound rtps and then close the stats collector we registered in step 3.
 
+1.  create a client monitor, which collect stats every 5s
+2.  setup a stats collector from a peer connection
+3.  register an event called after stats are collected
+4.  print out the inbound rtps and then close the stats collector we registered in step 3.
 
 ## Integrations
 
@@ -72,29 +71,28 @@ const config = {
 const monitor = createClientMonitor(config);
 const mediasoupStatsCollector = monitor.collectors.collectFromMediasoupDevice(mediasoupDevice);
 
-monitor.on('stats-collected', () => {
+monitor.on("stats-collected", () => {
     // do your stuff
 
-    // you can close detach mediasoup 
+    // you can close detach mediasoup
     // collector by calling the close
     mediasoupStatsCollector.close();
-})
+});
 ```
 
-**Important Note**: The created collector is hooked on the device 'newtransport' event, 
+**Important Note**: The created collector is hooked on the device 'newtransport' event,
 and can detect transports automatically when they are created after the device is added.
 If you create transports before you add the device to the monitor,  
-transports you created before will not be monitored automatically, you need to add them 
+transports you created before will not be monitored automatically, you need to add them
 to the statscollector, like this:
 
 ```javascript
-const myTransport = // your transport created before the device is added to the monitor
-mediasoupStatsCollector.addTransport(myTransport)
+const myTransport = mediasoupStatsCollector.addTransport(myTransport); // your transport created before the device is added to the monitor
 ```
 
 ## Calculated Updates
 
-The Calculated Updates lets you observer metrics derived from the polled webrtc stats  captured by the library. These calculated updates provide a richer, more nuanced understanding of your application's client-side behavior, offering valuable insights beyond what raw stats metrics can give you.
+The Calculated Updates lets you observer metrics derived from the polled webrtc stats captured by the library. These calculated updates provide a richer, more nuanced understanding of your application's client-side behavior, offering valuable insights beyond what raw stats metrics can give you.
 
 ### Storage Updates
 
@@ -119,7 +117,7 @@ monitor.on('stats-collected', () => {
 ### PeerConnection Updates
 
 ```javascript
-import { createClientMonitor } from 'client-monitor-js';
+import { createClientMonitor } from "client-monitor-js";
 
 // Create a ClientMonitor instance
 const monitor = createClientMonitor({
@@ -127,22 +125,21 @@ const monitor = createClientMonitor({
 });
 
 const storage = monitor.storage;
-monitor.on('stats-collected', () => {
+monitor.on("stats-collected", () => {
     for (const peerConnection of storage.peerConnections()) {
-        console.log('average RTT in seconds', peerConnection.avgRttInS);
-        console.log('Sending audio bitrate on PC', peerConnection.sendingAudioBitrate);
-        console.log('Sending video bitrate on PC', peerConnection.sendingVideoBitrate);
-        console.log('Receiving audio bitrate on PC', peerConnection.receivingAudioBitrate);
-        console.log('Receiving video bitrate on PC', peerConnection.receivingVideoBitrate);
+        console.log("average RTT in seconds", peerConnection.avgRttInS);
+        console.log("Sending audio bitrate on PC", peerConnection.sendingAudioBitrate);
+        console.log("Sending video bitrate on PC", peerConnection.sendingVideoBitrate);
+        console.log("Receiving audio bitrate on PC", peerConnection.receivingAudioBitrate);
+        console.log("Receiving video bitrate on PC", peerConnection.receivingVideoBitrate);
     }
 });
-
 ```
 
 ### Inbound RTP stats updates
 
 ```javascript
-import { createClientMonitor } from 'client-monitor-js';
+import { createClientMonitor } from "client-monitor-js";
 
 // Create a ClientMonitor instance
 const monitor = createClientMonitor({
@@ -150,24 +147,22 @@ const monitor = createClientMonitor({
 });
 
 const storage = monitor.storage;
-monitor.on('stats-collected', () => {
+monitor.on("stats-collected", () => {
     for (const inboundRtp of storage.inboundRtps()) {
+        console.log("mean opinion score for inbound-rtp", inboundRtp.score);
 
-        console.log('mean opinion score for inbound-rtp', inboundRtp.score);
-
-        console.log('receiving bitrate', inboundRtp.receivingBitrate);
-        console.log('lost packets since last stats-collected', inboundRtp.lostPackets);
-        console.log('received packets since last stats-collected', inboundRtp.receivedPackets);
-        console.log('decoded frames since last stats-collected', inboundRtp.decodedFrames);
+        console.log("receiving bitrate", inboundRtp.receivingBitrate);
+        console.log("lost packets since last stats-collected", inboundRtp.lostPackets);
+        console.log("received packets since last stats-collected", inboundRtp.receivedPackets);
+        console.log("decoded frames since last stats-collected", inboundRtp.decodedFrames);
     }
 });
-
 ```
 
 ### Outbound RTP stats updates
 
 ```javascript
-import { createClientMonitor } from 'client-monitor-js';
+import { createClientMonitor } from "client-monitor-js";
 
 // Create a ClientMonitor instance
 const monitor = createClientMonitor({
@@ -175,19 +170,20 @@ const monitor = createClientMonitor({
 });
 
 const storage = monitor.storage;
-monitor.on('stats-collected', () => {
+monitor.on("stats-collected", () => {
     for (const outboundRtp of storage.outboundRtps()) {
+        console.log("stability score outbound-rtp", outboundRtp.score);
 
-        console.log('stability score outbound-rtp', outboundRtp.score);
+        console.log("sending bitrate", outboundRtp.sendingBitrate);
+        console.log("sent packets since last stats-collected", outboundRtp.sentPackets);
 
-        console.log('sending bitrate', outboundRtp.sendingBitrate);
-        console.log('sent packets since last stats-collected', outboundRtp.sentPackets);
-        
         const remoteInboundRtp = outboundRtp.getRemoteInboundRtp();
-        console.log('Received packets on remote inbound-rtp belongs to this outbound-rtp', remoteInboundRtp?.receivedPackets);
+        console.log(
+            "Received packets on remote inbound-rtp belongs to this outbound-rtp",
+            remoteInboundRtp?.receivedPackets
+        );
     }
 });
-
 ```
 
 ## Detectors and Alerts
@@ -195,8 +191,9 @@ monitor.on('stats-collected', () => {
 Detectors and alerts provide events of tracking and responding to anomalies or performance issues based on the polled stats. Detectors are components that continuously monitor for specific conditions in the polled stats, and set an alert if certain thresholds are hit. You can subscribe to alerts of an instantiated client-monitor-js and configure detectors via initial configurations.
 
 List of built-in alerts:
- * `audio-desync-alert`: triggered when for an audio track several acceleration and deceleration is detected in a short amount of time indicating that the controlling system tries compensate discrepancies. 
- * `cpu-performance-alert`: triggered whenever a browser detects quality limitation becasue of CPU, or the number of decoded frames per sec hit a certain threshold
+
+-   `audio-desync-alert`: triggered when for an audio track several acceleration and deceleration is detected in a short amount of time indicating that the controlling system tries compensate discrepancies.
+-   `cpu-performance-alert`: triggered whenever a browser detects quality limitation becasue of CPU, or the number of decoded frames per sec hit a certain threshold
 
 ### Audio Desync Detector
 
@@ -275,24 +272,19 @@ const config = {
     /**
      * By setting it, the monitor calls the added statsCollectors periodically
      * and pulls the stats.
-     * 
-     * DEFAULT: undefined
+     *
+     * DEFAULT: 5000
      */
     collectingPeriodInMs: 5000,
-    /**
-     * By setting it, the monitor make samples periodically.
-     * 
-     * DEFAULT: undefined
-     */
-    samplingPeriodInMs: 10000,
 
     /**
-     * This is the interval the monitor periodically checks
-     * if collecting or sampling action should be invoked or not.
-     * 
-     * DEFAULT: if collecting or sampling period is set the default value is 1000, otherwise it's undefined
+     * By setting this, the observer makes samples after n number or collected stats.
+     *
+     * For example if the value is 10, the observer makes a sample after 10 collected stats (in every 10 collectingPeriodInMs).
+     *
+     * DEFAULT: 1
      */
-    tickingTimeInMs: 10000,
+    samplingTick: 1,
 };
 ```
 
@@ -308,11 +300,10 @@ https://observertc.org/docs/api/client-monitor-js-v2/
 
 https://github.com/observertc/schemas
 
-
 ## Getting Involved
 
-Client-monitor is made with the intention to provide an open-source monitoring solution for 
-WebRTC developers. If you are interested in getting involved 
+Client-monitor is made with the intention to provide an open-source monitoring solution for
+WebRTC developers. If you are interested in getting involved
 please read our [contribution](CONTRIBUTING.md) guideline.
 
 ## License

package/lib/ClientMonitor.d.ts

@@ -16,17 +16,13 @@ export type ClientMonitorConfig = {
      */
     collectingPeriodInMs?: number;
     /**
-     * By setting this, the observer makes samples periodically.
+     * By setting this, the observer makes samples after n number or collected stats.
      *
-     * DEFAULT: undefined
-     */
-    samplingPeriodInMs?: number;
-    /**
-     * Sets the ticking time of the timer that invokes processes for collecting, sampling, and sending.
+     * For example if the value is 10, the observer makes a sample after 10 collected stats (in every 10 collectingPeriodInMs).
      *
-     * DEFAULT: 1000
+     * DEFAULT: undefined
      */
-    tickingTimeInMs?: number;
+    samplingTick?: number;
 };
 export type AlertState = 'on' | 'off';
 export interface ClientMonitorEvents {
@@ -101,10 +97,11 @@ export declare class ClientMonitor extends TypedEventEmitter<ClientMonitorEvents
     };
     private readonly _detectors;
     private readonly _sampler;
-    private readonly _timer;
+    private _timer?;
     private _lastCollectedAt;
     private _lastSampledAt;
     private _closed;
+    private _actualCollectingTick;
     constructor(_config: ClientMonitorConfig);
     get closed(): boolean;
     close(): void;
@@ -118,7 +115,7 @@ export declare class ClientMonitor extends TypedEventEmitter<ClientMonitorEvents
     addCustomCallEvent(event: CustomCallEvent): void;
     addLocalSDP(localSDP: string[]): void;
     setCollectingPeriod(collectingPeriodInMs: number): void;
-    setSamplingPeriod(samplingPeriodInMs: number): void;
+    setSamplingTick(samplingTick: number): void;
     get audioDesyncDetector(): {
         id: string;
         update: () => Promise<void>;
@@ -132,6 +129,26 @@ export declare class ClientMonitor extends TypedEventEmitter<ClientMonitorEvents
     addCongestionDetector(config?: CongestionDetectorConfig): void;
     getTrackStats(trackId: string): TrackStats | undefined;
     getPeerConnectionStats(peerConnectionId: string): PeerConnectionEntry | undefined;
+    get codecs(): import("./entries/StatsEntryInterfaces").CodecEntry[];
+    get inboundRtps(): import("./entries/StatsEntryInterfaces").InboundRtpEntry[];
+    get outboundRtps(): import("./entries/StatsEntryInterfaces").OutboundRtpEntry[];
+    get remoteInboundRtps(): import("./entries/StatsEntryInterfaces").RemoteInboundRtpEntry[];
+    get remoteOutboundRtps(): import("./entries/StatsEntryInterfaces").RemoteOutboundRtpEntry[];
+    get mediaSources(): import("./entries/StatsEntryInterfaces").MediaSourceEntry[];
+    get contributingSources(): import("./entries/StatsEntryInterfaces").ContributingSourceEntry[];
+    get dataChannels(): import("./entries/StatsEntryInterfaces").DataChannelEntry[];
+    get transceivers(): import("./entries/StatsEntryInterfaces").TransceiverEntry[];
+    get senders(): import("./entries/StatsEntryInterfaces").SenderEntry[];
+    get receivers(): import("./entries/StatsEntryInterfaces").ReceiverEntry[];
+    get transports(): import("./entries/StatsEntryInterfaces").TransportEntry[];
+    get sctpTransports(): import("./entries/StatsEntryInterfaces").SctpTransportEntry[];
+    get iceCandidatePairs(): import("./entries/StatsEntryInterfaces").IceCandidatePairEntry[];
+    get iceLocalCandidates(): import("./entries/StatsEntryInterfaces").LocalCandidateEntry[];
+    get iceRemoteCandidates(): import("./entries/StatsEntryInterfaces").RemoteCandidateEntry[];
+    get certificates(): import("./entries/StatsEntryInterfaces").CertificateEntry[];
+    get iceServers(): import("./entries/StatsEntryInterfaces").IceServerEntry[];
+    get peerConnections(): PeerConnectionEntry[];
+    get tracks(): TrackStats[];
     private _setupTimer;
 }
 //# sourceMappingURL=ClientMonitor.d.ts.map

package/lib/ClientMonitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClientMonitor.d.ts","sourceRoot":"","sources":["../src/ClientMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC7F,OAAO,EAAE,cAAc,EAAoB,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAKzD,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAEjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAI1E,MAAM,MAAM,mBAAmB,GAAG;IAE9B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,KAAK,CAAC;AAEtC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,OAAO,EAAE,SAAS,CAAC;IACnB,iBAAiB,EAAE;QACf,6BAA6B,EAAE,MAAM,CAAC;QACtC,cAAc,EAAE,cAAc,CAAC;KAClC,CAAC;IACF,gBAAgB,EAAE;QACd,0BAA0B,EAAE,MAAM,CAAC;QACnC,YAAY,EAAE,YAAY,CAAC;KAC9B,CAAC;IAEF,kBAAkB,EAAE,UAAU,CAAC;IAC/B,oBAAoB,EAAE,UAAU,CAAC;IACjC,uBAAuB,EAAE,UAAU,CAAC;CACvC;AAED,qBAAa,aAAc,SAAQ,iBAAiB,CAAC,mBAAmB,CAAC;IAkBjE,OAAO,CAAC,OAAO;IAjBnB,SAAgB,IAAI,EAAE,cAAc,CAAC;IACrC,SAAgB,OAAO,eAAsB;IAC7C,SAAgB,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAEvB;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAExB;IAEH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IAExC,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,OAAO,CAAS;gBAGZ,OAAO,EAAE,mBAAmB;IA+BxC,IAAW,MAAM,YAEhB;IAEM,KAAK,IAAI,IAAI;IAYP,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC;IAYxC,MAAM,IAAI,YAAY,GAAG,SAAS;IAclC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM;IAIxB,eAAe,CAAC,GAAG,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAchD,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAIrC,mBAAmB,CAAC,UAAU,EAAE,sBAAsB,GAAG,qBAAqB,GAAG,IAAI;IAIrF,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IAQ7C,kBAAkB,CAAC,KAAK,EAAE,eAAe;IAIzC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAIrC,mBAAmB,CAAC,oBAAoB,EAAE,MAAM,GAAG,IAAI;IAKvD,iBAAiB,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI;IAK1D,IAAW,mBAAmB;;;;;kBAE7B;IAEM,sBAAsB,CAAC,MAAM,CAAC,EAAE,yBAAyB;IAOhE,IAAW,sBAAsB,+CAEhC;IAEM,yBAAyB,CAAC,MAAM,CAAC,EAAE,4BAA4B;IAOtE,IAAW,kBAAkB,+CAE5B;IAEM,qBAAqB,CAAC,MAAM,CAAC,EAAE,wBAAwB;IAYvD,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAItD,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAIxF,OAAO,CAAC,WAAW;CAsBtB"}
+{"version":3,"file":"ClientMonitor.d.ts","sourceRoot":"","sources":["../src/ClientMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC7F,OAAO,EAAE,cAAc,EAAoB,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAIzD,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAEjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAI1E,MAAM,MAAM,mBAAmB,GAAG;IAE9B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,KAAK,CAAC;AAEtC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,OAAO,EAAE,SAAS,CAAC;IACnB,iBAAiB,EAAE;QACf,6BAA6B,EAAE,MAAM,CAAC;QACtC,cAAc,EAAE,cAAc,CAAC;KAClC,CAAC;IACF,gBAAgB,EAAE;QACd,0BAA0B,EAAE,MAAM,CAAC;QACnC,YAAY,EAAE,YAAY,CAAC;KAC9B,CAAC;IAEF,kBAAkB,EAAE,UAAU,CAAC;IAC/B,oBAAoB,EAAE,UAAU,CAAC;IACjC,uBAAuB,EAAE,UAAU,CAAC;CACvC;AAED,qBAAa,aAAc,SAAQ,iBAAiB,CAAC,mBAAmB,CAAC;IAmBjE,OAAO,CAAC,OAAO;IAlBnB,SAAgB,IAAI,EAAE,cAAc,CAAC;IACrC,SAAgB,OAAO,eAAsB;IAC7C,SAAgB,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAEvB;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAExB;IAEH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,OAAO,CAAC,MAAM,CAAC,CAAiC;IAEhD,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,qBAAqB,CAAK;gBAGtB,OAAO,EAAE,mBAAmB;IA+BxC,IAAW,MAAM,YAEhB;IAEM,KAAK,IAAI,IAAI;IAaP,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC;IAgBxC,MAAM,IAAI,YAAY,GAAG,SAAS;IAclC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM;IAIxB,eAAe,CAAC,GAAG,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAchD,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAIrC,mBAAmB,CAAC,UAAU,EAAE,sBAAsB,GAAG,qBAAqB,GAAG,IAAI;IAIrF,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IAQ7C,kBAAkB,CAAC,KAAK,EAAE,eAAe;IAIzC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAIrC,mBAAmB,CAAC,oBAAoB,EAAE,MAAM,GAAG,IAAI;IAKvD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAKlD,IAAW,mBAAmB;;;;;kBAE7B;IAEM,sBAAsB,CAAC,MAAM,CAAC,EAAE,yBAAyB;IAOhE,IAAW,sBAAsB,+CAEhC;IAEM,yBAAyB,CAAC,MAAM,CAAC,EAAE,4BAA4B;IAOtE,IAAW,kBAAkB,+CAE5B;IAEM,qBAAqB,CAAC,MAAM,CAAC,EAAE,wBAAwB;IAYvD,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAItD,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAIxF,IAAW,MAAM,0DAEhB;IAED,IAAW,WAAW,+DAErB;IAED,IAAW,YAAY,gEAEtB;IAED,IAAW,iBAAiB,qEAE3B;IAED,IAAW,kBAAkB,sEAE5B;IAED,IAAW,YAAY,gEAEtB;IAED,IAAW,mBAAmB,uEAE7B;IAED,IAAW,YAAY,gEAEtB;IAED,IAAW,YAAY,gEAEtB;IAED,IAAW,OAAO,2DAEjB;IAED,IAAW,SAAS,6DAEnB;IAED,IAAW,UAAU,8DAEpB;IAED,IAAW,cAAc,kEAExB;IAED,IAAW,iBAAiB,qEAE3B;IAED,IAAW,kBAAkB,mEAE5B;IAED,IAAW,mBAAmB,oEAE7B;IAED,IAAW,YAAY,gEAEtB;IAED,IAAW,UAAU,8DAEpB;IAED,IAAW,eAAe,0BAEzB;IAED,IAAW,MAAM,iBAEhB;IAED,OAAO,CAAC,WAAW;CAUtB"}

package/lib/ClientMonitor.js

@@ -29,7 +29,6 @@ const logger_1 = require("./utils/logger");
 const ClientMetaData_1 = require("./ClientMetaData");
 const StatsStorage_1 = require("./entries/StatsStorage");
 const TypedEmitter_1 = require("./utils/TypedEmitter");
-const Timer_1 = require("./utils/Timer");
 const Sampler_1 = require("./Sampler");
 const Adapter_1 = require("./collectors/Adapter");
 const validators = __importStar(require("./utils/validators"));
@@ -47,10 +46,10 @@ class ClientMonitor extends TypedEmitter_1.TypedEventEmitter {
             clientMonitor: this,
         });
         this._sampler = new Sampler_1.Sampler(this.storage);
-        this._timer = (0, Timer_1.createTimer)();
         this._lastCollectedAt = Date.now();
         this._lastSampledAt = 0;
         this._closed = false;
+        this._actualCollectingTick = 0;
         this.meta = new ClientMetaData_1.ClientMetaData();
         this._sampler.addBrowser(this.meta.browser);
         this._sampler.addEngine(this.meta.engine);
@@ -84,10 +83,11 @@ class ClientMonitor extends TypedEmitter_1.TypedEventEmitter {
             return;
         }
         this._closed = true;
-        this._timer.clear();
+        clearInterval(this._timer);
         this.storage.clear();
         this.collectors.clear();
         this._sampler.clear();
+        this._timer = undefined;
     }
     async collect() {
         const collectedStats = await this.collectors.collect();
@@ -98,6 +98,10 @@ class ClientMonitor extends TypedEmitter_1.TypedEventEmitter {
             elapsedSinceLastCollectedInMs: timestamp - this._lastCollectedAt,
         });
         this._lastCollectedAt = timestamp;
+        if (this._config.samplingTick && this._config.samplingTick <= ++this._actualCollectingTick) {
+            this._actualCollectingTick = 0;
+            this.sample();
+        }
         return collectedStats;
     }
     sample() {
@@ -154,8 +158,8 @@ class ClientMonitor extends TypedEmitter_1.TypedEventEmitter {
         this._config.collectingPeriodInMs = collectingPeriodInMs;
         this._setupTimer();
     }
-    setSamplingPeriod(samplingPeriodInMs) {
-        this._config.samplingPeriodInMs = samplingPeriodInMs;
+    setSamplingTick(samplingTick) {
+        this._config.samplingTick = samplingTick;
         this._setupTimer();
     }
     get audioDesyncDetector() {
@@ -196,27 +200,74 @@ class ClientMonitor extends TypedEmitter_1.TypedEventEmitter {
     getPeerConnectionStats(peerConnectionId) {
         return this.storage.getPeerConnection(peerConnectionId);
     }
+    get codecs() {
+        return [...this.storage.codecs()];
+    }
+    get inboundRtps() {
+        return [...this.storage.inboundRtps()];
+    }
+    get outboundRtps() {
+        return [...this.storage.outboundRtps()];
+    }
+    get remoteInboundRtps() {
+        return [...this.storage.remoteInboundRtps()];
+    }
+    get remoteOutboundRtps() {
+        return [...this.storage.remoteOutboundRtps()];
+    }
+    get mediaSources() {
+        return [...this.storage.mediaSources()];
+    }
+    get contributingSources() {
+        return [...this.storage.contributingSources()];
+    }
+    get dataChannels() {
+        return [...this.storage.dataChannels()];
+    }
+    get transceivers() {
+        return [...this.storage.transceivers()];
+    }
+    get senders() {
+        return [...this.storage.senders()];
+    }
+    get receivers() {
+        return [...this.storage.receivers()];
+    }
+    get transports() {
+        return [...this.storage.transports()];
+    }
+    get sctpTransports() {
+        return [...this.storage.sctpTransports()];
+    }
+    get iceCandidatePairs() {
+        return [...this.storage.iceCandidatePairs()];
+    }
+    get iceLocalCandidates() {
+        return [...this.storage.localCandidates()];
+    }
+    get iceRemoteCandidates() {
+        return [...this.storage.remoteCandidates()];
+    }
+    get certificates() {
+        return [...this.storage.certificates()];
+    }
+    get iceServers() {
+        return [...this.storage.iceServers()];
+    }
+    get peerConnections() {
+        return [...this.storage.peerConnections()];
+    }
+    get tracks() {
+        return [...this.storage.tracks()];
+    }
     _setupTimer() {
-        if (!this._config.tickingTimeInMs) {
+        this._timer && clearInterval(this._timer);
+        this._timer = undefined;
+        if (!this._config.collectingPeriodInMs)
             return;
-        }
-        if (this._config.collectingPeriodInMs) {
-            this._timer.setCollectingAction({
-                action: () => this.collect().then(() => {
-                    // empty
-                }),
-                fixedDelayInMs: this._config.collectingPeriodInMs,
-            });
-        }
-        if (this._config.samplingPeriodInMs) {
-            this._timer.setSamplingAction({
-                action: async () => {
-                    this.sample();
-                },
-                fixedDelayInMs: this._config.samplingPeriodInMs,
-            });
-        }
-        this._timer.tickTimeInMs = this._config.tickingTimeInMs;
+        this._timer = setInterval(() => {
+            this.collect().catch(err => logger.error(err));
+        }, this._config.collectingPeriodInMs);
     }
 }
 exports.ClientMonitor = ClientMonitor;

package/lib/entries/PeerConnectionEntryManifest.js

@@ -202,7 +202,7 @@ class PeerConnectionEntryManifest {
         entry.droppedFrames = (stats.framesDropped ?? 0) - (entry.stats.framesDropped ?? 0);
         entry.receivedSamples = (stats.totalSamplesReceived ?? 0) - (entry.stats.totalSamplesReceived ?? 0);
         entry.silentConcealedSamples = (stats.silentConcealedSamples ?? 0) - (entry.stats.silentConcealedSamples ?? 0);
-        entry.fractionLoss = entry.lostPackets / (entry.lostPackets + entry.receivedPackets);
+        entry.fractionLoss = entry.lostPackets === 0 && entry.receivedPackets === 0 ? 0 : entry.lostPackets / (entry.lostPackets + entry.receivedPackets);
         entry.stats = stats;
         entry.visited = true;
         if (entry.stats.kind === 'audio') {

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAC9F,YAAY,EACR,aAAa,EACb,mBAAmB,EACnB,mBAAmB,GACtB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC/E,YAAY,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AACvF,YAAY,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AACjF,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,YAAY,EACR,QAAQ,GACX,MAAM,eAAe,CAAC;AAEvB,YAAY,EACR,YAAY,EACZ,kBAAkB,GACrB,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EACR,UAAU,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,gBAAgB,EAChB,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,mBAAmB,GACtB,MAAM,gCAAgC,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AAEzD,YAAY,EACX,YAAY,EACZ,aAAa,EACb,uBAAuB,EACvB,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EACf,eAAe,GAClB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAyC,MAAM,gBAAgB,CAAC;AAEjF;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACvB,GAAG,aAAa,CAahB;AAED,OAAO,EACH,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,GACtB,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAC9F,YAAY,EACR,aAAa,EACb,mBAAmB,EACnB,mBAAmB,GACtB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC/E,YAAY,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AACvF,YAAY,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AACjF,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,YAAY,EACR,QAAQ,GACX,MAAM,eAAe,CAAC;AAEvB,YAAY,EACR,YAAY,EACZ,kBAAkB,GACrB,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EACR,UAAU,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,gBAAgB,EAChB,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,mBAAmB,GACtB,MAAM,gCAAgC,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AAEzD,YAAY,EACX,YAAY,EACZ,aAAa,EACb,uBAAuB,EACvB,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EACf,eAAe,GAClB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAyC,MAAM,gBAAgB,CAAC;AAEjF;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACvB,GAAG,aAAa,CAchB;AAED,OAAO,EACH,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,GACtB,MAAM,gBAAgB,CAAC"}

package/lib/index.js

@@ -34,17 +34,17 @@ let loggerSet = false;
  * @param config the given config to setup the observer
  */
 function createClientMonitor(config) {
-    if (config && 0 < ((config?.collectingPeriodInMs ?? 0) + (config?.samplingPeriodInMs ?? 0))) {
-        if (!config.tickingTimeInMs) {
-            config.tickingTimeInMs = 1000;
-        }
-    }
     if (!loggerSet && config?.logLevel) {
         (0, logger_1.addLoggerProcess)((0, logger_1.createConsoleLogger)(config.logLevel));
         loggerSet = true;
     }
+    if (config && !config.samplingTick)
+        config.samplingTick = 1;
     return new ClientMonitor_1.ClientMonitor({
-        ...(config ?? {}),
+        ...(config ?? {
+            collectingPeriodInMs: 5000,
+            samplingTick: 1,
+        }),
     });
 }
 exports.createClientMonitor = createClientMonitor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@observertc/client-monitor-js",
-  "version": "3.3.1",
+  "version": "3.4.1-e6caa47.0",
   "description": "ObserveRTC Client Integration Javascript Library",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/utils/Timer.d.ts

@@ -1,15 +0,0 @@
-export type Timer = ReturnType<typeof createTimer>;
-export declare function createTimer(tickTimeInMs?: number): {
-    readonly active: boolean;
-    tickTimeInMs: number | undefined;
-    setCollectingAction: (config: {
-        action?: () => Promise<void>;
-        fixedDelayInMs?: number;
-    }) => void;
-    setSamplingAction: (config: {
-        action?: () => Promise<void>;
-        fixedDelayInMs?: number;
-    }) => void;
-    clear: () => void;
-};
-//# sourceMappingURL=Timer.d.ts.map

package/lib/utils/Timer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Timer.d.ts","sourceRoot":"","sources":["../../src/utils/Timer.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;AAEnD,wBAAgB,WAAW,CAAC,YAAY,CAAC,EAAE,MAAM;;;kCAkDR;QAAE,MAAM,CAAC,EAAE,MAAM,QAAQ,IAAI,CAAC,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,KAAG,IAAI;gCAgBlE;QAAE,MAAM,CAAC,EAAE,MAAM,QAAQ,IAAI,CAAC,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,KAAG,IAAI;;EAoCtG"}

package/lib/utils/Timer.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTimer = void 0;
-const logger_1 = require("./logger");
-const logger = (0, logger_1.createLogger)(`Timer`);
-function createTimer(tickTimeInMs) {
-    let timer;
-    let collecting;
-    let sampling;
-    if (tickTimeInMs) {
-        setTickingTime(tickTimeInMs);
-    }
-    function setTickingTime(tickInMs) {
-        if (timer) {
-            clearInterval(timer);
-            timer = undefined;
-        }
-        if (!tickInMs) {
-            return;
-        }
-        timer = setInterval(() => {
-            if (!collecting && !sampling) {
-                return;
-            }
-            const now = Date.now();
-            let promise = Promise.resolve();
-            if (collecting) {
-                if (collecting.invoked) {
-                    if (collecting.invoked + collecting.fixedDelayInMs <= now) {
-                        promise = promise.then(() => collecting?.action() ?? Promise.resolve());
-                        collecting.invoked = now;
-                    }
-                }
-                else {
-                    promise = promise.then(() => collecting?.action() ?? Promise.resolve());
-                    collecting.invoked = now;
-                }
-            }
-            if (sampling) {
-                if (sampling.invoked) {
-                    if (sampling.invoked + sampling.fixedDelayInMs <= now) {
-                        promise = promise.then(() => sampling?.action() ?? Promise.resolve());
-                        sampling.invoked = now;
-                    }
-                }
-                else {
-                    promise = promise.then(() => sampling?.action() ?? Promise.resolve());
-                    sampling.invoked = now;
-                }
-            }
-            promise.catch(err => {
-                logger.warn(`Error occurred while executing timer action`, err);
-            });
-        }, tickInMs);
-    }
-    function setCollectingAction(config) {
-        const { action, fixedDelayInMs, } = config;
-        if (!action || !fixedDelayInMs) {
-            collecting = undefined;
-            return;
-        }
-        collecting = {
-            action,
-            created: Date.now(),
-            fixedDelayInMs,
-        };
-    }
-    function setSamplingAction(config) {
-        const { action, fixedDelayInMs, } = config;
-        if (!action || !fixedDelayInMs) {
-            sampling = undefined;
-            return;
-        }
-        sampling = {
-            action,
-            created: Date.now(),
-            fixedDelayInMs,
-        };
-    }
-    function clear() {
-        if (timer) {
-            clearInterval(timer);
-            timer = undefined;
-        }
-        collecting = undefined;
-        sampling = undefined;
-    }
-    return {
-        get active() {
-            return !!timer;
-        },
-        set tickTimeInMs(value) {
-            setTickingTime(value);
-        },
-        setCollectingAction,
-        setSamplingAction,
-        clear,
-    };
-}
-exports.createTimer = createTimer;