README.md in rstatsd-0.2 vs README.md in rstatsd-0.3
- old
+ new
@@ -1,15 +1,17 @@
# rstatsd
-rstatsd is a ruby based daemon for capturing data from statsd clients.
+rstatsd is a ruby based daemon for capturing data from statsd clients and
+displaying graphs. It stores graph data in fixed-length data structures
+in redis.
-rstatsd is inspired by the work at etsy to measure everything, measure
-anything. They use a combination of node.js and graphite to capture and
-graph this data.
+rstatsd is inspired by the work at etsy to measure anything, measure
+everything. They use a combination of node.js and graphite to capture
+and graph this data.
-The goal of this project was to replicate this light-weight approach and
-reduce the number of dependencies to do this to two: redis and ruby.
+The goal of this project was to replicate this approach in a very light-weight
+way by reducing the number of dependencies to do this to two: redis and ruby.
## Installation
$ gem install rstatsd
@@ -23,27 +25,23 @@
Start the collection daemon and server
$ rstatsd
-Add some data (you'll need a statsd compatible client like statsd-ruby)
+Open the web server in a browser and follow the directions:
- $ irb
- irb> require 'statsd'
- => true
- irb> s = Statsd.new('localhost')
- => #<Statsd:0x007fee419866d8 @host="localhost", @port=8125>
- irb(main):004:0> s.increment('grebulons')
- => 10
- irb> s.increment('grebulons')
- => 10
- irb> s.increment('grebulons')
- => 10
- irb> s.increment('grebulons')
- => 10
+ $ open http://localhost:8126/
+## URL Schema
-Then view the result in a web browser
+You can request multiple data points to be graphed simultaneously by specifying multiple targets:
- irb> `open http://localhost:8126/?target=grebulons`
+http://localhost:8126/stats?target=foo&target=bar
-Bask in the something of something-something.
+## Supported data types
+
+* counters (statsd.increment, statsd.decrement)
+
+## Todo
+
+* statsd data types other than counters
+* time window graphing