Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a timeseries log for bitrate as received and sent. #2290

Merged
merged 1 commit into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ class RtpReceiverImpl @JvmOverloads constructor(
private val silenceDiscarder = DiscardableDiscarder("Silence discarder", false)
private val paddingOnlyDiscarder = DiscardableDiscarder("Padding-only discarder", true)
private val statsTracker = IncomingStatisticsTracker(streamInformationStore)
private val packetStreamStats = PacketStreamStatsNode()
private val packetStreamStats = PacketStreamStatsNode(diagnosticContext, "receive")
private val rtcpRrGenerator = RtcpRrGenerator(backgroundExecutor, rtcpSender, statsTracker) {
remoteBandwidthEstimator.createRemb()?.let {
listOf(it)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ class RtpSenderImpl(
private val headerExtensionStripper = HeaderExtStripper(streamInformationStore)
private val absSendTime = AbsSendTime(streamInformationStore)
private val statsTracker = OutgoingStatisticsTracker()
private val packetStreamStats = PacketStreamStatsNode()
private val packetStreamStats = PacketStreamStatsNode(diagnosticContext, "send")
private val rtcpSrUpdater = RtcpSrUpdater(statsTracker)
private val keyframeRequester = KeyframeRequester(streamInformationStore, logger)
private val probingDataSender: ProbingDataSender
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,19 @@ package org.jitsi.nlj.transform.node

import org.jitsi.nlj.PacketInfo
import org.jitsi.nlj.stats.PacketStreamStats
import org.jitsi.utils.logging.DiagnosticContext
import org.jitsi.utils.logging.TimeSeriesLogger

/**
* A [Node] which keeps track of the basic statistics for a stream of packets (packet and bit rates)
*
* @author Boris Grozev
*/
class PacketStreamStatsNode(private val packetStreamStats: PacketStreamStats = PacketStreamStats()) :
class PacketStreamStatsNode(
private val diagnosticContext: DiagnosticContext,
private val direction: String,
private val packetStreamStats: PacketStreamStats = PacketStreamStats()
) :
ObserverNode("PacketStreamStats") {

override fun observe(packetInfo: PacketInfo) {
Expand All @@ -32,13 +38,25 @@ class PacketStreamStatsNode(private val packetStreamStats: PacketStreamStats = P

override fun trace(f: () -> Unit) = f.invoke()

fun snapshot() = packetStreamStats.snapshot()
fun snapshot() = packetStreamStats.snapshot().also {
if (timeseriesLogger.isTraceEnabled) {
timeseriesLogger.trace(
diagnosticContext.makeTimeSeriesPoint("${direction}_packet_stream_stats")
.addField("bitrate_bps", it.bitrate.bps)
.addField("packet_rate", it.packetRate)
)
}
}

fun getBitrate() = snapshot().bitrate

/**
* Creates a new [Node] instance which shares the same [packetStreamStats]. Useful when we want to add nodes to
* different branches of a [Node] tree.
*/
fun createNewNode() = PacketStreamStatsNode(packetStreamStats)
fun createNewNode() = PacketStreamStatsNode(diagnosticContext, direction, packetStreamStats)

companion object {
private val timeseriesLogger = TimeSeriesLogger.getTimeSeriesLogger(PacketStreamStatsNode::class.java)
}
}