diff --git a/README.md b/README.md index 71718061..465b8352 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,23 @@ That translates to: This has been a good tradeoff so far between size-of-file (round robin databases are fixed size) and data we care about. Each "stats" database is about 3.2 megs with these retentions. +TCP Stats Interface +------------------- + +A really simple TCP management interface is available by default on port 8126 or overriden in the configuration file. Inspired by the memcache stats approach this can be used to monitor a live statsd server. You can interact with the management server by telnetting to port 8126, the following commands are available: + +* stats - some stats about the running server +* counters - a dump of all the current counters +* timers - a dump of the current timers + +The stats output currently will give you: + +* uptime: the number of seconds elapsed since statsd started +* graphite.last_flush: the number of seconds elapsed since the last successful flush to graphite +* graphite.last_exception: the number of seconds elapsed since the last exception thrown whilst flushing to graphite +* messages.last_msg_seen: the number of elapsed seconds since statsd received a message +* messages.bad_lines_seen: the number of bad lines seen since startup + Installation and Configuration ------------------------------