man: Missing OverloadStatistics option in tor.1

Closes #40504

Signed-off-by: David Goulet <dgoulet@torproject.org>
This commit is contained in:
David Goulet 2021-11-02 09:50:18 -04:00
parent 57f296b396
commit 6926c9192a
2 changed files with 23 additions and 0 deletions

3
changes/ticket40504 Normal file
View File

@ -0,0 +1,3 @@
o Documentation (man, relay):
- Missing "OverloadStatistics" in tor.1 manpage. Fixes bug 40504; bugfix on
0.4.6.1-alpha.

View File

@ -2765,6 +2765,26 @@ types of statistics that Tor relays collect and publish:
is enabled, it will be published as part of the extra-info document.
(Default: 1)
[[OverloadStatistics]] **OverloadStatistics** *0**|**1**::
Relays and bridges only.
When this option is enabled, a Tor relay will write an overload general
line in the server descriptor if the relay is considered overloaded.
(Default: 1)
+
A relay is considered overloaded if at least one of these conditions is
met:
- Onionskins are starting to be dropped.
- The OOM was invoked.
- (Exit only) DNS timeout occurs X% of the time over Y seconds (values
controlled by consensus parameters, see param-spec.txt).
+
If ExtraInfoStatistics is enabled, it can also put two more specific
overload lines in the extra-info document if at least one of these
conditions is met:
- TCP Port exhaustion
- Connection rate limits have been reached (read and write side).
[[PaddingStatistics]] **PaddingStatistics** **0**|**1**::
Relays and bridges only.
When this option is enabled, Tor collects statistics for padding cells