feat(config): Make the packet timeline configurable.

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/PacketInfo.kt

@@ -16,7 +16,10 @@
 package org.jitsi.nlj
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings
+import org.jitsi.config.JitsiConfig
+import org.jitsi.metaconfig.config
 import org.jitsi.rtp.Packet
+import org.jitsi.utils.logging2.createLogger
 import java.time.Clock
 import java.time.Duration
 import java.time.Instant
@@ -93,7 +96,7 @@ open class PacketInfo @JvmOverloads constructor(
     var receivedTime: Instant? = null
         set(value) {
             field = value
-            if (ENABLE_TIMELINE && timeline.referenceTime == null) {
+            if (enableTimeline && timeline.referenceTime == null) {
                 timeline.referenceTime = value
             }
         }
@@ -121,15 +124,15 @@ open class PacketInfo @JvmOverloads constructor(
      * The payload verification string for the packet, or 'null' if payload verification is disabled. Calculating the
      * it is expensive, thus we only do it when the flag is enabled.
      */
-    var payloadVerification = if (ENABLE_PAYLOAD_VERIFICATION) packet.payloadVerification else null
+    var payloadVerification = if (enablePayloadVerification) packet.payloadVerification else null
 
     /**
      * Re-calculates the expected payload verification string. This should be called any time that the code
      * intentionally modifies the packet in a way that could change the verification string (for example, re-creates
      * it with a new type (parsing), or intentionally modifies the payload (SRTP)).
      */
     fun resetPayloadVerification() {
-        payloadVerification = if (ENABLE_PAYLOAD_VERIFICATION) packet.payloadVerification else null
+        payloadVerification = if (enablePayloadVerification) packet.payloadVerification else null
     }
 
     /**
@@ -145,7 +148,7 @@ open class PacketInfo @JvmOverloads constructor(
      * will be copied for the cloned PacketInfo).
      */
     fun clone(): PacketInfo {
-        val clone = if (ENABLE_TIMELINE) {
+        val clone = if (enableTimeline) {
             PacketInfo(packet.clone(), originalLength, timeline.clone())
         } else {
             // If the timeline isn't enabled, we can just share the same one.
@@ -164,7 +167,7 @@ open class PacketInfo @JvmOverloads constructor(
     }
 
     fun addEvent(desc: String) {
-        if (ENABLE_TIMELINE) {
+        if (enableTimeline) {
             timeline.addEvent(desc)
         }
     }
@@ -209,14 +212,28 @@ open class PacketInfo @JvmOverloads constructor(
     }
 
     companion object {
-        // TODO: we could make this a public var to allow changing this at runtime
-        private const val ENABLE_TIMELINE = false
+        private val enableTimeline: Boolean by config {
+            "jmt.debug.packet-timeline.enabled".from(JitsiConfig.newConfig)
+        }
+
+        private val enablePayloadVerificationDefault: Boolean by config {
+            "jmt.debug.payload-verification.enabled".from(JitsiConfig.newConfig)
+        }
 
         /**
          * If this is enabled all [Node]s will verify that the payload didn't unexpectedly change. This is expensive.
          */
         @field:Suppress("ktlint:standard:property-naming")
-        var ENABLE_PAYLOAD_VERIFICATION = false
+        var enablePayloadVerification = enablePayloadVerificationDefault
+
+        init {
+            if (enableTimeline) {
+                createLogger().info("Packet timeline is enabled.")
+            }
+            if (enablePayloadVerification) {
+                createLogger().info("Payload verification is enabled.")
+            }
+        }
     }
 }
 

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/transform/node/Node.kt

@@ -144,15 +144,15 @@ sealed class Node(
             if (enable) {
                 PLUGINS_ENABLED = true
                 plugins.add(PayloadVerificationPlugin)
-                PacketInfo.ENABLE_PAYLOAD_VERIFICATION = true
+                PacketInfo.enablePayloadVerification = true
             } else {
                 plugins.remove(PayloadVerificationPlugin)
                 PLUGINS_ENABLED = plugins.isNotEmpty()
-                PacketInfo.ENABLE_PAYLOAD_VERIFICATION = false
+                PacketInfo.enablePayloadVerification = false
             }
         }
 
-        fun isPayloadVerificationEnabled(): Boolean = PacketInfo.ENABLE_PAYLOAD_VERIFICATION
+        fun isPayloadVerificationEnabled(): Boolean = PacketInfo.enablePayloadVerification
 
         fun enableNodeTracing(enable: Boolean) {
             TRACE_ENABLED = enable

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/transform/node/debug/PayloadVerificationPlugin.kt

@@ -38,7 +38,7 @@ class PayloadVerificationPlugin {
         fun getStatsJson() = JSONObject().apply { this["num_payload_verification_failures"] = numFailures.get() }
 
         override fun observe(after: Node, packetInfo: PacketInfo) {
-            if (PacketInfo.ENABLE_PAYLOAD_VERIFICATION &&
+            if (PacketInfo.enablePayloadVerification &&
                 packetInfo.payloadVerification != null
             ) {
                 val expected = packetInfo.payloadVerification

jitsi-media-transform/src/main/resources/reference.conf

@@ -137,9 +137,9 @@ jmt {
     pcap {
       // Whether to permit the API to dynamically enable the capture of
       // unencrypted PCAP files of media traffic.
-      enabled=false
+      enabled = false
       // The directory in which to place captured PCAP files.
-      directory="/tmp"
+      directory = "/tmp"
     }
     packet-loss {
       // Artificial loss to introduce in the receive pipeline.
@@ -161,5 +161,15 @@ jmt {
         burst-interval = 0
       }
     }
+    packet-timeline {
+      // Whether to enable the packet timeline. This is an expensive option used for debugging.
+      enabled = false
+      // Log a packet timeline for every one out of [log-fraction] packets.
+      log-fraction = 10000
+    }
+    payload-verification {
+      // Whether to enable payload verification on startup. This is a very expensive option only used for debugging.
+      enabled = false
+    }
   }
 }

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

@@ -1176,9 +1176,11 @@ class Endpoint @JvmOverloads constructor(
         private val epTimeout = 2.mins
 
         private val timelineCounter = AtomicLong()
-        private val TIMELINE_FRACTION = 10000L
+        private val timelineFraction: Long by config {
+            "jmt.debug.packet-timeline.log-fraction".from(JitsiConfig.newConfig)
+        }
 
-        fun logTimeline() = timelineCounter.getAndIncrement() % TIMELINE_FRACTION == 0L
+        fun logTimeline() = timelineCounter.getAndIncrement() % timelineFraction == 0L
 
         private const val SRTP_QUEUE_ENTRY_EVENT = "Entered Endpoint SRTP sender outgoing queue"
         private const val SRTP_QUEUE_EXIT_EVENT = "Exited Endpoint SRTP sender outgoing queue"

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

@@ -17,7 +17,7 @@ package org.jitsi.videobridge.cc.allocation
 
 import org.jitsi.nlj.MediaSourceDesc
 import org.jitsi.nlj.PacketInfo
-import org.jitsi.nlj.PacketInfo.Companion.ENABLE_PAYLOAD_VERIFICATION
+import org.jitsi.nlj.PacketInfo.Companion.enablePayloadVerification
 import org.jitsi.nlj.RtpLayerDesc
 import org.jitsi.nlj.rtp.VideoRtpPacket
 import org.jitsi.rtp.rtcp.RtcpSrPacket
@@ -83,7 +83,7 @@ internal class PacketHandler(
             adaptiveSourceProjection.rewriteRtp(packetInfo)
 
             // The rewriteRtp operation must not modify the VP8 payload.
-            if (ENABLE_PAYLOAD_VERIFICATION) {
+            if (enablePayloadVerification) {
                 val expected = packetInfo.payloadVerification
                 val actual = videoPacket.payloadVerification
                 if ("" != expected && expected != actual) {