diff options
Diffstat (limited to 'spec/bandwidth-file-spec/header-list-format.md')
| -rw-r--r-- | spec/bandwidth-file-spec/header-list-format.md | 50 |
1 files changed, 25 insertions, 25 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. |