From df8c732cbe06935593b7d97965ecef24a9d41c63 Mon Sep 17 00:00:00 2001
From: teor <teor@torproject.org>
Date: Fri, 22 Mar 2019 11:28:06 +1000
Subject: bandwidth-file: Add new RelayLine monitoring KeyValues

Part of 29754.
---
 bandwidth-file-spec.txt | 73 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)

(limited to 'bandwidth-file-spec.txt')

diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt
index 907e32d..452dc21 100644
--- a/bandwidth-file-spec.txt
+++ b/bandwidth-file-spec.txt
@@ -678,6 +678,24 @@
 
       This KeyValue was added in version 1.1.0 of this specification.
 
+    "error_destination=" Int
+
+      [Zero or one time.]
+
+      The number of times that the bandwidth measurements for this relay
+      failed because the destination Web server was not available.
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "error_second_relay=" Int
+
+      [Zero or one time.]
+
+      The number of times that the bandwidth measurements for this relay
+      failed because sbws could not find a second relay for the test circuit.
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
     "error_misc=" Int
 
       [Zero or one time.]
@@ -729,6 +747,61 @@
 
       This KeyValue was added in version 1.2.0 of this specification.
 
+    "relay_recent_measurements_excluded_error_count=" Int
+
+      [Zero or one time.]
+
+      The number of recent relay measurement attempts that failed.
+      Measurements are recent if they are in the last data_period days
+      (5 by default).
+
+      (See the note in section 1.4, version 1.4.0, about excluded relays.)
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "relay_recent_measurements_excluded_near_count=" Int
+
+      [Zero or one time.]
+
+      When all of a relay's recent successful measurements were performed in
+      a period of time that was too short (by default 1 day), the relay is
+      excluded. This KeyValue contains the number of recent successful
+      measurements for the relay that were ignored for this reason.
+
+      (See the note in section 1.4, version 1.4.0, about excluded relays.)
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "relay_recent_measurements_excluded_old_count=" Int
+
+      [Zero or one time.]
+
+      The number of successful measurements for this relay that are too old
+      (more than data_period days, 5 by default).
+
+      Excludes measurements that are already counted in
+      relay_recent_measurements_excluded_near_count.
+
+      (See the note in section 1.4, version 1.4.0, about excluded relays.)
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
+    "recent_measurements_excluded_few_count=" Int
+
+      [Zero or one time.]
+
+      The number of successful measurements for this relay that were ignored
+      because the relay did not have enough successful measurements (fewer
+      than 2, by default).
+
+      Excludes measurements that are already counted in
+      relay_recent_measurements_excluded_near_count or
+      relay_recent_measurements_excluded_old_count.
+
+      (See the note in section 1.4, version 1.4.0, about excluded relays.)
+
+      This KeyValue was added in version 1.4.0 of this specification.
+
 2.4.2.2. Torflow
 
   Torflow RelayLines include node_id and bw, and other KeyValue pairs [2].
-- 
cgit v1.2.3-54-g00ecf