Report encode/decode time and if encoder/decoder is in hardware. Also

add implementation name as a dimension.
aws · Sep 13, 2022 · 2103581 · 2103581
1 parent 5cdfbc9
commit 2103581
Show file tree

Hide file tree

Showing 11 changed files with 3,222 additions and 2,741 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add encoder/decoder is in hardware metric and stream dimension to signaling protocol
+- Report encode/decode time and if encoder/decoder is in hardware, and add encoder/decoder name as a metric dimension
 
 ### Removed
 

diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/clientmetricreport.html b/docs/classes/clientmetricreport.html
diff --git a/docs/classes/globalmetricreport.html b/docs/classes/globalmetricreport.html
@@ -88,6 +88,8 @@ <h3>Properties</h3>
 							<ul class="tsd-index-list">
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#currentmetrics" class="tsd-kind-icon">current<wbr>Metrics</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#previousstringvalues" class="tsd-kind-icon">previous<wbr>String<wbr>Values</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a></li>
 							</ul>
 						</section>
 					</div>
@@ -148,6 +150,42 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
 						</ul>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="previousstringvalues" class="tsd-anchor"></a>
+					<h3>previous<wbr>String<wbr>Values</h3>
+					<div class="tsd-signature tsd-kind-icon">previous<wbr>String<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/GlobalMetricReport.ts#L7">src/clientmetricreport/GlobalMetricReport.ts:7</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-type-declaration">
+						<h4>Type declaration</h4>
+						<ul class="tsd-parameters">
+							<li class="tsd-parameter-index-signature">
+								<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
+							</li>
+						</ul>
+					</div>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="stringvalues" class="tsd-anchor"></a>
+					<h3>string<wbr>Values</h3>
+					<div class="tsd-signature tsd-kind-icon">string<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/GlobalMetricReport.ts#L8">src/clientmetricreport/GlobalMetricReport.ts:8</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-type-declaration">
+						<h4>Type declaration</h4>
+						<ul class="tsd-parameters">
+							<li class="tsd-parameter-index-signature">
+								<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
+							</li>
+						</ul>
+					</div>
+				</section>
 			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -174,6 +212,12 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="globalmetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="globalmetricreport.html#previousstringvalues" class="tsd-kind-icon">previous<wbr>String<wbr>Values</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="globalmetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a>
+							</li>
 						</ul>
 					</li>
 				</ul>

diff --git a/docs/classes/streammetricreport.html b/docs/classes/streammetricreport.html
@@ -90,7 +90,9 @@ <h3>Properties</h3>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#direction" class="tsd-kind-icon">direction</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#mediatype" class="tsd-kind-icon">media<wbr>Type</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#previousstringvalues" class="tsd-kind-icon">previous<wbr>String<wbr>Values</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a></li>
 							</ul>
 						</section>
 					</div>
@@ -171,6 +173,24 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
 						</ul>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="previousstringvalues" class="tsd-anchor"></a>
+					<h3>previous<wbr>String<wbr>Values</h3>
+					<div class="tsd-signature tsd-kind-icon">previous<wbr>String<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/StreamMetricReport.ts#L13">src/clientmetricreport/StreamMetricReport.ts:13</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-type-declaration">
+						<h4>Type declaration</h4>
+						<ul class="tsd-parameters">
+							<li class="tsd-parameter-index-signature">
+								<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
+							</li>
+						</ul>
+					</div>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
 					<a name="streamid" class="tsd-anchor"></a>
 					<h3>stream<wbr>Id</h3>
@@ -181,6 +201,24 @@ <h3>stream<wbr>Id</h3>
 						</ul>
 					</aside>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="stringvalues" class="tsd-anchor"></a>
+					<h3>string<wbr>Values</h3>
+					<div class="tsd-signature tsd-kind-icon">string<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/StreamMetricReport.ts#L14">src/clientmetricreport/StreamMetricReport.ts:14</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-type-declaration">
+						<h4>Type declaration</h4>
+						<ul class="tsd-parameters">
+							<li class="tsd-parameter-index-signature">
+								<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
+							</li>
+						</ul>
+					</div>
+				</section>
 			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -213,9 +251,15 @@ <h3>stream<wbr>Id</h3>
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="streammetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="streammetricreport.html#previousstringvalues" class="tsd-kind-icon">previous<wbr>String<wbr>Values</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="streammetricreport.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="streammetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a>
+							</li>
 						</ul>
 					</li>
 				</ul>

