diff options
Diffstat (limited to 'spec/bandwidth-file-spec')
| -rw-r--r-- | spec/bandwidth-file-spec/header-list-format.md | 50 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/implementation-details.md | 66 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/relay-line-format.md | 8 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/sample-data.md | 4 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/scaling-bandwidths.md | 2 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/scope-preliminaries.md | 4 |
6 files changed, 67 insertions, 67 deletions
diff --git a/spec/bandwidth-file-spec/header-list-format.md b/spec/bandwidth-file-spec/header-list-format.md index 4feae69..075ddd6 100644 --- a/spec/bandwidth-file-spec/header-list-format.md +++ b/spec/bandwidth-file-spec/header-list-format.md @@ -23,7 +23,7 @@ It consists of: Timestamp NL -[At start, exactly once.] +\[At start, exactly once.\] The Unix Epoch time in seconds of the most recent generator bandwidth result. @@ -44,10 +44,10 @@ with version 1.0.0. "version" version_number NL -[In second position, zero or one time.] +\[In second position, zero or one time.\] The specification document format version. -It uses semantic versioning [5]. +It uses semantic versioning \[5\]. This Line was added in version 1.1.0 of this specification. @@ -56,7 +56,7 @@ version_number is considered to be "1.0.0". "software" Value NL -[Zero or one time.] +\[Zero or one time.\] The name of the software that created the document. @@ -67,7 +67,7 @@ is considered to be "torflow". "software_version" Value NL -[Zero or one time.] +\[Zero or one time.\] The version of the software that created the document. The version may be a version_number, a git commit, or some other @@ -77,7 +77,7 @@ This Line was added in version 1.1.0 of this specification. "file_created" DateTime NL -[Zero or one time.] +\[Zero or one time.\] The date and time timestamp in ISO 8601 format and UTC time zone when the file was created. @@ -86,7 +86,7 @@ This Line was added in version 1.1.0 of this specification. "generator_started" DateTime NL -[Zero or one time.] +\[Zero or one time.\] The date and time timestamp in ISO 8601 format and UTC time zone when the generator started. @@ -95,7 +95,7 @@ This Line was added in version 1.1.0 of this specification. "earliest_bandwidth" DateTime NL -[Zero or one time.] +\[Zero or one time.\] The date and time timestamp in ISO 8601 format and UTC time zone when the first relay bandwidth was obtained. @@ -104,7 +104,7 @@ This Line was added in version 1.1.0 of this specification. "latest_bandwidth" DateTime NL -[Zero or one time.] +\[Zero or one time.\] The date and time timestamp in ISO 8601 format and UTC time zone of the most recent generator bandwidth result. @@ -118,7 +118,7 @@ This Line was added in version 1.1.0 of this specification. "number_eligible_relays" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of relays that have enough measurements to be included in the bandwidth file. @@ -127,7 +127,7 @@ This Line was added in version 1.2.0 of this specification. "minimum_percent_eligible_relays" Int NL -[Zero or one time.] +\[Zero or one time.\] The percentage of relays in the consensus that SHOULD be included in every generated bandwidth file. @@ -148,7 +148,7 @@ This Line was added in version 1.2.0 of this specification. "number_consensus_relays" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of relays in the consensus. @@ -156,7 +156,7 @@ This Line was added in version 1.2.0 of this specification. "percent_eligible_relays" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of eligible relays, as a percentage of the number of relays in the consensus. @@ -204,7 +204,7 @@ This Line was added in version 1.2.0 of this specification. "recent_consensus_count" Int NL -[Zero or one time.]. +\[Zero or one time.\]. The number of the different consensuses seen in the last data_period days. (data_period is 5 by default.) @@ -275,7 +275,7 @@ in version 1.5.0. "recent_measurement_failure_count" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of times that the scanner attempted to measure a relay in the last data_period days (5 by default), but the relay has not been @@ -285,7 +285,7 @@ This Line was added in version 1.4.0 of this specification. "recent_measurements_excluded_error_count" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of relays that have no successful measurements in the last data_period days (5 by default). @@ -296,7 +296,7 @@ This Line was added in version 1.4.0 of this specification. "recent_measurements_excluded_near_count" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of relays that have some successful measurements in the last data_period days (5 by default), but all those measurements were @@ -308,7 +308,7 @@ This Line was added in version 1.4.0 of this specification. "recent_measurements_excluded_old_count" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of relays that have some successful measurements, but all those measurements are too old (more than 5 days, by default). @@ -322,7 +322,7 @@ This Line was added in version 1.4.0 of this specification. "recent_measurements_excluded_few_count" Int NL -[Zero or one time.] +\[Zero or one time.\] The number of relays that don't have enough recent successful measurements. (Fewer than 2 measurements in the last 5 days, by @@ -338,7 +338,7 @@ This Line was added in version 1.4.0 of this specification. "time_to_report_half_network" Int NL -[Zero or one time.] +\[Zero or one time.\] The time in seconds that it would take to report measurements about the half of the network, given the number of eligible relays and the time @@ -350,7 +350,7 @@ This Line was added in version 1.4.0 of this specification. "tor_version" version_number NL -[Zero or one time.] +\[Zero or one time.\] The Tor version of the Tor process controlled by the generator. @@ -358,7 +358,7 @@ This Line was added in version 1.4.0 of this specification. "mu" Int NL -[Zero or one time.] +\[Zero or one time.\] The network stream bandwidth average calculated as explained in B4.2. @@ -366,7 +366,7 @@ This Line was added in version 1.7.0 of this specification. "muf" Int NL -[Zero or one time.] +\[Zero or one time.\] The network stream bandwidth average filtered calculated as explained in B4.2. @@ -375,7 +375,7 @@ This Line was added in version 1.7.0 of this specification. KeyValue NL -[Zero or more times.] +\[Zero or more times.\] There MUST NOT be multiple KeyValue header Lines with the same key. If there are, the parser SHOULD choose an arbitrary Line. @@ -399,7 +399,7 @@ If there are, the parser MAY ignore conflicting keywords. Terminator NL -[Zero or one time.] +\[Zero or one time.\] The Header List section ends with a Terminator. 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: diff --git a/spec/bandwidth-file-spec/relay-line-format.md b/spec/bandwidth-file-spec/relay-line-format.md index 13a9ffd..ec47146 100644 --- a/spec/bandwidth-file-spec/relay-line-format.md +++ b/spec/bandwidth-file-spec/relay-line-format.md @@ -20,7 +20,7 @@ Each RelayLine includes the following KeyValue pairs: "node_id" hexdigest -[Exactly once.] +\[Exactly once.\] The fingerprint for the relay's RSA identity key. @@ -39,7 +39,7 @@ least one of them. "master_key_ed25519" MasterKey -[Zero or one time.] +\[Zero or one time.\] The relays's master Ed25519 key, base64 encoded, without trailing "="s, to avoid ambiguity with KeyValue "=" @@ -51,7 +51,7 @@ This KeyValue was added in version 1.1.0 of this specification. "bw" Bandwidth -[Exactly once.] +\[Exactly once.\] The bandwidth of this relay in kilobytes per second. @@ -107,7 +107,7 @@ measured bandwidth. KeyValue -[Zero or more times.] +\[Zero or more times.\] Future format versions may include additional KeyValue pairs on a RelayLine. diff --git a/spec/bandwidth-file-spec/sample-data.md b/spec/bandwidth-file-spec/sample-data.md index f9b05de..45bb43f 100644 --- a/spec/bandwidth-file-spec/sample-data.md +++ b/spec/bandwidth-file-spec/sample-data.md @@ -39,7 +39,7 @@ bw=189 error_circ=0 error_misc=0 error_stream=0 master_key_ed25519=a6a+dZadrQBtf ## Generated by sbws version 1.0.3 -```text +````text 1523911758 version=1.2.0 latest_bandwidth=2018-04-16T20:49:18 @@ -78,7 +78,7 @@ percent_eligible_relays=46 software=sbws software_version=1.0.3 ===== -``` +```` <a id="bandwidth-file-spec.txt-A.4"></a> diff --git a/spec/bandwidth-file-spec/scaling-bandwidths.md b/spec/bandwidth-file-spec/scaling-bandwidths.md index 32fcb83..8d8906e 100644 --- a/spec/bandwidth-file-spec/scaling-bandwidths.md +++ b/spec/bandwidth-file-spec/scaling-bandwidths.md @@ -127,6 +127,6 @@ r_strm_i = bw_i / bw_avg_strm bw_new_i = r_i * bw_obs_i ``` -<<In this way, the resulting network status consensus bandwidth +\<\<In this way, the resulting network status consensus bandwidth values are effectively re-weighted proportional to how much faster the node was as compared to the rest of the network.>> diff --git a/spec/bandwidth-file-spec/scope-preliminaries.md b/spec/bandwidth-file-spec/scope-preliminaries.md index 267d2cb..dd17d56 100644 --- a/spec/bandwidth-file-spec/scope-preliminaries.md +++ b/spec/bandwidth-file-spec/scope-preliminaries.md @@ -11,7 +11,7 @@ which we call version 1.0.0. It also specifies new format versions Since Tor version 0.2.4.12-alpha, the directory authorities use the Bandwidth File file called "V3BandwidthsFile" generated by -Torflow [1]. The details of this format are described in Torflow's +Torflow \[1\]. The details of this format are described in Torflow's README.spec.txt. We also summarise the format in this specification. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL @@ -36,7 +36,7 @@ Iain Learmonth (irl) ## Outline -The Tor directory protocol (dir-spec.txt [3]) sections 3.4.1 +The Tor directory protocol (dir-spec.txt \[3\]) sections 3.4.1 and 3.4.2, use the term bandwidth measurements, to refer to what here is called Bandwidth File. |