2 """Store statistics for the Khashmir DHT."""
4 from datetime import datetime, timedelta
5 from StringIO import StringIO
7 from util import byte_format
10 """Store the statistics for the Khashmir DHT.
12 @type config: C{dictionary}
13 @ivar config: the configuration parameters for the DHT
14 @ivar startTime: the time the program was started
15 @ivar reachable: whether we can be contacted by other nodes
16 @type table: L{ktable.KTable}
17 @ivar table: the routing table for the DHT
18 @ivar lastTableUpdate: the last time an update of the table stats was done
19 @ivar nodes: the number of nodes connected
20 @ivar users: the estimated number of total users in the DHT
22 @ivar store: the database for the DHT
23 @ivar lastDBUpdate: the last time an update of the database stats was done
24 @ivar keys: the number of distinct keys in the database
25 @ivar values: the number of values in the database
26 @ivar downPackets: the number of packets received
27 @ivar upPackets: the number of packets sent
28 @ivar downBytes: the number of bytes received
29 @ivar upBytes: the number of bytes sent
30 @ivar actions: a dictionary of the actions and their statistics, keys are
31 the action name, values are a list of 5 elements for the number of
32 times the action was sent, responded to, failed, received, and
36 def __init__(self, table, store, config):
37 """Initialize the statistics.
39 @type table: L{ktable.KTable}
40 @param table: the routing table for the DHT
42 @param store: the database for the DHT
43 @type config: C{dictionary}
44 @param config: the configuration parameters for the DHT
48 self.startTime = datetime.now().replace(microsecond=0)
49 self.reachable = False
53 self.lastTableUpdate = datetime.now()
59 self.lastDBUpdate = datetime.now()
71 """Collect some statistics about the routing table.
73 @rtype: (C{int}, C{int})
74 @return: the number of contacts in the routing table, and the estimated
75 number of nodes in the entire DHT
77 if datetime.now() - self.lastTableUpdate > timedelta(seconds = 15):
78 self.lastTableUpdate = datetime.now()
79 self.nodes = reduce(lambda a, b: a + len(b.l), self.table.buckets, 0)
80 self.users = self.config['K'] * (2**(len(self.table.buckets) - 1))
81 return (self.nodes, self.users)
84 """Collect some statistics about the database.
86 @rtype: (C{int}, C{int})
87 @return: the number of keys and values in the database
89 if datetime.now() - self.lastDBUpdate > timedelta(minutes = 1):
90 self.lastDBUpdate = datetime.now()
91 self.keys, self.values = self.store.keyStats()
92 return (self.keys, self.values)
95 """Gather statistics for the DHT and format them for display in a browser.
98 @return: the stats, formatted for display in the body of an HTML page
102 elapsed = datetime.now().replace(microsecond=0) - self.startTime
104 out.write('<h2>DHT Statistics</h2>\n')
105 out.write("<table border='0' cellspacing='20px'>\n<tr>\n")
109 out.write("<table border='1' cellpadding='4px'>\n")
110 out.write("<tr><th><h3>General</h3></th><th>Value</th></tr>\n")
111 out.write("<tr title='Elapsed time since the DHT was started'><td>Up time</td><td>" + str(elapsed) + '</td></tr>\n')
112 out.write("<tr title='Whether this node is reachable by other nodes'><td>Reachable</td><td>" + str(self.reachable) + '</td></tr>\n')
113 out.write("</table>\n")
114 out.write('</td><td>\n')
117 out.write("<table border='1' cellpadding='4px'>\n")
118 out.write("<tr><th><h3>Routing Table</h3></th><th>Value</th></tr>\n")
119 out.write("<tr title='The number of connected nodes'><td>Number of nodes</td><td>" + str(self.nodes) + '</td></tr>\n')
120 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')
121 out.write("</table>\n")
122 out.write('</td><td>\n')
125 out.write("<table border='1' cellpadding='4px'>\n")
126 out.write("<tr><th><h3>Database</h3></th><th>Value</th></tr>\n")
127 out.write("<tr title='Number of distinct keys in the database'><td>Keys</td><td>" + str(self.keys) + '</td></tr>\n')
128 out.write("<tr title='Total number of values stored locally'><td>Values</td><td>" + str(self.values) + '</td></tr>\n')
129 out.write("</table>\n")
130 out.write("</td></tr><tr><td colspan='3'>\n")
133 out.write("<table border='1' cellpadding='4px'>\n")
134 out.write("<tr><th><h3>Transport</h3></th><th>Packets</th><th>Bytes</th><th>Speed</th></tr>\n")
135 out.write("<tr title='Stats for packets received from the DHT'><td>Downloaded</td>")
136 out.write('<td>' + str(self.downPackets) + '</td>')
137 out.write('<td>' + byte_format(self.downBytes) + '</td>')
138 out.write('<td>' + byte_format(self.downBytes / (elapsed.days*86400.0 + elapsed.seconds)) + '/sec</td></tr>\n')
139 out.write("<tr title='Stats for packets sent to the DHT'><td>Uploaded</td>")
140 out.write('<td>' + str(self.upPackets) + '</td>')
141 out.write('<td>' + byte_format(self.upBytes) + '</td>')
142 out.write('<td>' + byte_format(self.upBytes / (elapsed.days*86400.0 + elapsed.seconds)) + '/sec</td></tr>\n')
143 out.write("</table>\n")
144 out.write("</td></tr><tr><td colspan='3'>\n")
147 out.write("<table border='1' cellpadding='4px'>\n")
148 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")
149 actions = self.actions.keys()
151 for action in actions:
152 out.write("<tr><td>" + action + "</td>")
154 out.write("<td>" + str(self.actions[action][i]) + "</td>")
156 out.write("</table>\n")
157 out.write("</td></tr>\n")
158 out.write("</table>\n")
160 return out.getvalue()
162 #{ Called by the action
163 def startedAction(self, action):
164 """Record that an action was started.
166 @param action: the name of the action
168 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
171 #{ Called by the transport
172 def sentAction(self, action):
173 """Record that an action was attempted.
175 @param action: the name of the action
177 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
180 def responseAction(self, response, action):
181 """Record that a response to an action was received.
183 @param response: the response
184 @param action: the name of the action
185 @return: the response (for use in deferreds)
187 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
191 def failedAction(self, response, action):
192 """Record that a failed response to an action was received.
194 @param response: the response
195 @param action: the name of the action
196 @return: the response (for use in deferreds)
198 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
202 def receivedAction(self, action):
203 """Record that an action was received.
205 @param action: the name of the action
207 self.reachable = True
208 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
211 def errorAction(self, action):
212 """Record that a received action resulted in an error.
214 @param action: the name of the action
216 act = self.actions.setdefault(action, [0, 0, 0, 0, 0, 0])
219 def sentBytes(self, bytes):
220 """Record that a single packet of some bytes was sent.
222 @param bytes: the number of bytes in the packet
225 self.upBytes += bytes
227 def receivedBytes(self, bytes):
228 """Record that a single packet of some bytes was received.
230 @param bytes: the number of bytes in the packet
232 self.downPackets += 1
233 self.downBytes += bytes