diff options
Diffstat (limited to 'spec/bandwidth-file-spec/implementation-details.md')
| -rw-r--r-- | spec/bandwidth-file-spec/implementation-details.md | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/spec/bandwidth-file-spec/implementation-details.md b/spec/bandwidth-file-spec/implementation-details.md index 5491d57..90f84fa 100644 --- a/spec/bandwidth-file-spec/implementation-details.md +++ b/spec/bandwidth-file-spec/implementation-details.md @@ -39,7 +39,7 @@ As above. "nick" nickname -[Exactly once.] +\[Exactly once.\] The relay nickname. @@ -47,7 +47,7 @@ Torflow also has a "nick" KeyValue. "rtt" Int -[Zero or one time.] +\[Zero or one time.\] The Round Trip Time in milliseconds to obtain 1 byte of data. @@ -56,7 +56,7 @@ It became optional in version 1.3.0 or 1.4.0 of this specification. "time" DateTime -[Exactly once.] +\[Exactly once.\] The date and time timestamp in ISO 8601 format and UTC time zone when the last bandwidth was obtained. @@ -66,7 +66,7 @@ The Torflow equivalent is "measured_at". "success" Int -[Zero or one time.] +\[Zero or one time.\] The number of times that the bandwidth measurements for this relay were successful. @@ -75,7 +75,7 @@ This KeyValue was added in version 1.1.0 of this specification. "error_circ" Int -[Zero or one time.] +\[Zero or one time.\] The number of times that the bandwidth measurements for this relay failed because of circuit failures. @@ -85,7 +85,7 @@ The Torflow equivalent is "circ_fail". "error_stream" Int -[Zero or one time.] +\[Zero or one time.\] The number of times that the bandwidth measurements for this relay failed because of stream failures. @@ -94,7 +94,7 @@ This KeyValue was added in version 1.1.0 of this specification. "error_destination" Int -[Zero or one time.] +\[Zero or one time.\] The number of times that the bandwidth measurements for this relay failed because the destination Web server was not available. @@ -103,7 +103,7 @@ This KeyValue was added in version 1.4.0 of this specification. "error_second_relay" Int -[Zero or one time.] +\[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. @@ -112,7 +112,7 @@ This KeyValue was added in version 1.4.0 of this specification. "error_misc" Int -[Zero or one time.] +\[Zero or one time.\] The number of times that the bandwidth measurements for this relay failed because of other reasons. @@ -121,7 +121,7 @@ This KeyValue was added in version 1.1.0 of this specification. "bw_mean" Int -[Zero or one time.] +\[Zero or one time.\] The measured bandwidth mean for this relay in bytes per second. @@ -129,7 +129,7 @@ This KeyValue was added in version 1.2.0 of this specification. "bw_median" Int -[Zero or one time.] +\[Zero or one time.\] The measured bandwidth median for this relay in bytes per second. @@ -137,7 +137,7 @@ This KeyValue was added in version 1.2.0 of this specification. "desc_bw_avg" Int -[Zero or one time.] +\[Zero or one time.\] The descriptor average bandwidth for this relay in bytes per second. @@ -145,7 +145,7 @@ This KeyValue was added in version 1.2.0 of this specification. "desc_bw_obs_last" Int -[Zero or one time.] +\[Zero or one time.\] The last descriptor observed bandwidth for this relay in bytes per second. @@ -154,7 +154,7 @@ This KeyValue was added in version 1.2.0 of this specification. "desc_bw_obs_mean" Int -[Zero or one time.] +\[Zero or one time.\] The descriptor observed bandwidth mean for this relay in bytes per second. @@ -163,7 +163,7 @@ This KeyValue was added in version 1.2.0 of this specification. "desc_bw_bur" Int -[Zero or one time.] +\[Zero or one time.\] The descriptor burst bandwidth for this relay in bytes per second. @@ -172,7 +172,7 @@ This KeyValue was added in version 1.2.0 of this specification. "consensus_bandwidth" Int -[Zero or one time.] +\[Zero or one time.\] The consensus bandwidth for this relay in bytes per second. @@ -180,7 +180,7 @@ This KeyValue was added in version 1.2.0 of this specification. "consensus_bandwidth_is_unmeasured" Bool -[Zero or one time.] +\[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 @@ -190,7 +190,7 @@ This KeyValue was added in version 1.2.0 of this specification. "relay_in_recent_consensus_count" Int -[Zero or one time.] +\[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 @@ -200,7 +200,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_priority_list_count" Int -[Zero or one time.] +\[Zero or one time.\] The number of times this relay has been prioritized to be measured in the last data_period days. @@ -209,7 +209,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_measurement_attempt_count" Int -[Zero or one time.] +\[Zero or one time.\] The number of times this relay was tried to be measured in the last data_period days. @@ -218,7 +218,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_measurement_failure_count" Int -[Zero or one time.] +\[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 @@ -228,7 +228,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_measurements_excluded_error_count" Int -[Zero or one time.] +\[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 @@ -240,7 +240,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_measurements_excluded_near_count" Int -[Zero or one time.] +\[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 @@ -253,7 +253,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_measurements_excluded_old_count" Int -[Zero or one time.] +\[Zero or one time.\] The number of successful measurements for this relay that are too old (more than data_period days, 5 by default). @@ -267,7 +267,7 @@ This KeyValue was added in version 1.4.0 of this specification. "relay_recent_measurements_excluded_few_count" Int -[Zero or one time.] +\[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 @@ -283,7 +283,7 @@ This KeyValue was added in version 1.4.0 of this specification. "under_min_report" bool -[Zero or one time.] +\[Zero or one time.\] If the value is 1, there are not enough eligible relays in the bandwidth file, and Tor bandwidth authorities MAY NOT vote on this @@ -305,7 +305,7 @@ This KeyValue was added in version 1.4.0 of this specification. "unmeasured" bool -[Zero or one time.] +\[Zero or one time.\] If the value is 1, this relay was not successfully measured and Tor bandwidth authorities MAY NOT vote on this relay. @@ -325,7 +325,7 @@ This KeyValue was added in version 1.4.0 of this specification. "vote" bool -[Zero or one time.] +\[Zero or one time.\] If the value is 0, Tor directory authorities SHOULD ignore the relay's entry in the bandwidth file. They SHOULD vote for the relay the same @@ -347,7 +347,7 @@ This KeyValue was added in version 1.4.0 of this specification. "xoff_recv" Int -[Zero or one time.] +\[Zero or one time.\] The number of times this relay received `XOFF_RECV` stream events while being measured in the last data_period days. @@ -356,7 +356,7 @@ This KeyValue was added in version 1.6.0 of this specification. "xoff_sent" Int -[Zero or one time.] +\[Zero or one time.\] The number of times this relay received `XOFF_SENT` stream events while being measured in the last data_period days. @@ -365,7 +365,7 @@ This KeyValue was added in version 1.6.0 of this specification. "r_strm" Float -[Zero or one time.] +\[Zero or one time.\] The stream ratio of this relay calculated as explained in B4.3. @@ -373,7 +373,7 @@ This KeyValue was added in version 1.7.0 of this specification. "r_strm_filt" Float -[Zero or one time.] +\[Zero or one time.\] The filtered stream ratio of this relay calculated as explained in B4.3. @@ -383,7 +383,7 @@ This KeyValue was added in version 1.7.0 of this specification. #### Torflow -Torflow RelayLines include node_id and bw, and other KeyValue pairs [2]. +Torflow RelayLines include node_id and bw, and other KeyValue pairs \[2\]. References: |