README.md in fozzie-0.0.21 vs README.md in fozzie-0.0.22
- old
+ new
@@ -1,17 +1,23 @@
-# Fozzie
+# Fozzie [![travis-ci](https://secure.travis-ci.org/lonelyplanet/fozzie.png)](https://secure.travis-ci.org/lonelyplanet/fozzie)
-Ruby gem for registering statistics to Statsd in various ways.
+Ruby gem for registering statistics to a [Statsd](https://github.com/etsy/statsd) server in various ways.
+## Requirements
+
+* A Statsd server
+* Ruby 1.9
+
## Basic Usage
Send through statistics depending on the type you want to provide:
### Increment counter
- Stats.increment 'wat'
-
+ Stats.increment 'wat' # increments the value in a Statsd bucket called 'some.prefix.wat' -
+ # the exact bucket name depends on the bucket name prefix (see below)
+
### Decrement counter
Stats.decrement 'wat'
### Decrement counter - provide a value as integer
@@ -140,26 +146,31 @@
lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'OK'] }
}
### Rails
-Based on the Rack middleware above, but is more involved in it's construction of the bucket value.
+Based on the Rack middleware above, but is more involved in its construction of the bucket value.
Fozzie::Rails::Middleware will automatically be invoked on Rails initialization.
## Bucket name prefixes
-Fozzie will construct bucket name prefixes according to your settings and environment. Example would be
+Fozzie automatically constructs bucket name prefixes from app name,
+hostname, and environment. For example:
- Stats.increment 'foo'
+ Stats.increment 'wat'
-Would be represented as the following Graphite bucket:
+increments the bucket named
- wat.your-computer-name.development.foo
+ app-name.your-computer-name.development.wat
-When working on your development machine. This allows multiple application instances, in different environments, to be distinguished easily, and collated in Graphite quickly.
+When working on your development machine. This allows multiple
+application instances, in different environments, to be distinguished
+easily and collated in Graphite quickly.
+The app name can be configured via the YAML configuration.
+
## Low level behaviour
The current implementation of Fozzie wraps the sending of the statistic in a timeout and rescue block, which prevent long host lookups (i.e. if your stats server disappears) and minimises impact on your code or application if something is erroring at a low level.
Fozzie will try to log these errors, but only if a logger has been applied (which by default it does not). Examples:
@@ -176,18 +187,20 @@
If you also require UI metrics, you can also include the Mill script in the bottom of any page you would like to measure (see `resources/mill.js` and `resources/mill.min.js`) and you start receiving measurements on page performance.
## Credits
-Currently supported and maintained by [Marc Watts](marc.watts@lonelyplanet.co.uk) @Lonely Planet Online.
+Currently supported and maintained by [Marc Watts](marc.watts@lonelyplanet.co.uk) @ Lonely Planet Online.
-Big thanks to:
+Big thanks and Credits:
* [Mark Barger](mark.barger@lonelyplanet.co.uk) for support in trying to make this Gem useful.
-* [Etsy](http://codeascraft.etsy.com/) who's [Statsd](https://github.com/etsy/statsd) product has enabled us to come such a long way in a very short period of time. We love Etsy.
+* [Dave Nolan](https://github.com/textgoeshere)
+* [Etsy](http://codeascraft.etsy.com/) whose [Statsd](https://github.com/etsy/statsd) product has enabled us to come such a long way in a very short period of time. We love Etsy.
+
* [reinh](https://github.com/reinh/statsd) for his [statsd](https://github.com/reinh/statsd) Gem.
## Comments and Feedback
-Please [contact](marc.watts@lonelyplanet.co.uk) me on anything... improvements will be needed and are welcomed greatly.
\ No newline at end of file
+Please [contact](marc.watts@lonelyplanet.co.uk) me on anything... improvements will be needed and are welcomed greatly.