fozzie 0.0.17 → 0.0.18

data/README.md

@@ -1,6 +1,193 @@
-Fozzie 
-===========
+# Fozzie
 
-Ruby gem for registering metrics via Statsd... with some nice extras.
+Ruby gem for registering statistics to Statsd in various ways.
 
-![Fozzie](http://upload.wikimedia.org/wikipedia/en/6/66/Fozzie-bear.jpg)
+## Basic Usage
+
+Send through statistics depending on the type you want to provide:
+
+### Increment counter
+
+    Stats.increment 'wat'
+
+### Decrement counter
+
+    Stats.decrement 'wat'
+
+### Decrement counter - provide a value as integer
+
+    Stats.count 'wat', 5
+
+### Basic timing - provide a value in milliseconds
+
+    Stats.timing 'wat', 500
+
+### Timings - provide a block to time against (inline and do syntax supported)
+
+    Stats.time 'wat' { sleep 5 }
+
+    Stats.time_to_do 'wat' do
+      sleep 5
+    end
+
+    Stats.time_for 'wat' { sleep 5 }
+
+### Events - register different events
+
+
+#### Commits
+
+    Stats.commit
+
+    Stats.committed
+
+#### Builds
+
+    Stats.built
+
+    Stats.build
+
+#### Deployments
+
+    Stats.deployed
+
+  With a custom app:
+
+    Stats.deployed 'watapp'
+
+    Stats.deploy
+
+  With a custom app:
+
+    Stats.deploy 'watapp'
+
+#### Custom
+
+    Stats.event 'pull'
+
+  With a custom app:
+
+    Stats.event 'pull', 'watapp'
+
+### Boolean result - pass a value to be true or false, and increment on true
+
+    Stats.increment_on 'wat', duck.valid?
+
+## Sampling
+
+Each of the above methods accepts a sample rate as the last argument (before any applicable blocks), e.g:
+
+    Stats.increment 'wat', 10
+
+    Stats.decrement 'wat', 10
+
+    Stats.count 'wat', 5, 10
+
+## Namespaces
+
+Fozzie supports the following namespaces as default
+
+    Stats.increment 'wat'
+    S.increment 'wat'
+    Statistics.increment 'wat'
+    Warehouse.increment 'wat'
+
+You can customise this via the YAML configuration (see instructions below)
+
+## Configuration
+
+Fozzie is configured via a YAML or by setting a block against the Fozzie namespace.
+
+### YAML
+
+Create a `fozzie.yml` within a `config` folder on the root of your app, which contains your settings for each env. Simple, verbose example below.
+
+    development:
+      appname: wat
+      host: '127.0.0.1'
+      port: 8125
+      namespaces: %w{Foo Bar Wat}
+    test:
+      appname: wat
+      host: 'localhost'
+      port: 8125
+      namespaces: %w{Foo Bar Wat}
+    production:
+      appname: wat
+      host: 'stats.wat.com'
+      port: 8125
+      namespaces: %w{Foo Bar Wat}
+
+### Configure block
+
+    Fozzie.configure do |config|
+      config.appname = "wat"
+      config.host    = "127.0.0.1"
+      config.port    = 8125
+    end
+
+## Middleware
+
+To time and register the controller actions within your Rails application, Fozzie provides some middleware.
+
+### Rack
+
+    require 'rack'
+    require 'fozzie'
+
+    app = Rack::Builder.new {
+      use Fozzie::Rack::Middleware
+      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.
+
+Add the following to your `config/environment.rb`
+
+    Rails::Initializer.run do |config|
+      config.middleware.use 'Fozzie::Rails::Middleware'
+    end
+
+## Bucket name prefixes
+
+Fozzie will construct bucket name prefixes according to your settings and environment. Example would be
+
+    Stats.increment 'foo'
+
+Would be represented as the following Graphite bucket:
+
+    wat.your-computer-name.development.foo
+
+When working on your development machine. This allows multiple application instances, in different environments, to be distinguished easily, and collated in Graphite quickly.
+
+## 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:
+  
+    require 'logger'
+    Fozzie.logger = Logger.new(STDOUT)
+
+    require 'logger'
+    Fozzie.logger = Logger.new 'log/fozzie.log'
+
+This may change, depending on feedback and more production experience.
+
+## Credits
+
+Currently supported and maintained by [Marc Watts](marc.watts@lonelyplanet.co.uk) @Lonely Planet Online.
+
+Big thanks to:
+
+* [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.
+
+* [https://github.com/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.

data/doc/lib/fozzie.html

@@ -105,6 +105,8 @@ designed to make gathering stastistics from applications easy, fast, and effecti
           <a class="pilcrow" href="#section-5">&#182;</a>
         </div>
         <p>Set a logger</p>
+
+<p><code>Fozzie.logger = Logger.new(STDOUT)</code></p>
       </td>
       <td class=code>
         <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">logger</span><span class="o">=</span><span class="p">(</span><span class="n">logger</span><span class="p">)</span>
@@ -118,6 +120,8 @@ designed to make gathering stastistics from applications easy, fast, and effecti
           <a class="pilcrow" href="#section-6">&#182;</a>
         </div>
         <p>Accessor for logger</p>
+
+<p><code>Fozzie.logger.warn &lsquo;foo&rsquo;</code></p>
       </td>
       <td class=code>
         <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">logger</span>

data/doc/lib/fozzie/interface.html

@@ -273,8 +273,8 @@
 
       </td>
       <td class=code>
-        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">event</span><span class="p">(</span><span class="nb">type</span><span class="p">,</span> <span class="n">app</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">)</span>
-      <span class="n">timing</span> <span class="o">[</span><span class="s2">&quot;event&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">.</span><span class="n">to_s</span><span class="p">,</span> <span class="n">app</span><span class="o">]</span><span class="p">,</span> <span class="no">Time</span><span class="o">.</span><span class="n">now</span><span class="o">.</span><span class="n">usec</span>
+        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">event</span><span class="p">(</span><span class="n">type</span><span class="p">,</span> <span class="n">app</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">)</span>
+      <span class="n">timing</span> <span class="o">[</span><span class="s2">&quot;event&quot;</span><span class="p">,</span> <span class="n">type</span><span class="o">.</span><span class="n">to_s</span><span class="p">,</span> <span class="n">app</span><span class="o">]</span><span class="p">,</span> <span class="no">Time</span><span class="o">.</span><span class="n">now</span><span class="o">.</span><span class="n">usec</span>
     <span class="k">end</span>
 
   <span class="k">end</span>

data/doc/lib/fozzie/socket.html

@@ -39,7 +39,9 @@
         
       </td>
       <td class=code>
-        <div class='highlight'><pre><span class="k">module</span> <span class="nn">Fozzie</span>
+        <div class='highlight'><pre><span class="nb">require</span> <span class="s1">&#39;socket&#39;</span>
+
+<span class="k">module</span> <span class="nn">Fozzie</span>
   <span class="k">module</span> <span class="nn">Socket</span>
 
     <span class="no">RESERVED_CHARS_REGEX</span> <span class="o">=</span> <span class="sr">/[\:\|\@]/</span>
@@ -57,13 +59,13 @@
 <p>Creates the Statsd key from the given values, and sends to socket (depending on sample rate)</p>
       </td>
       <td class=code>
-        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">send</span><span class="p">(</span><span class="n">stat</span><span class="p">,</span> <span class="n">delta</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">sample_rate</span><span class="p">)</span>
+        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">send</span><span class="p">(</span><span class="n">stat</span><span class="p">,</span> <span class="n">delta</span><span class="p">,</span> <span class="n">type</span><span class="p">,</span> <span class="n">sample_rate</span><span class="p">)</span>
       <span class="n">stat</span> <span class="o">=</span> <span class="o">[</span><span class="n">stat</span><span class="o">].</span><span class="n">flatten</span><span class="o">.</span><span class="n">compact</span><span class="o">.</span><span class="n">collect</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:to_s</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">downcase</span>
       <span class="n">stat</span> <span class="o">=</span> <span class="n">stat</span><span class="o">.</span><span class="n">gsub</span><span class="p">(</span><span class="s1">&#39;::&#39;</span><span class="p">,</span> <span class="s1">&#39;.&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">gsub</span><span class="p">(</span><span class="no">RESERVED_CHARS_REGEX</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">)</span>
 
       <span class="n">k</span> <span class="o">=</span>  <span class="o">[</span><span class="no">Fozzie</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">data_prefix</span><span class="p">,</span> <span class="n">stat</span><span class="o">].</span><span class="n">compact</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
       <span class="n">k</span> <span class="o">&lt;&lt;</span> <span class="s2">&quot;:&quot;</span>
-      <span class="n">k</span> <span class="o">&lt;&lt;</span> <span class="o">[</span><span class="n">delta</span><span class="p">,</span> <span class="nb">type</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;|&#39;</span><span class="p">)</span>
+      <span class="n">k</span> <span class="o">&lt;&lt;</span> <span class="o">[</span><span class="n">delta</span><span class="p">,</span> <span class="n">type</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;|&#39;</span><span class="p">)</span>
       <span class="n">k</span> <span class="o">&lt;&lt;</span> <span class="s1">&#39;@%s&#39;</span> <span class="o">%</span> <span class="n">sample_rate</span><span class="o">.</span><span class="n">to_s</span> <span class="k">if</span> <span class="n">sample_rate</span> <span class="o">&lt;</span> <span class="mi">1</span>
 
       <span class="n">sampled</span><span class="p">(</span><span class="n">sample_rate</span><span class="p">)</span> <span class="p">{</span> <span class="n">send_to_socket</span><span class="p">(</span><span class="n">k</span><span class="o">.</span><span class="n">strip</span><span class="p">)</span> <span class="p">}</span>
@@ -115,7 +117,7 @@
       </td>
       <td class=code>
         <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">socket</span>
-      <span class="vi">@socket</span> <span class="o">||=</span> <span class="no">UDPSocket</span><span class="o">.</span><span class="n">new</span>
+      <span class="vi">@socket</span> <span class="o">||=</span> <span class="o">::</span><span class="no">UDPSocket</span><span class="o">.</span><span class="n">new</span>
     <span class="k">end</span>
 
   <span class="k">end</span>

data/fozzie.gemspec

@@ -5,10 +5,13 @@ require "fozzie/version"
 Gem::Specification.new do |s|
   s.name        = "fozzie"
   s.version     = Fozzie::VERSION
-  s.authors     = ["Marc Watts"]
-  s.email       = ["marcky.sharky@gmail.com"]
-  s.summary     = %q{Statsd gem bolt-on}
-  s.description = %q{Gem allows statistics gathering from Ruby and Ruby on Rails applications to Statsd}
+  s.authors     = ["Marc Watts", "Mark Barger"]
+  s.email       = ["marc.watts@lonelyplanet.co.uk"]
+  s.summary     = %q{Statsd Ruby gem from Lonely Planet Online}
+  s.description = %q{
+    Gem to make statistics sending to Statsd from Ruby applications simple and efficient as possible.
+    Inspired by the original ruby-statsd gem by Etsy, currently used by Lonely Planet Online.
+  }
 
   s.rubyforge_project = "fozzie"
 
@@ -16,7 +19,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_dependency 'sys-uname'
 
   s.add_development_dependency 'rake'
@@ -28,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'sinatra'
   s.add_development_dependency 'actionpack'
-  
+
   s.add_development_dependency 'guard'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rocco'

data/lib/fozzie.rb

@@ -36,11 +36,16 @@ module Fozzie
     end
 
     # Set a logger
+    #
+    #
+    # `Fozzie.logger = Logger.new(STDOUT)`
     def logger=(logger)
       @logger = logger
     end
 
     # Accessor for logger
+    #
+    # `Fozzie.logger.warn 'foo'`
     def logger
       @logger
     end

data/lib/fozzie/socket.rb

@@ -1,3 +1,5 @@
+require 'socket'
+
 module Fozzie
   module Socket
 
@@ -42,7 +44,7 @@ module Fozzie
 
     # The Socket we want to use to send data
     def socket
-      @socket ||= UDPSocket.new
+      @socket ||= ::UDPSocket.new
     end
 
   end

data/lib/fozzie/version.rb

@@ -1,3 +1,3 @@
 module Fozzie
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: fozzie
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
 - Marc Watts
+- Mark Barger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-uname
-  requirement: &70183205078380 !ruby/object:Gem::Requirement
+  requirement: &70348897347620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70183205078380
+  version_requirements: *70348897347620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70183205093600 !ruby/object:Gem::Requirement
+  requirement: &70348897347100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205093600
+  version_requirements: *70348897347100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70183205092780 !ruby/object:Gem::Requirement
+  requirement: &70348897346500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205092780
+  version_requirements: *70348897346500
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70183205091800 !ruby/object:Gem::Requirement
+  requirement: &70348897345740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205091800
+  version_requirements: *70348897345740
 - !ruby/object:Gem::Dependency
   name: syntax
-  requirement: &70183205090760 !ruby/object:Gem::Requirement
+  requirement: &70348897344940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205090760
+  version_requirements: *70348897344940
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70183205089920 !ruby/object:Gem::Requirement
+  requirement: &70348897344260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205089920
+  version_requirements: *70348897344260
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70183205089140 !ruby/object:Gem::Requirement
+  requirement: &70348897343500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205089140
+  version_requirements: *70348897343500
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70183205088360 !ruby/object:Gem::Requirement
+  requirement: &70348897342980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205088360
+  version_requirements: *70348897342980
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70183205087460 !ruby/object:Gem::Requirement
+  requirement: &70348897342480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205087460
+  version_requirements: *70348897342480
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70183205086840 !ruby/object:Gem::Requirement
+  requirement: &70348897357340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205086840
+  version_requirements: *70348897357340
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70183205102560 !ruby/object:Gem::Requirement
+  requirement: &70348897350820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +132,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205102560
+  version_requirements: *70348897350820
 - !ruby/object:Gem::Dependency
   name: guard-rocco
-  requirement: &70183205101880 !ruby/object:Gem::Requirement
+  requirement: &70348897349720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +143,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205101880
+  version_requirements: *70348897349720
 - !ruby/object:Gem::Dependency
   name: fl-rocco
-  requirement: &70183205101220 !ruby/object:Gem::Requirement
+  requirement: &70348897385560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,11 +154,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183205101220
-description: Gem allows statistics gathering from Ruby and Ruby on Rails applications
-  to Statsd
+  version_requirements: *70348897385560
+description: ! "\n    Gem to make statistics sending to Statsd from Ruby applications
+  simple and efficient as possible.\n    Inspired by the original ruby-statsd gem
+  by Etsy, currently used by Lonely Planet Online.\n  "
 email:
-- marcky.sharky@gmail.com
+- marc.watts@lonelyplanet.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -209,7 +211,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 75122058829835203
+      hash: -636781354410393457
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -218,13 +220,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 75122058829835203
+      hash: -636781354410393457
 requirements: []
 rubyforge_project: fozzie
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Statsd gem bolt-on
+summary: Statsd Ruby gem from Lonely Planet Online
 test_files:
 - spec/config/fozzie.yml
 - spec/lib/core_ext/hash_spec.rb