"""Store statistics for the Khashmir DHT."""
from datetime import datetime, timedelta
-from copy import deepcopy
+from StringIO import StringIO
+
+from ktable import K
+from util import byte_format
class StatsLogger:
"""Store the statistics for the Khashmir DHT.
- @ivar _StatsTemplate: a template for returning all the statistics
- @type config: C{dictionary}
- @ivar config: the configuration parameters for the DHT
@ivar startTime: the time the program was started
@ivar reachable: whether we can be contacted by other nodes
@type table: L{ktable.KTable}
generated an error
"""
- _StatsTemplate = [{'name': 'uptime',
- 'group': 'General',
- 'desc': 'Up time',
- 'tip': 'The elapsed time since the program started',
- 'value': None,
- },
- {'name': 'reachable',
- 'group': 'General',
- 'desc': 'Reachable',
- 'tip': 'Whether other nodes can contact us (not NATted or firewalled)',
- 'value': None,
- },
- {'name': 'nodes',
- 'group': 'Routing Table',
- 'desc': 'Number of nodes',
- 'tip': 'The number of nodes we are connected to',
- 'value': None,
- },
- {'name': 'users',
- 'group': 'Routing Table',
- 'desc': 'Total number of users',
- 'tip': 'The estimated total number of users in the DHT',
- 'value': None,
- },
- {'name': 'keys',
- 'group': 'Database',
- 'desc': 'Keys',
- 'tip': 'The number of distinct keys in the database',
- 'value': None,
- },
- {'name': 'values',
- 'group': 'Database',
- 'desc': 'Values',
- 'tip': 'The total number of values in the database',
- 'value': None,
- },
- {'name': 'downPackets',
- 'group': 'Transport',
- 'desc': 'Downloaded packets',
- 'tip': 'The number of received packets',
- 'value': None,
- },
- {'name': 'upPackets',
- 'group': 'Transport',
- 'desc': 'Uploaded packets',
- 'tip': 'The number of sent packets',
- 'value': None,
- },
- {'name': 'downBytes',
- 'group': 'Transport',
- 'desc': 'Downloaded bytes',
- 'tip': 'The number of bytes received by the DHT',
- 'value': None,
- },
- {'name': 'upBytes',
- 'group': 'Transport',
- 'desc': 'Uploaded bytes',
- 'tip': 'The number of bytes sent by the DHT',
- 'value': None,
- },
- {'name': 'actions',
- 'group': 'Actions',
- 'desc': 'Actions',
- 'tip': 'The number of requests for each action',
- 'value': None,
- },
- ]
-
- def __init__(self, table, store, config):
+ def __init__(self, table, store):
"""Initialize the statistics.
@type table: L{ktable.KTable}
@param table: the routing table for the DHT
@type store: L{db.DB}
@param store: the database for the DHT
- @type config: C{dictionary}
- @param config: the configuration parameters for the DHT
"""
# General
- self.config = config
- self.startTime = datetime.now()
+ self.startTime = datetime.now().replace(microsecond=0)
self.reachable = False
# Routing Table
"""
if datetime.now() - self.lastTableUpdate > timedelta(seconds = 15):
self.lastTableUpdate = datetime.now()
- self.nodes = reduce(lambda a, b: a + len(b.l), self.table.buckets, 0)
- self.users = self.config['K'] * (2**(len(self.table.buckets) - 1))
+ self.nodes = reduce(lambda a, b: a + b.len(), self.table.buckets, 0)
+ self.users = K * (2**(len(self.table.buckets) - 1))
return (self.nodes, self.users)
def dbStats(self):
self.keys, self.values = self.store.keyStats()
return (self.keys, self.values)
- def gather(self):
- """Gather all the statistics for the DHT.
+ def formatHTML(self):
+ """Gather statistics for the DHT and format them for display in a browser.
- @rtype: C{list} of C{dictionary}
- @return: each dictionary has keys describing the statistic:
- name, group, desc, tip, and value
+ @rtype: C{string}
+ @return: the stats, formatted for display in the body of an HTML page
"""
self.tableStats()
self.dbStats()
- stats = self._StatsTemplate[:]
- for stat in stats:
- val = getattr(self, stat['name'], None)
- if stat['name'] == 'uptime':
- stat['value'] = dattime.now() - self.startTime
- elif stat['name'] == 'actions':
- stat['value'] = deepcopy(actions)
- elif val is not None:
- stat['value'] = val
-
- return stats
+ elapsed = datetime.now().replace(microsecond=0) - self.startTime
+ out = StringIO()
+ out.write('<h2>DHT Statistics</h2>\n')
+ out.write("<table border='0' cellspacing='20px'>\n<tr>\n")
+ out.write('<td>\n')
+
+ # General
+ out.write("<table border='1' cellpadding='4px'>\n")
+ out.write("<tr><th><h3>General</h3></th><th>Value</th></tr>\n")
+ out.write("<tr title='Elapsed time since the DHT was started'><td>Up time</td><td>" + str(elapsed) + '</td></tr>\n')
+ out.write("<tr title='Whether this node is reachable by other nodes'><td>Reachable</td><td>" + str(self.reachable) + '</td></tr>\n')
+ out.write("</table>\n")
+ out.write('</td><td>\n')
+
+ # Routing
+ out.write("<table border='1' cellpadding='4px'>\n")
+ out.write("<tr><th><h3>Routing Table</h3></th><th>Value</th></tr>\n")
+ out.write("<tr title='The number of connected nodes'><td>Number of nodes</td><td>" + str(self.nodes) + '</td></tr>\n')
+ out.write("<tr title='The estimated number of connected users in the entire DHT'><td>Total number of users</td><td>" + str(self.users) + '</td></tr>\n')
+ out.write("</table>\n")
+ out.write('</td><td>\n')
+
+ # Database
+ out.write("<table border='1' cellpadding='4px'>\n")
+ out.write("<tr><th><h3>Database</h3></th><th>Value</th></tr>\n")
+ out.write("<tr title='Number of distinct keys in the database'><td>Keys</td><td>" + str(self.keys) + '</td></tr>\n')
+ out.write("<tr title='Total number of values stored locally'><td>Values</td><td>" + str(self.values) + '</td></tr>\n')
+ out.write("</table>\n")
+ out.write("</td></tr><tr><td colspan='3'>\n")
+
+ # Transport
+ out.write("<table border='1' cellpadding='4px'>\n")
+ out.write("<tr><th><h3>Transport</h3></th><th>Packets</th><th>Bytes</th><th>Speed</th></tr>\n")
+ out.write("<tr title='Stats for packets received from the DHT'><td>Downloaded</td>")
+ out.write('<td>' + str(self.downPackets) + '</td>')
+ out.write('<td>' + byte_format(self.downBytes) + '</td>')
+ out.write('<td>' + byte_format(self.downBytes / (elapsed.days*86400.0 + elapsed.seconds)) + '/sec</td></tr>\n')
+ out.write("<tr title='Stats for packets sent to the DHT'><td>Uploaded</td>")
+ out.write('<td>' + str(self.upPackets) + '</td>')
+ out.write('<td>' + byte_format(self.upBytes) + '</td>')
+ out.write('<td>' + byte_format(self.upBytes / (elapsed.days*86400.0 + elapsed.seconds)) + '/sec</td></tr>\n')
+ out.write("</table>\n")
+ out.write("</td></tr><tr><td colspan='3'>\n")
+
+ # Actions
+ out.write("<table border='1' cellpadding='4px'>\n")
+ out.write("<tr><th><h3>Actions</h3></th><th>Started</th><th>Sent</th>")
+ out.write("<th>Successful</th><th>Failed</th><th>Completed</th><th>Received</th><th>Error</th>")
+ out.write("<th>Successful Delay</th><th>Failed Delay</th><th>Total Delay</th></tr>\n")
+ actions = self.actions.keys()
+ actions.sort()
+ for action in actions:
+ out.write("<tr><td>" + action + "</td>")
+ for i in xrange(7):
+ out.write("<td>" + str(self.actions[action][i]) + "</td>")
+ for i in xrange(3):
+ count = self.actions[action][i+2]
+ if count > 0:
+ total_delay = self.actions[action][i+7]
+ avg_delay = total_delay / count
+ avg_delay_sec = avg_delay.days*86400.0 + avg_delay.seconds + avg_delay.microseconds/1000000.0
+ else:
+ avg_delay_sec = 0.0
+ out.write("<td>%0.2f</td>" % avg_delay_sec)
+ out.write('</tr>\n')
+ out.write("</table>\n")
+ out.write("</td></tr>\n")
+ out.write("</table>\n")
+
+ return out.getvalue()
+
+ #{ Called by the action
+ def startedAction(self, action):
+ """Record that an action was started.
+
+ @param action: the name of the action
+ """
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[0] += 1
#{ Called by the transport
def sentAction(self, action):
@param action: the name of the action
"""
- act = self.actions.setdefault(action, [0, 0, 0, 0, 0])
- act[0] += 1
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[1] += 1
- def responseAction(self, response, action):
+ def responseAction(self, response, action, start):
"""Record that a response to an action was received.
@param response: the response
@param action: the name of the action
+ @param start: the time the action was started
@return: the response (for use in deferreds)
"""
- act = self.actions.setdefault(action, [0, 0, 0, 0, 0])
- act[1] += 1
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[2] += 1
+ act[7] += datetime.now() - start
return response
- def failedAction(self, response, action):
+ def failedAction(self, response, action, start):
"""Record that a failed response to an action was received.
@param response: the response
@param action: the name of the action
+ @param start: the time the action was started
@return: the response (for use in deferreds)
"""
- act = self.actions.setdefault(action, [0, 0, 0, 0, 0])
- act[2] += 1
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[3] += 1
+ act[8] += datetime.now() - start
return response
+ def completedAction(self, action, start):
+ """Record that an action was completed.
+
+ @param action: the name of the action
+ @param start: the time the action was started
+ """
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[4] += 1
+ act[9] += datetime.now() - start
+
def receivedAction(self, action):
"""Record that an action was received.
@param action: the name of the action
"""
self.reachable = True
- act = self.actions.setdefault(action, [0, 0, 0, 0, 0])
- act[3] += 1
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[5] += 1
def errorAction(self, action):
"""Record that a received action resulted in an error.
@param action: the name of the action
"""
- act = self.actions.setdefault(action, [0, 0, 0, 0, 0])
- act[4] += 1
+ act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0, 0, timedelta(), timedelta(), timedelta()])
+ act[6] += 1
def sentBytes(self, bytes):
"""Record that a single packet of some bytes was sent.