diff --git a/src/clientmetricreport/ClientMetricReport.ts b/src/clientmetricreport/ClientMetricReport.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import Logger from '../logger/Logger';
-import { SdkMetric } from '../signalingprotocol/SignalingProtocol.js';
+import { SdkMetric, SdkStreamDimension } from '../signalingprotocol/SignalingProtocol.js';
 import VideoStreamIndex from '../videostreamindex/VideoStreamIndex';
 import Direction from './ClientMetricReportDirection';
 import MediaType from './ClientMetricReportMediaType';
@@ -126,6 +126,35 @@ export default class ClientMetricReport {
     return Number(metricReport.currentMetrics[metricName] * 1000);
   };
 
+  millisecondsPerSecond = (metricName?: string, ssrc?: number): number => {
+    const metricReport = ssrc ? this.streamMetricReports[ssrc] : this.globalMetricReport;
+    let intervalSeconds = (this.currentTimestampMs - this.previousTimestampMs) / 1000;
+    if (intervalSeconds <= 0) {
+      return 0;
+    }
+    if (this.previousTimestampMs <= 0) {
+      intervalSeconds = 1;
+    }
+    const diff =
+      metricReport.currentMetrics[metricName] - (metricReport.previousMetrics[metricName] || 0);
+    if (diff <= 0) {
+      return 0;
+    }
+    return (diff * 1000) / intervalSeconds;
+  };
+
+  isHardwareImplementation = (metricName?: string, ssrc?: number): number => {
+    const metricReport = this.streamMetricReports[ssrc];
+    const implName = String(metricReport.stringValues[metricName]);
+    const hasHwName =
+      implName.includes('ExternalDecoder') ||
+      implName.includes('ExternalEncoder') ||
+      implName.includes('EncodeAccelerator') ||
+      implName.includes('DecodeAccelerator');
+    const isFallback = implName.includes('fallback from');
+    return hasHwName && !isFallback ? 1 : 0;
+  };
+
   /**
    *  Canonical and derived metric maps
    */
@@ -252,6 +281,14 @@ export default class ClientMetricReport {
     jitter: {
       transform: this.secondsToMilliseconds,
     },
+    totalEncodeTime: {
+      transform: this.millisecondsPerSecond,
+      type: SdkMetric.Type.VIDEO_ENCODE_MS,
+    },
+    encoderImplementation: {
+      transform: this.isHardwareImplementation,
+      type: SdkMetric.Type.VIDEO_ENCODER_IS_HARDWARE,
+    },
   };
 
   readonly videoDownstreamMetricMap: {
@@ -261,7 +298,6 @@ export default class ClientMetricReport {
       source?: string;
     };
   } = {
-    totalDecodeTime: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_MS },
     packetsReceived: { transform: this.countPerSecond, type: SdkMetric.Type.VIDEO_RECEIVED_PPS },
     packetsLost: {
       transform: this.packetLossPercent,
@@ -297,6 +333,14 @@ export default class ClientMetricReport {
     },
     frameHeight: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_HEIGHT },
     frameWidth: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_WIDTH },
+    totalDecodeTime: {
+      transform: this.millisecondsPerSecond,
+      type: SdkMetric.Type.VIDEO_DECODE_MS,
+    },
+    decoderImplementation: {
+      transform: this.isHardwareImplementation,
+      type: SdkMetric.Type.VIDEO_DECODER_IS_HARDWARE,
+    },
   };
 
   getMetricMap(
@@ -329,6 +373,22 @@ export default class ClientMetricReport {
     }
   }
 
+  /**
+   *  Dimensions derived from metric
+   */
+  readonly streamMetricDimensionMap: {
+    [id: string]: SdkStreamDimension.Type;
+  } = {
+    encoderImplementation: SdkStreamDimension.Type.VIDEO_ENCODER_NAME,
+    decoderImplementation: SdkStreamDimension.Type.VIDEO_DECODER_NAME,
+  };
+
+  getStreamMetricDimensionMap(): {
+    [id: string]: SdkStreamDimension.Type;
+  } {
+    return this.streamMetricDimensionMap;
+  }
+
   /**
    *  media Stream metrics
    */

