stats: Add summery report

src/otel/OTelGroupCallMembership.ts

@@ -37,10 +37,10 @@ import {
 import {
   ConnectionStatsReport,
   ByteSentStatsReport,
+  SummeryStatsReport,
 } from "matrix-js-sdk/src/webrtc/stats/statsReport";
 import { setSpan } from "@opentelemetry/api/build/esm/trace/context-utils";
 
-
 import { ElementCallOpenTelemetry } from "./otel";
 import { ObjectFlattener } from "./ObjectFlattener";
 
@@ -117,7 +117,7 @@ export class OTelGroupCallMembership {
         this.myMember = myMember;
       }
     }
-    this.myDeviceId = client.getDeviceId();
+    this.myDeviceId = client.getDeviceId() || "unknown";
     this.statsReportSpan = { span: undefined, stats: [] };
     this.groupCall.on(GroupCallEvent.CallsChanged, this.onCallsChanged);
   }
@@ -317,55 +317,68 @@ export class OTelGroupCallMembership {
     });
   }
 
-
   public onConnectionStatsReport(
-      statsReport: GroupCallStatsReport<ConnectionStatsReport>
+    statsReport: GroupCallStatsReport<ConnectionStatsReport>
   ) {
     const type = OTelStatsReportType.ConnectionStatsReport;
     const data =
-        ObjectFlattener.flattenConnectionStatsReportObject(statsReport);
+      ObjectFlattener.flattenConnectionStatsReportObject(statsReport);
     this.buildStatsEventSpan({ type, data });
   }
 
   public onByteSentStatsReport(
-      statsReport: GroupCallStatsReport<ByteSentStatsReport>
+    statsReport: GroupCallStatsReport<ByteSentStatsReport>
   ) {
     const type = OTelStatsReportType.ByteSentStatsReport;
     const data = ObjectFlattener.flattenByteSentStatsReportObject(statsReport);
     this.buildStatsEventSpan({ type, data });
   }
 
+  public onSummeryStatsReport(
+    statsReport: GroupCallStatsReport<SummeryStatsReport>
+  ) {
+    const type = OTelStatsReportType.SummeryStatsReport;
+    const data = ObjectFlattener.flattenSummeryStatsReportObject(statsReport);
+    this.buildStatsEventSpan({ type, data });
+  }
+
   private buildStatsEventSpan(event: OTelStatsReportEvent): void {
+    // @ TODO: fix this - Because on multiple calls we receive multiple stats report spans.
+    // This could be break if stats arrived in same time from different call objects.
     if (this.statsReportSpan.span === undefined && this.callMembershipSpan) {
       const ctx = setSpan(
-          opentelemetry.context.active(),
-          this.callMembershipSpan
+        opentelemetry.context.active(),
+        this.callMembershipSpan
       );
       this.statsReportSpan.span =
-          ElementCallOpenTelemetry.instance.tracer.startSpan(
-              "matrix.groupCallMembership.statsReport",
-              undefined,
-              ctx
-          );
+        ElementCallOpenTelemetry.instance.tracer.startSpan(
+          "matrix.groupCallMembership.statsReport",
+          undefined,
+          ctx
+        );
       this.statsReportSpan.span.setAttribute(
-          "matrix.confId",
-          this.groupCall.groupCallId
+        "matrix.confId",
+        this.groupCall.groupCallId
       );
       this.statsReportSpan.span.setAttribute("matrix.userId", this.myUserId);
       this.statsReportSpan.span.setAttribute(
-          "matrix.displayName",
-          this.myMember ? this.myMember.name : "unknown-name"
+        "matrix.displayName",
+        this.myMember ? this.myMember.name : "unknown-name"
       );
 
       this.statsReportSpan.span.addEvent(event.type, event.data);
       this.statsReportSpan.stats.push(event);
     } else if (
-        this.statsReportSpan.span !== undefined &&
-        this.callMembershipSpan
+      this.statsReportSpan.span !== undefined &&
+      this.callMembershipSpan
     ) {
       this.statsReportSpan.span.addEvent(event.type, event.data);
-      this.statsReportSpan.span.end();
-      this.statsReportSpan = { span: undefined, stats: [] };
+      this.statsReportSpan.stats.push(event);
+      // if received all three types of stats close this
+      if (this.statsReportSpan.stats.length === 3) {
+        this.statsReportSpan.span.end();
+        this.statsReportSpan = { span: undefined, stats: [] };
+      }
     }
   }
 }
@@ -378,4 +391,5 @@ interface OTelStatsReportEvent {
 enum OTelStatsReportType {
   ConnectionStatsReport = "matrix.stats.connection",
   ByteSentStatsReport = "matrix.stats.byteSent",
+  SummeryStatsReport = "matrix.stats.summery",
 }

src/otel/ObjectFlattener.ts

@@ -18,6 +18,7 @@ import { GroupCallStatsReport } from "matrix-js-sdk/src/webrtc/groupCall";
 import {
   ByteSentStatsReport,
   ConnectionStatsReport,
+  SummeryStatsReport,
 } from "matrix-js-sdk/src/webrtc/stats/statsReport";
 
 export class ObjectFlattener {
@@ -47,6 +48,19 @@ export class ObjectFlattener {
     return flatObject;
   }
 
+  static flattenSummeryStatsReportObject(
+    statsReport: GroupCallStatsReport<SummeryStatsReport>
+  ) {
+    const flatObject = {};
+    ObjectFlattener.flattenObjectRecursive(
+      statsReport.report,
+      flatObject,
+      "matrix.stats.summery.",
+      0
+    );
+    return flatObject;
+  }
+
   public static flattenObjectRecursive(
     obj: Object,
     flatObject: Attributes,

src/room/useGroupCall.ts

@@ -33,6 +33,7 @@ import { MatrixClient } from "matrix-js-sdk";
 import {
   ByteSentStatsReport,
   ConnectionStatsReport,
+  SummeryStatsReport,
 } from "matrix-js-sdk/src/webrtc/stats/statsReport";
 
 import { usePageUnload } from "./usePageUnload";
@@ -355,6 +356,12 @@ export function useGroupCall(
       groupCallOTelMembership?.onByteSentStatsReport(report);
     }
 
+    function onSummeryStatsReport(
+      report: GroupCallStatsReport<SummeryStatsReport>
+    ): void {
+      groupCallOTelMembership?.onSummeryStatsReport(report);
+    }
+
     groupCall.on(GroupCallEvent.GroupCallStateChanged, onGroupCallStateChanged);
     groupCall.on(GroupCallEvent.UserMediaFeedsChanged, onUserMediaFeedsChanged);
     groupCall.on(
@@ -381,6 +388,8 @@ export function useGroupCall(
       onByteSentStatsReport
     );
 
+    groupCall.on(GroupCallStatsReportEvent.SummeryStats, onSummeryStatsReport);
+
     updateState({
       error: null,
       state: groupCall.state,
@@ -428,12 +437,16 @@ export function useGroupCall(
       );
       groupCall.removeListener(GroupCallEvent.Error, onError);
       groupCall.removeListener(
-          GroupCallStatsReportEvent.ConnectionStats,
-          onConnectionStatsReport
+        GroupCallStatsReportEvent.ConnectionStats,
+        onConnectionStatsReport
       );
       groupCall.removeListener(
-          GroupCallStatsReportEvent.ByteSentStats,
-          onByteSentStatsReport
+        GroupCallStatsReportEvent.ByteSentStats,
+        onByteSentStatsReport
+      );
+      groupCall.removeListener(
+        GroupCallStatsReportEvent.SummeryStats,
+        onSummeryStatsReport
       );
       leaveCall();
     };