[tor-commits] [tor/main] man: Missing OverloadStatistics option in tor.1

[ahf at torproject.org]

commit 6926c9192af5807c0996171909285a2d18cc05d0
Author: David Goulet <dgoulet at torproject.org>
Date:   Tue Nov 2 09:50:18 2021 -0400

    man: Missing OverloadStatistics option in tor.1
    
    Closes #40504
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 changes/ticket40504 |  3 +++
 doc/man/tor.1.txt   | 20 ++++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/changes/ticket40504 b/changes/ticket40504
new file mode 100644
index 0000000000..9095591419
--- /dev/null
+++ b/changes/ticket40504
@@ -0,0 +1,3 @@
+  o Documentation (man, relay):
+    - Missing "OverloadStatistics" in tor.1 manpage. Fixes bug 40504; bugfix on
+      0.4.6.1-alpha.
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