nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-27 13:53:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

state-contents.txt: try to document circ-build-timeout fields

Browse Source 
This should also get feedback from @mikeperry.

Closes #40136
This commit is contained in:
Nick Mathewson 2020-09-22 14:44:30 -04:00
parent 371cd7ac4f
commit 5ffd8bf2b8
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/state-contents.txt
View File

@ -91,9 +91,24 @@ Recognized fields are:
TotalBuildTimes
CircuitBuildAbandonedCount
CircuitBuildTimeBin
BuildTimeHistorgram
XXXX writeme.
These fields are used by the Circuit Build Timeout code, which
tries to learn what times are reasonable for circuit construction,
so that it can reject circuits that take too long to build.
CircuitBuildTimeBin is a count of circuits that were build
successfully in some timeframe. This entry can repeat; each of
these represents some bar on a histogram. The first integer is a
number of milliseconds; it tells the position of the center of the
histogram bin on the time axis. The second number is a count of
circuits in that bin.
CircuitBuildTimeAbandonedCount is a count of circuits that we
simply gave up on building because they were taking far too long.
TotalBuildTimes is the number of circuit build times that we
observed in order to build the above measurements fields. If it
reaches a cap, then older measurements get thrown away.
Guard [key=value] [key=value]...