2 """Store statistics for the Khashmir DHT."""
4 from datetime import datetime, timedelta
5 from StringIO import StringIO
8 from util import byte_format
11 """Store the statistics for the Khashmir DHT.
13 @ivar startTime: the time the program was started
14 @ivar reachable: whether we can be contacted by other nodes
15 @type table: L{ktable.KTable}
16 @ivar table: the routing table for the DHT
17 @ivar lastTableUpdate: the last time an update of the table stats was done
18 @ivar nodes: the number of nodes connected
19 @ivar users: the estimated number of total users in the DHT
21 @ivar store: the database for the DHT
22 @ivar lastDBUpdate: the last time an update of the database stats was done
23 @ivar keys: the number of distinct keys in the database
24 @ivar values: the number of values in the database
25 @ivar downPackets: the number of packets received
26 @ivar upPackets: the number of packets sent
27 @ivar downBytes: the number of bytes received
28 @ivar upBytes: the number of bytes sent
29 @ivar actions: a dictionary of the actions and their statistics, keys are
30 the action name, values are a list of 5 elements for the number of
31 times the action was sent, responded to, failed, received, and
35 def __init__(self, table, store):
36 """Initialize the statistics.
38 @type table: L{ktable.KTable}
39 @param table: the routing table for the DHT
41 @param store: the database for the DHT
44 self.startTime = datetime.now().replace(microsecond=0)
45 self.reachable = False
49 self.lastTableUpdate = datetime.now()
55 self.lastDBUpdate = datetime.now()
67 """Collect some statistics about the routing table.
69 @rtype: (C{int}, C{int})
70 @return: the number of contacts in the routing table, and the estimated
71 number of nodes in the entire DHT
73 if datetime.now() - self.lastTableUpdate > timedelta(seconds = 15):
74 self.lastTableUpdate = datetime.now()
75 self.nodes = reduce(lambda a, b: a + len(b.l), self.table.buckets, 0)
76 self.users = K * (2**(len(self.table.buckets) - 1))
77 return (self.nodes, self.users)
80 """Collect some statistics about the database.
82 @rtype: (C{int}, C{int})
83 @return: the number of keys and values in the database
85 if datetime.now() - self.lastDBUpdate > timedelta(minutes = 1):
86 self.lastDBUpdate = datetime.now()
87 self.keys, self.values = self.store.keyStats()
88 return (self.keys, self.values)
91 """Gather statistics for the DHT and format them for display in a browser.
94 @return: the stats, formatted for display in the body of an HTML page
98 elapsed = datetime.now().replace(microsecond=0) - self.startTime
100 out.write('<h2>DHT Statistics</h2>\n')
101 out.write("<table border='0' cellspacing='20px'>\n<tr>\n")
105 out.write("<table border='1' cellpadding='4px'>\n")
106 out.write("<tr><th><h3>General</h3></th><th>Value</th></tr>\n")
107 out.write("<tr title='Elapsed time since the DHT was started'><td>Up time</td><td>" + str(elapsed) + '</td></tr>\n')
108 out.write("<tr title='Whether this node is reachable by other nodes'><td>Reachable</td><td>" + str(self.reachable) + '</td></tr>\n')
109 out.write("</table>\n")
110 out.write('</td><td>\n')
113 out.write("<table border='1' cellpadding='4px'>\n")
114 out.write("<tr><th><h3>Routing Table</h3></th><th>Value</th></tr>\n")
115 out.write("<tr title='The number of connected nodes'><td>Number of nodes</td><td>" + str(self.nodes) + '</td></tr>\n')
116 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')
117 out.write("</table>\n")
118 out.write('</td><td>\n')
121 out.write("<table border='1' cellpadding='4px'>\n")
122 out.write("<tr><th><h3>Database</h3></th><th>Value</th></tr>\n")
123 out.write("<tr title='Number of distinct keys in the database'><td>Keys</td><td>" + str(self.keys) + '</td></tr>\n')
124 out.write("<tr title='Total number of values stored locally'><td>Values</td><td>" + str(self.values) + '</td></tr>\n')
125 out.write("</table>\n")
126 out.write("</td></tr><tr><td colspan='3'>\n")
129 out.write("<table border='1' cellpadding='4px'>\n")
130 out.write("<tr><th><h3>Transport</h3></th><th>Packets</th><th>Bytes</th><th>Speed</th></tr>\n")
131 out.write("<tr title='Stats for packets received from the DHT'><td>Downloaded</td>")
132 out.write('<td>' + str(self.downPackets) + '</td>')
133 out.write('<td>' + byte_format(self.downBytes) + '</td>')
134 out.write('<td>' + byte_format(self.downBytes / (elapsed.days*86400.0 + elapsed.seconds)) + '/sec</td></tr>\n')
135 out.write("<tr title='Stats for packets sent to the DHT'><td>Uploaded</td>")
136 out.write('<td>' + str(self.upPackets) + '</td>')
137 out.write('<td>' + byte_format(self.upBytes) + '</td>')
138 out.write('<td>' + byte_format(self.upBytes / (elapsed.days*86400.0 + elapsed.seconds)) + '/sec</td></tr>\n')
139 out.write("</table>\n")
140 out.write("</td></tr><tr><td colspan='3'>\n")
143 out.write("<table border='1' cellpadding='4px'>\n")
144 out.write("<tr><th><h3>Actions</h3></th><th>Started</th><th>Sent</th><th>OK</th><th>Failed</th><th>Received</th><th>Error</th></tr>\n")
145 actions = self.actions.keys()
147 for action in actions:
148 out.write("<tr><td>" + action + "</td>")
150 out.write("<td>" + str(self.actions[action][i]) + "</td>")
152 out.write("</table>\n")
153 out.write("</td></tr>\n")
154 out.write("</table>\n")
156 return out.getvalue()
158 #{ Called by the action
159 def startedAction(self, action):
160 """Record that an action was started.
162 @param action: the name of the action
164 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
167 #{ Called by the transport
168 def sentAction(self, action):
169 """Record that an action was attempted.
171 @param action: the name of the action
173 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
176 def responseAction(self, response, action):
177 """Record that a response to an action was received.
179 @param response: the response
180 @param action: the name of the action
181 @return: the response (for use in deferreds)
183 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
187 def failedAction(self, response, action):
188 """Record that a failed response to an action was received.
190 @param response: the response
191 @param action: the name of the action
192 @return: the response (for use in deferreds)
194 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
198 def receivedAction(self, action):
199 """Record that an action was received.
201 @param action: the name of the action
203 self.reachable = True
204 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
207 def errorAction(self, action):
208 """Record that a received action resulted in an error.
210 @param action: the name of the action
212 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
215 def sentBytes(self, bytes):
216 """Record that a single packet of some bytes was sent.
218 @param bytes: the number of bytes in the packet
221 self.upBytes += bytes
223 def receivedBytes(self, bytes):
224 """Record that a single packet of some bytes was received.
226 @param bytes: the number of bytes in the packet
228 self.downPackets += 1
229 self.downBytes += bytes