Commit 5f78edc4 authored by Kazunori Fujiwara's avatar Kazunori Fujiwara
Browse files

added some information


git-svn-id: svn://bind10.isc.org/svn/bind10/branches/parkinglot@684 e5f2f494-b856-4b98-b285-d166d9295462
parent d9bc5da0
= 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".
= Statistics overview =
Result of 26 Jan 2010 evening discussion,
statistics overview was almost fixed.
Statsd listens msgq "statistics" channel, gathers statistics
from each BIND 10 components and dump them into a XML file periodically.
= Statsd current status =
Statsd can run with msgq.
Statsd is not controlled by BoB.
Statsd does not read configuration from cfgd.
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.
Current implementation is put on "bind10/branches/parkinglot/src/bin/stats/".
= 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 format 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 sends statistics data to "statistics" group periodically
without joining the group.
See a example component: "stats/test/test-agent.py".
= How to publish statistics from each component =
For example, parkinglot auth server has one "counter".
Then, parkinglot's statistics message may be
{ "component":"parkinglot", "version":1, "timestamp":unixtime,
stats: { "counter": counter } }.
Send it to msgq "statistics" channel periodically
(For example, every 10 second).
Then "Statsd" will write it to the statistics file periodically.
= TODO =
- statsd.spec
- read configuration from cfgd.
- how to publish statistics data
- controlled by BoB
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment