feat(Stats): count non fatal errors (#6781)

Add `nonFatalErrorCount` to shaka stats.
shaka-project · Jun 10, 2024 · 081afde · 081afde
1 parent 59304b8
commit 081afde
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 0 deletions.
diff --git a/externs/shaka/player.js b/externs/shaka/player.js
@@ -87,6 +87,8 @@ shaka.extern.StateChange;
  *
  *   bytesDownloaded: number,
  *
+ *   nonFatalErrorCount: number,
+ *
  *   switchHistory: !Array.<shaka.extern.TrackChoice>,
  *   stateHistory: !Array.<shaka.extern.StateChange>
  * }}
@@ -166,6 +168,9 @@ shaka.extern.StateChange;
  * @property {number} bytesDownloaded
  *   The bytes downloaded during the playback. If nothing is loaded, NaN.
  *
+ * @property {number} nonFatalErrorCount
+ *   The amount of non fatal errors that occurred.  If nothing is loaded, NaN.
+ *
  * @property {!Array.<shaka.extern.TrackChoice>} switchHistory
  *   A history of the stream changes.
  * @property {!Array.<shaka.extern.StateChange>} stateHistory

diff --git a/lib/player.js b/lib/player.js
@@ -7006,6 +7006,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       return;
     }
 
+    if (error.severity === shaka.util.Error.Severity.RECOVERABLE) {
+      this.stats_.addNonFatalError();
+    }
+
     let fireError = true;
     if (this.fullyLoaded_ && this.manifest_ && this.streamingEngine_ &&
         (error.code == shaka.util.Error.Code.VIDEO_ERROR ||

diff --git a/lib/util/stats.js b/lib/util/stats.js
@@ -65,6 +65,9 @@ shaka.util.Stats = class {
     /** @private {number} */
     this.bytesDownloaded_ = NaN;
 
+    /** @private {number} */
+    this.nonFatalErrorCount_ = 0;
+
     /** @private {!shaka.util.StateHistory} */
     this.stateHistory_ = new shaka.util.StateHistory();
 
@@ -217,6 +220,11 @@ shaka.util.Stats = class {
     }
   }
 
+  /** */
+  addNonFatalError() {
+    this.nonFatalErrorCount_++;
+  }
+
   /**
    * @return {!shaka.util.StateHistory}
    */
@@ -259,6 +267,7 @@ shaka.util.Stats = class {
       liveLatency: this.liveLatencySeconds_,
       maxSegmentDuration: this.maxSegmentDurationSeconds_,
       bytesDownloaded: this.bytesDownloaded_,
+      nonFatalErrorCount: this.nonFatalErrorCount_,
       stateHistory: this.stateHistory_.getCopy(),
       switchHistory: this.switchHistory_.getCopy(),
     };
@@ -292,6 +301,7 @@ shaka.util.Stats = class {
       liveLatency: NaN,
       maxSegmentDuration: NaN,
       bytesDownloaded: NaN,
+      nonFatalErrorCount: NaN,
       switchHistory: [],
       stateHistory: [],
     };

diff --git a/test/player_integration.js b/test/player_integration.js
@@ -220,6 +220,8 @@ describe('Player', () => {
 
         bytesDownloaded: jasmine.any(Number),
 
+        nonFatalErrorCount: jasmine.any(Number),
+
         // We should have loaded the first Period by now, so we should have a
         // history.
         switchHistory: jasmine.arrayContaining([{

diff --git a/ui/statistics_button.js b/ui/statistics_button.js
@@ -117,6 +117,10 @@ shaka.ui.StatisticsButton = class extends shaka.ui.Element {
       return this.currentStats_[name] + ' (stalls)';
     };
 
+    const parseErrors = (name) => {
+      return this.currentStats_[name] + ' (errors)';
+    };
+
     const parseBytesDownloaded = (name) => {
       const bytes = parseInt(this.currentStats_[name], 10);
       if (bytes > 1e6) {
@@ -150,6 +154,7 @@ shaka.ui.StatisticsButton = class extends shaka.ui.Element {
       'stallsDetected': parseStalls,
       'gapsJumped': parseGaps,
       'bytesDownloaded': parseBytesDownloaded,
+      'nonFatalErrorCount': parseErrors,
     };
 
     /** @private {shaka.util.Timer} */