[or-cvs] r22638: {arm} change: Revised some commenting and notes. (in arm/trunk: . interface util)

[Damian Johnson]

Author: atagar
Date: 2010-07-14 14:31:45 +0000 (Wed, 14 Jul 2010)
New Revision: 22638

Modified:
   arm/trunk/ChangeLog
   arm/trunk/TODO
   arm/trunk/armrc.sample
   arm/trunk/interface/controller.py
   arm/trunk/util/torTools.py
Log:
change: Revised some commenting and notes.



Modified: arm/trunk/ChangeLog
===================================================================
--- arm/trunk/ChangeLog	2010-07-14 13:52:37 UTC (rev 22637)
+++ arm/trunk/ChangeLog	2010-07-14 14:31:45 UTC (rev 22638)
@@ -1,7 +1,7 @@
 CHANGE LOG
 
 6/7/10 - version 1.3.6
-Rewrite of the first third of the interface, providing vastly improved performance, maintainability, and a few very nice features.
+Rewrite of the first third of the interface, providing vastly improved performance, maintainability, and a few very nice features. This improved the refresh rate (which is also related to system resource usage) from 30ms to 4ms (an 87% improvement).
 
     * added: settings are fetched from an optional armrc (update rates, controller password, caching, runlevels, etc)
     * added: system tools util providing simplified usage, suppression of leaks to stdout, logging, and optional caching

Modified: arm/trunk/TODO
===================================================================
--- arm/trunk/TODO	2010-07-14 13:52:37 UTC (rev 22637)
+++ arm/trunk/TODO	2010-07-14 14:31:45 UTC (rev 22638)
@@ -68,6 +68,9 @@
   * util are assuming that tor is running under the default command name
       attempt to determine the command name at runtime (if the pid is available
       then ps can do the mapping)
+  * util/torTools.py: effective bandwidth rate/burst measurements don't take
+      SETCONF into consideration, blocked on:
+      https://trac.torproject.org/projects/tor/ticket/1692
   
   * log panel:
     * not catching events unexpected by arm
@@ -136,6 +139,7 @@
   * check if batch getInfo/getOption calls provide much performance benefit
   * layout (css) bugs with site
       Revise to use 'em' for measurements and somehow stretch image's y-margin?
+      Maybe padding-bottom to match the content on the right?
   * page with details on client circuits, attempting to detect details like
       country, ISP, latency, exit policy for the circuit, traffic, etc
   * attempt to clear controller password from memory

Modified: arm/trunk/armrc.sample
===================================================================
--- arm/trunk/armrc.sample	2010-07-14 13:52:37 UTC (rev 22637)
+++ arm/trunk/armrc.sample	2010-07-14 14:31:45 UTC (rev 22638)
@@ -6,7 +6,6 @@
 startup.events N3
 
 features.colorInterface true
-features.logRefreshRate 5
 
 # general graph parameters
 # interval: 0 -> each second,  1 -> 5 seconds,  2 -> 30 seconds,
@@ -81,4 +80,5 @@
 log.connLookupRateGrowing NONE
 log.hostnameCacheTrimmed INFO
 log.cursesColorSupport INFO
+logging.rate.refreshRate 5
 

Modified: arm/trunk/interface/controller.py
===================================================================
--- arm/trunk/interface/controller.py	2010-07-14 13:52:37 UTC (rev 22637)
+++ arm/trunk/interface/controller.py	2010-07-14 14:31:45 UTC (rev 22638)
@@ -42,7 +42,7 @@
   ["torrc"]]
 PAUSEABLE = ["header", "graph", "log", "conn"]
 
-CONFIG = {"features.logRefreshRate": 5, "features.graph.type": 1, "features.graph.bw.prepopulate": True, "log.refreshRate": log.DEBUG, "log.configEntryUndefined": log.NOTICE}
+CONFIG = {"logging.rate.refreshRate": 5, "features.graph.type": 1, "features.graph.bw.prepopulate": True, "log.refreshRate": log.DEBUG, "log.configEntryUndefined": log.NOTICE}
 
 class ControlPanel(panel.Panel):
   """ Draws single line label for interface controls. """

Modified: arm/trunk/util/torTools.py
===================================================================
--- arm/trunk/util/torTools.py	2010-07-14 13:52:37 UTC (rev 22637)
+++ arm/trunk/util/torTools.py	2010-07-14 14:31:45 UTC (rev 22638)
@@ -471,7 +471,8 @@
   
   def getMyBandwidthRate(self, default = None):
     """
-    Provides the effective relaying bandwidth rate of this relay.
+    Provides the effective relaying bandwidth rate of this relay. Currently
+    this doesn't account for SETCONF events.
     
     Arguments:
       default - result if the query fails
@@ -481,7 +482,8 @@
   
   def getMyBandwidthBurst(self, default = None):
     """
-    Provides the effective bandwidth burst rate of this relay.
+    Provides the effective bandwidth burst rate of this relay. Currently this
+    doesn't account for SETCONF events.
     
     Arguments:
       default - result if the query fails