doc/state-contents.txt

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