Merge branch 'issue210_01' into 'main'

bandwidth-file: Add ratios KeyValues in RelayLines

Closes #210

See merge request tpo/core/torspec!149

1 files changed, 36 insertions, 0 deletions

diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt
index 5ad946f..bad13f6 100644
--- a/bandwidth-file-spec.txt
+++ b/bandwidth-file-spec.txt
@@ -99,6 +99,8 @@ Table of Contents
           Also adds Tor version.
   1.5.0 - Removes "recent_measurement_attempt_count" KeyValue.
   1.6.0 - Adds congestion control stream events KeyValues.
+  1.7.0 - Adds ratios KeyValues to the relay lines and network averages
+          KeyValues to the header.
 
   All Tor versions can consume format version 1.0.0.
 
@@ -518,6 +520,23 @@ Table of Contents
 
       This Line was added in version 1.4.0 of this specification.
 
+    "mu" Int NL
+
+      [Zero or one time.]
+
+      The network stream bandwidth average calculated as explained in B4.2.
+
+      This Line was added in version 1.7.0 of this specification.
+
+    "muf" Int NL
+
+      [Zero or one time.]
+
+      The network stream bandwidth average filtered calculated as explained in
+      B4.2.
+
+      This Line was added in version 1.7.0 of this specification.
+
     KeyValue NL
 
       [Zero or more times.]
@@ -1038,6 +1057,23 @@ Table of Contents
 
       This KeyValue was added in version 1.6.0 of this specification.
 
+    "r_strm" Float
+
+      [Zero or one time.]
+
+      The stream ratio of this relay calculated as explained in B4.3.
+
+      This KeyValue was added in version 1.7.0 of this specification.
+
+    "r_strm_filt" Float
+
+      [Zero or one time.]
+
+      The filtered stream ratio of this relay calculated as explained in B4.3.
+
+      This KeyValue was added in version 1.7.0 of this specification.
+
+
 2.4.2.2. Torflow
 
   Torflow RelayLines include node_id and bw, and other KeyValue pairs [2].