diff options
| author | David Goulet <dgoulet@torproject.org> | 2021-11-02 09:50:18 -0400 |
|---|---|---|
| committer | David Goulet <dgoulet@torproject.org> | 2021-11-02 09:51:43 -0400 |
| commit | 6926c9192af5807c0996171909285a2d18cc05d0 (patch) | |
| tree | e68541b22af50c59b4ae802e87a79f6c15d4121a /doc | |
| parent | 57f296b396fef3fd5101cb790430514041c2ce36 (diff) | |
| download | tor-6926c9192af5807c0996171909285a2d18cc05d0.tar.gz tor-6926c9192af5807c0996171909285a2d18cc05d0.zip | |
man: Missing OverloadStatistics option in tor.1
Closes #40504
Signed-off-by: David Goulet <dgoulet@torproject.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/tor.1.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/tor.1.txt b/doc/man/tor.1.txt index 89afe59582..19693ce2dc 100644 --- a/doc/man/tor.1.txt +++ b/doc/man/tor.1.txt @@ -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 |