[tor-commits] [torspec/master] bandwidth-file: Add forgotten KeyValues

[nickm at torproject.org]

commit 7b12eb7cee099deef2b74dc8cfc3d2505c2013d9
Author: juga0 <juga at riseup.net>
Date:   Tue Mar 3 15:16:45 2020 +0000

    bandwidth-file: Add forgotten KeyValues
    
    Some bandwidth related KeyValues were added to the version 1.2.0,
    but they were forgotten when writing this specification.
    The same happened with some monitoring KeyValues in the version 1.4.0.
    They have not been added to the examples, since they don't contain all
    the KeyValues.
    
    Closes #30726.
---
 bandwidth-file-spec.txt | 67 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 66 insertions(+), 1 deletion(-)

diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt
index 0345c96..6dd90c2 100644
--- a/bandwidth-file-spec.txt
+++ b/bandwidth-file-spec.txt
@@ -56,7 +56,7 @@
 
           Adds new KeyValue Lines to the Header List section with
           statistics about the number of relays included in the file.
-          Add new KeyValues to Relay Bandwidth Lines, with different
+          Adds new KeyValues to Relay Bandwidth Lines, with different
           bandwidth values (averages and descriptor bandwidths).
 
   1.3.0 - Adds scanner and destination countries to the header.
@@ -797,6 +797,71 @@
 
       This KeyValue was added in version 1.2.0 of this specification.
 
+    "desc_bw_bur=" Int
+
+      [Zero or one time.]
+
+      The descriptor burst bandwidth for this relay in bytes per
+      second.
+
+      This KeyValue was added in version 1.2.0 of this specification.
+
+    "consensus_bandwidth" Int
+
+      [Zero or one time.]
+
+      The consensus bandwidth for this relay in bytes per second.
+
+      This KeyValue was added in version 1.2.0 of this specification.
+
+    "consensus_bandwidth_is_unmeasured" Bool
+
+      [Zero or one time.]
+
+      If the consensus bandwidth for this relay was not obtained from
+      three or more bandwidth authorities, this KeyValue is True or
+      False otherwise.
+
+      This KeyValue was added in version 1.2.0 of this specification.
+
+    "relay_in_recent_consensus_count" Int
+
+      [Zero or one time.]
+
+      The number of times this relay was found in a consensus in the
+      last data_period days. (Unless otherwise stated, data_period is
+      5 by default.)
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "relay_recent_priority_list_count" Int
+
+      [Zero or one time.]
+
+      The number of times this relay has been prioritized to be measured
+      in the last data_period days.
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "relay_recent_measurement_attempt_count" Int
+
+      [Zero or one time.]
+
+      The number of times this relay was tried to be measured in the
+      last data_period days.
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "relay_recent_measurement_failure_count" Int
+
+      [Zero or one time.]
+
+      The number of times this relay was tried to be measured in the
+      last data_period days, but it was not possible to obtain a
+      measurement.
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
     "relay_recent_measurements_excluded_error_count=" Int
 
       [Zero or one time.]