summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexander Færøy <ahf@torproject.org>2017-12-16 02:41:21 +0100
committerAlexander Færøy <ahf@torproject.org>2017-12-16 02:41:21 +0100
commitd4f4108601fe7e2614f30055ff5abe00460f6a12 (patch)
treef8c926dc04c1c476561fff41b6d7fb25eed3dd20 /doc
parente44662a7f9af990753a89b0a831d3439a509c8ae (diff)
downloadtor-d4f4108601fe7e2614f30055ff5abe00460f6a12.tar.gz
tor-d4f4108601fe7e2614f30055ff5abe00460f6a12.zip
Add MainloopStats option.
This patch adds support for MainloopStats that allow developers to get main event loop statistics via Tor's heartbeat status messages. The new status log message will show how many succesful, erroneous, and idle event loop iterations we have had. See: https://bugs.torproject.org/24605
Diffstat (limited to 'doc')
-rw-r--r--doc/tor.1.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index b2218e33cc..64114d6e6b 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -2032,6 +2032,11 @@ is non-zero):
to 0 will disable the heartbeat. Otherwise, it must be at least 30
minutes. (Default: 6 hours)
+[[MainloopStats]] **MainloopStats** **0**|**1**::
+ Log main loop statistics every **HeartbeatPeriod** seconds. This is a log
+ level __notice__ message designed to help developers instrumenting Tor's
+ main event loop. (Default: 0)
+
[[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
Limits the max number of bytes sent and received within a set time period
using a given calculation rule (see: AccountingStart, AccountingRule).