wrote very limited memo

git-svn-id: svn://bind10.isc.org/svn/bind10/branches/parkinglot@668 e5f2f494-b856-4b98-b285-d166d9295462

src/bin/stats/TODO

@@ -0,0 +1,5 @@
+statsd TODO.
+
+- read configuration from cfgd.
+- how to publish statistics data
+- need to be controled by BoB

src/bin/stats/statsd.txt

@@ -0,0 +1,21 @@
+= statsd Overview =
+
+statsd gathers statistics from each BIND 10 components and dump them into a file periodically.
+
+Currently, file path, dump frequency, rotate generations are fixed.
+statsd dumps to "/tmp/stats" every 10 seconds except no statistics received.
+"/tmp/stats" are preserved 100 generations.
+
+= statistics channel Message format =
+
+The statsd accepts python dictionary format data from msgq "statistics" channel.
+
+The data need to contain "components", "version", "timestamp", "stats" keys.
+
+The statistics data is { "component" : "<component_name>", "version": "<version number>", "timestamp": "<unixtime>", "stats": <python dictionary format statistics>}. "stats" data may be nested.
+
+"stats" data is defined by each component.
+
+Each component may send statistics data to "statistics" group periodically without joining the group.
+
+See a example component: "stats/test/test-agent.py".