feat: Add a stat for endpoints with suspended sources. (#1910)

* feat: Add a stat for endpoints with suspended sources.

Author: bgrozev

jvb/src/main/java/org/jitsi/videobridge/cc/allocation/BandwidthAllocator.java

@@ -388,7 +388,7 @@ private List<String> getSelectedSources()
             targetBps += sourceBitrateAllocation.getTargetBitrate();
             idealBps += sourceBitrateAllocation.getIdealBitrate();
         }
-        return new BandwidthAllocation(allocations, oversending, idealBps, targetBps);
+        return new BandwidthAllocation(allocations, oversending, idealBps, targetBps, !suspendedIds.isEmpty());
     }
 
     /**
@@ -461,7 +461,7 @@ private List<String> getSelectedSources()
             targetBps += sourceBitrateAllocation.getTargetBitrate();
             idealBps += sourceBitrateAllocation.getIdealBitrate();
         }
-        return new BandwidthAllocation(allocations, oversending, idealBps, targetBps);
+        return new BandwidthAllocation(allocations, oversending, idealBps, targetBps, !suspendedIds.isEmpty());
     }
 
     /**

jvb/src/main/java/org/jitsi/videobridge/stats/VideobridgeStatistics.java

@@ -258,6 +258,7 @@ private void generate0()
         int numOversending = 0;
         int endpointsWithHighOutgoingLoss = 0;
         int numLocalActiveEndpoints = 0;
+        int endpointsWithSuspendedSources = 0;
 
         for (Conference conference : videobridge.getConferences())
         {
@@ -322,6 +323,10 @@ private void generate0()
                 {
                     receiveOnlyEndpoints++;
                 }
+                if (endpoint.hasSuspendedSources())
+                {
+                    endpointsWithSuspendedSources++;
+                }
                 TransceiverStats transceiverStats = endpoint.getTransceiver().getTransceiverStats();
                 IncomingStatisticsSnapshot incomingStats = transceiverStats.getRtpReceiverStats().getIncomingStats();
                 PacketStreamStats.Snapshot incomingPacketStreamStats
@@ -585,6 +590,7 @@ private void generate0()
             unlockedSetStat(OCTO_SEND_BITRATE, relayBitrateOutgoingBps);
             unlockedSetStat(OCTO_SEND_PACKET_RATE, relayPacketRateOutgoing);
             unlockedSetStat(TOTAL_DOMINANT_SPEAKER_CHANGES, jvbStats.totalDominantSpeakerChanges.sum());
+            unlockedSetStat("endpoints_with_suspended_sources", endpointsWithSuspendedSources);
 
             unlockedSetStat(TIMESTAMP, timestampFormat.format(new Date()));
             if (relayId != null)

jvb/src/main/kotlin/org/jitsi/videobridge/Endpoint.kt

@@ -214,6 +214,9 @@ class Endpoint @JvmOverloads constructor(
         isUsingSourceNames
     )
 
+    /** Whether any sources are suspended from being sent to this endpoint because of BWE. */
+    fun hasSuspendedSources() = bitrateController.hasSuspendedSources()
+
     /**
      * The instance which manages the Colibri messaging (over a data channel
      * or web sockets).

jvb/src/main/kotlin/org/jitsi/videobridge/cc/allocation/BandwidthAllocation.kt

@@ -28,6 +28,8 @@ class BandwidthAllocation @JvmOverloads constructor(
     val oversending: Boolean = false,
     val idealBps: Long = -1,
     val targetBps: Long = -1,
+    /** Whether any of the requested sources were suspended (no layer at all was selected) due to BWE. */
+    val hasSuspendedSources: Boolean = false
 ) {
     val forwardedEndpoints: Set<String> =
         allocations.filter { it.isForwarded() }.map { it.endpointId }.toSet()
@@ -64,6 +66,8 @@ class BandwidthAllocation @JvmOverloads constructor(
         get() = JSONObject().apply {
             put("idealBps", idealBps)
             put("targetBps", targetBps)
+            put("oversending", oversending.toString())
+            put("has_suspended_sources", hasSuspendedSources.toString())
         }
 }
 

jvb/src/main/kotlin/org/jitsi/videobridge/cc/allocation/BitrateController.kt

@@ -96,6 +96,7 @@ class BitrateController<T : MediaSourceContainer> @JvmOverloads constructor(
             diagnosticContext,
             clock
         )
+    fun hasSuspendedSources() = bandwidthAllocator.allocation.hasSuspendedSources
 
     private val allocationSettingsWrapper = AllocationSettingsWrapper(useSourceNames)
     val allocationSettings