state-contents.txt 3.8 KB

  1. Contents of the Tor state file
  2. ==============================
  3. The state file is structured with more or less the same rules as torrc.
  4. Recognized fields are:
  5. TorVersion
  6. The version of Tor that wrote this file
  7. LastWritten
  8. Time when this state file was written.
  9. Given in ISO format (YYYY-MM-DD HH:MM:SS)
  10. AccountingBytesReadInInterval (memory unit)
  11. AccountingBytesWrittenInInterval (memory unit)
  12. AccountingExpectedUsage (memory unit)
  13. AccountingIntervalStart (ISO time)
  14. AccountingSecondsActive (time interval)
  15. AccountingSecondsToReachSoftLimit (time interval)
  16. AccountingSoftLimitHitAt (ISO time)
  17. AccountingBytesAtSoftLimit (memory unit)
  18. These fields describe the state of the accounting subsystem.
  19. The IntervalStart is the time at which the current accounting
  20. interval began. We were expecting to use ExpectedUsage over the
  21. course of the interval. BytesRead/BytesWritten are the total
  22. number of bytes transferred over the whole interval. If Tor has
  23. been active during the interval, then AccountingSecondsActive is
  24. the amount of time for which it has been active. We were expecting
  25. to hit the bandwidth soft limit in SecondsToReachSoftLimit after we
  26. became active. When we hit the soft limit, we record
  27. BytesAtSoftLimit. If we hit the soft limit already, we did so at
  28. SoftLimitHitAt.
  29. EntryGuard
  30. EntryGuardDownSince
  31. EntryGuardUnlistedSince
  32. EntryGuardAddedBy
  33. These lines form sections related to entry guards. Each section
  34. starts with a single EntryGuard line, and is then followed by
  35. information on the state of the Entry guard.
  36. The EntryGuard line contains a nickname, then an identity digest, of
  37. the guard.
  38. The EntryGuardDownSince and EntryGuardUnlistedSince lines are present
  39. if the entry guard is believed to be non-running or non-listed. If
  40. present, they contain a line in ISO format (YYYY-MM-DD HH:MM:SS).
  41. The EntryGuardAddedBy line is optional. It contains three
  42. space-separated fields: the identity of the entry guard, the version of
  43. Tor that added it, and the ISO time at which it was added.
  44. TransportProxy
  45. One or more of these may be present.
  46. The format is "transportname addr:port", to remember the address
  47. at which a pluggable transport was listening. Tor bridges use
  48. this information to spawn pluggable transport listeners in the
  49. same IP address and TCP port even after tor client restarts.
  50. BWHistoryReadEnds (ISO time)
  51. BWHistoryReadInterval (integer, number of seconds)
  52. BWHistoryReadValues (comma-separated list of integer)
  53. BWHistoryReadMaxima (comma-separated list of integer)
  54. BWHistoryWriteEnds
  55. BWHistoryWriteInterval
  56. BWHistoryWriteValues
  57. BWHistoryWriteMaxima
  58. BWHistoryDirReadEnds
  59. BWHistoryDirReadInterval
  60. BWHistoryDirReadValues
  61. BWHistoryDirReadMaxima
  62. BWHistoryDirWriteEnds
  63. BWHistoryDirWriteInterval
  64. BWHistoryDirWriteValues
  65. BWHistoryDirWriteMaxima
  66. These values record bandwidth history. The "Values" fields are a list, for
  67. some number of "Intervals", of the total amount read/written during that
  68. integer. The "Maxima" are the highest burst for each interval.
  69. Interval duration is set by the "Interval" field, in seconds. The
  70. "Ends" field is the ending time of the last interval in each list.
  71. The *Read* and *Write* fields are the total amount read and
  72. written; the *DirRead* and *DirWrite* variants are for directory
  73. traffic only.
  74. LastRotatedOnionKey
  75. The last time that we changed our onion key for a new one.
  76. Given in ISO format (YYYY-MM-DD HH:MM:SS)
  77. TotalBuildTimes
  78. CircuitBuildAbandonedCount
  79. CircuitBuildTimeBin
  80. XXXX writeme.