diff --git a/src/clientmetricreport/GlobalMetricReport.ts b/src/clientmetricreport/GlobalMetricReport.ts
@@ -4,4 +4,6 @@
 export default class GlobalMetricReport {
   previousMetrics: { [id: string]: number } = {};
   currentMetrics: { [id: string]: number } = {};
+  previousStringValues: { [id: string]: string } = {};
+  stringValues: { [id: string]: string } = {};
 }
diff --git a/src/clientmetricreport/StreamMetricReport.ts b/src/clientmetricreport/StreamMetricReport.ts
@@ -10,4 +10,6 @@ export default class StreamMetricReport {
   direction: Direction;
   previousMetrics: { [id: string]: number } = {};
   currentMetrics: { [id: string]: number } = {};
+  previousStringValues: { [id: string]: string } = {};
+  stringValues: { [id: string]: string } = {};
 }
diff --git a/src/statscollector/StatsCollector.ts b/src/statscollector/StatsCollector.ts
@@ -14,7 +14,9 @@ import IntervalScheduler from '../scheduler/IntervalScheduler';
 import SignalingClient from '../signalingclient/SignalingClient';
 import {
   SdkClientMetricFrame,
+  SdkDimensionValue,
   SdkMetric,
+  SdkStreamDimension,
   SdkStreamMetricFrame,
 } from '../signalingprotocol/SignalingProtocol.js';
 import { Maybe } from '../utils/Types';
@@ -253,8 +255,16 @@ export default class StatsCollector {
 
     for (const rawMetric in rawMetricReport) {
       if (rawMetric in metricMap) {
-        metricReport.previousMetrics[rawMetric] = metricReport.currentMetrics[rawMetric];
-        metricReport.currentMetrics[rawMetric] = rawMetricReport[rawMetric];
+        if (typeof rawMetricReport[rawMetric] === 'number') {
+          metricReport.previousMetrics[rawMetric] = metricReport.currentMetrics[rawMetric];
+          metricReport.currentMetrics[rawMetric] = rawMetricReport[rawMetric];
+        } else if (typeof rawMetricReport[rawMetric] === 'string') {
+          metricReport.stringValues[rawMetric] = rawMetricReport[rawMetric];
+        } else {
+          this.logger.error(
+            `Unknown metric value type ${typeof rawMetricReport[rawMetric]} for metric ${rawMetric}`
+          );
+        }
       }
     }
   }
@@ -300,6 +310,26 @@ export default class StatsCollector {
     this.clientMetricReport.print();
   }
 
+  /**
+   *  Add stream metric dimension frames derived from metrics
+   */
+  private addStreamMetricDimensionFrames(
+    streamMetricFrame: SdkStreamMetricFrame,
+    streamMetricReport: StreamMetricReport
+  ): void {
+    const streamDimensionMap = this.clientMetricReport.getStreamMetricDimensionMap();
+    for (const metricName in streamMetricReport.stringValues) {
+      if (metricName in streamDimensionMap) {
+        const dimensionFrame = SdkStreamDimension.create();
+        dimensionFrame.type = streamDimensionMap[metricName];
+        const dimensionValue = SdkDimensionValue.create();
+        dimensionValue.stringValue = streamMetricReport.stringValues[metricName];
+        dimensionFrame.value = dimensionValue;
+        streamMetricFrame.dimensions.push(dimensionFrame);
+      }
+    }
+  }
+
   /**
    * Packages a metric into the MetricFrame.
    */
@@ -350,11 +380,13 @@ export default class StatsCollector {
       const streamMetricFrame = SdkStreamMetricFrame.create();
       streamMetricFrame.streamId = streamMetricReport.streamId;
       streamMetricFrame.metrics = [];
+      this.addStreamMetricDimensionFrames(streamMetricFrame, streamMetricReport);
       clientMetricFrame.streamMetricFrames.push(streamMetricFrame);
       const metricMap = this.clientMetricReport.getMetricMap(
         streamMetricReport.mediaType,
         streamMetricReport.direction
       );
+
       for (const metricName in streamMetricReport.currentMetrics) {
         this.addMetricFrame(metricName, clientMetricFrame, metricMap[metricName], Number(ssrc));
       }