fozzie 0.0.26 → 0.0.27

data/README.md

@@ -12,101 +12,106 @@ Ruby gem for registering statistics to a [Statsd](https://github.com/etsy/statsd
 Send through statistics depending on the type you want to provide:
 
 ### Increment counter
-
-    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)
-                           
+``` ruby
+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'
-
+``` ruby
+Stats.decrement 'wat'
+```
 ### Decrement counter - provide a value as integer
-
-    Stats.count 'wat', 5
-
+``` ruby
+Stats.count 'wat', 5
+```
 ### Basic timing - provide a value in milliseconds
-
-    Stats.timing 'wat', 500
-
+``` ruby
+Stats.timing 'wat', 500
+```
 ### Timings - provide a block to time against (inline and do syntax supported)
+``` ruby
+Stats.time 'wat' { sleep 5 }
 
-    Stats.time 'wat' { sleep 5 }
-
-    Stats.time_to_do 'wat' do
-      sleep 5
-    end
-
-    Stats.time_for 'wat' { sleep 5 }
+Stats.time_to_do 'wat' do
+  sleep 5
+end
 
+Stats.time_for 'wat' { sleep 5 }
+```
 ### Gauges - register arbitrary values
-
-    Stats.gauge 'wat', 99
-
+``` ruby
+Stats.gauge 'wat', 99
+```
 ### Events - register different events
 
 
 #### Commits
+``` ruby
+Stats.commit
 
-    Stats.commit
-
-    Stats.committed
-
+Stats.committed
+```
 #### Builds
+``` ruby
+Stats.built
 
-    Stats.built
-
-    Stats.build
-
+Stats.build
+```
 #### Deployments
-
-    Stats.deployed
+``` ruby
+Stats.deployed
+```
 
   With a custom app:
+``` ruby
+Stats.deployed 'watapp'
 
-    Stats.deployed 'watapp'
-
-    Stats.deploy
+Stats.deploy
+```
 
   With a custom app:
-
-    Stats.deploy 'watapp'
+``` ruby
+Stats.deploy 'watapp'
+```
 
 #### Custom
-
-    Stats.event 'pull'
-
-  With a custom app:
-
-    Stats.event 'pull', 'watapp'
-
+``` ruby
+Stats.event 'pull'
+```
+With a custom app:
+
+``` ruby
+Stats.event 'pull', 'watapp'
+```
 ### Boolean result - pass a value to be true or false, and increment on true
-
-    Stats.increment_on 'wat', duck.valid?
-
+``` ruby
+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
+``` ruby
+Stats.increment 'wat', 10
 
-    Stats.decrement 'wat', 10
+Stats.decrement 'wat', 10
 
-    Stats.count 'wat', 5, 10
-    
+Stats.count 'wat', 5, 10
+```
 ## Monitor
 
 You can monitor methods with the following:
+``` ruby
+class FooBar
 
-    class FooBar
-    
-      _monitor
-      def zar
-        # my code here...
-      end
-    
-    end
+  _monitor
+  def zar
+    # my code here...
+  end
 
-This will register the processing time for this method, everytime it is called, under the Graphite bucket `foo_bar.zar`. 
+end
+```
+This will register the processing time for this method, everytime it is called, under the Graphite bucket `foo_bar.zar`.
 
 This will work on both Class and Instance methods.
 
@@ -114,10 +119,12 @@ This will work on both Class and Instance methods.
 
 Fozzie supports the following namespaces as default
 
-    Stats.increment 'wat'
-    S.increment 'wat'
-    Statistics.increment 'wat'
-    Warehouse.increment 'wat'
+``` ruby
+Stats.increment 'wat'
+S.increment 'wat'
+Statistics.increment 'wat'
+Warehouse.increment 'wat'
+```
 
 You can customise this via the YAML configuration (see instructions below)
 
@@ -129,29 +136,52 @@ Fozzie is configured via a YAML or by setting a block against the Fozzie namespa
 
 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}
+``` yaml
+development:
+  appname: wat
+  host: '127.0.0.1'
+  port: 8125
+  namespaces: %w{Foo Bar Wat}
+  prefix: %{foo bar car}
+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
+``` ruby
+Fozzie.configure do |config|
+  config.appname = "wat"
+  config.host    = "127.0.0.1"
+  config.port    = 8125
+  config.prefix  = []
+end
+```
+### Prefixes
+
+You can inject or set the prefix value for your application.
+
+``` ruby
+Fozzie.configure do |config|
+  config.prefix = ['foo', 'wat', 'bar']
+end
+```
+
+``` ruby
+Fozzie.configure do |config|
+  config.prefix << 'dynamic-value'
+end
+```
+
+Prefixes are cached on first use, therefore any changes to the Fozzie configure prefix after first metric is sent in your application will be ignored.
 
 ## Middleware
 
@@ -159,13 +189,15 @@ To time and register the controller actions within your Rails application, Fozzi
 
 ### Rack
 
-    require 'rack'
-    require 'fozzie'
+``` ruby
+require 'rack'
+require 'fozzie'
 
-    app = Rack::Builder.new {
-      use Fozzie::Rack::Middleware
-      lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'OK'] }
-    }
+app = Rack::Builder.new {
+  use Fozzie::Rack::Middleware
+  lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'OK'] }
+}
+```
 
 ### Rails
 
@@ -178,11 +210,13 @@ Fozzie::Rails::Middleware will automatically be invoked on Rails initialization.
 Fozzie automatically constructs bucket name prefixes from app name,
 hostname, and environment. For example:
 
-    Stats.increment 'wat'
-
+``` ruby
+Stats.increment 'wat'
+```
 increments the bucket named
-
-    app-name.your-computer-name.development.wat
+``` text
+app-name.your-computer-name.development.wat
+```
 
 When working on your development machine. This allows multiple
 application instances, in different environments, to be distinguished
@@ -195,12 +229,16 @@ The app name can be configured via the YAML configuration.
 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'
+``` ruby
+require 'logger'
+Fozzie.logger = Logger.new(STDOUT)
+```
+
+``` ruby
+require 'logger'
+Fozzie.logger = Logger.new 'log/fozzie.log'
+```
 
 This may change, depending on feedback and more production experience.
 

data/lib/fozzie/configuration.rb

@@ -10,7 +10,7 @@ module Fozzie
   class Configuration
     include Sys
 
-    attr_accessor :env, :config_path, :host, :port, :appname, :namespaces, :timeout, :monitor_classes, :sniff_envs, :ignore_prefix
+    attr_accessor :env, :config_path, :host, :port, :appname, :namespaces, :timeout, :monitor_classes, :sniff_envs, :ignore_prefix, :prefix
 
     def initialize(args = {})
       merge_and_assign_config(args)
@@ -24,11 +24,17 @@ module Fozzie
     # Returns the prefix for any stat requested to be registered
     def data_prefix
       return nil if @ignore_prefix
+      return @data_prefix if @data_prefix
 
-      @data_prefix ||= [appname, origin_name, env].collect do |s|
-        s.empty? ? nil : s.gsub('.', '-')
-      end.compact.join('.').strip
-      (@data_prefix.empty? ? nil : @data_prefix)
+      data_prefix = @prefix.collect do |me|
+        (me.kind_of?(Symbol) && self.respond_to?(me.to_sym) ? self.send(me) : me.to_s)
+      end
+
+      data_prefix = data_prefix.collect do |s|
+        s.empty? ? nil : s.gsub(Socket::DELIMETER, '-')
+      end.compact.join(Socket::DELIMETER).strip
+
+      @data_prefix ||= (data_prefix.empty? ? nil : data_prefix)
     end
 
     # Returns the origin name of the current machine to register the stat against
@@ -55,6 +61,7 @@ module Fozzie
     def self.default_configuration
       {
         :host            => '127.0.0.1',
+        :prefix          => [:appname, :origin_name, :env],
         :port            => 8125,
         :config_path     => '',
         :env             => (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'),

data/lib/fozzie/socket.rb

@@ -4,6 +4,7 @@ module Fozzie
   module Socket
 
     RESERVED_CHARS_REGEX = /[\:\|\@\s]/
+    DELIMETER = '.'
 
     private
 
@@ -12,10 +13,10 @@ module Fozzie
     # Creates the Statsd key from the given values, and sends to socket (depending on sample rate)
     #
     def send(stat, delta, type, sample_rate)
-      stat = [stat].flatten.compact.collect(&:to_s).join('.').downcase
-      stat = stat.gsub('::', '.').gsub(RESERVED_CHARS_REGEX, '_')
+      stat = [stat].flatten.compact.collect(&:to_s).join(DELIMETER).downcase
+      stat = stat.gsub('::', DELIMETER).gsub(RESERVED_CHARS_REGEX, '_')
 
-      k =  [Fozzie.c.data_prefix, stat].compact.join('.')
+      k =  [Fozzie.c.data_prefix, stat].compact.join(DELIMETER)
       k << ":"
       k << [delta, type].join('|')
       k << '@%s' % sample_rate.to_s if sample_rate < 1

data/lib/fozzie/version.rb

@@ -1,3 +1,3 @@
 module Fozzie
-  VERSION = "0.0.26"
+  VERSION = "0.0.27"
 end

data/spec/lib/fozzie/configuration_spec.rb

@@ -24,20 +24,35 @@ describe Fozzie::Configuration do
     subject.env.should eq 'test'
   end
 
-  it "creates a data prefix" do
-    subject.stubs(:origin_name).returns("")
-    subject.data_prefix.should eq 'test'
-  end
+  describe "#prefix and #data_prefix" do
 
-  it "creates a data prefix with appname when set" do
-    subject.stubs(:origin_name).returns("")
-    subject.appname = 'astoria'
-    subject.data_prefix.should eq 'astoria.test'
-  end
+    it "creates a #data_prefix" do
+      subject.stubs(:origin_name).returns("")
+      subject.data_prefix.should eq 'test'
+    end
+
+    it "creates a #data_prefix with appname when set" do
+      subject.stubs(:origin_name).returns("")
+      subject.appname = 'astoria'
+      subject.data_prefix.should eq 'astoria.test'
+    end
+
+    it "creates a #data_prefix with origin" do
+      subject.appname = 'astoria'
+      subject.data_prefix.should match /^astoria\.(\S+)\.test$/
+    end
+
+    it "allows dynamic assignment of #prefix to derive #data_prefix" do
+      subject.prefix = [:foo, :bar, :car]
+      subject.data_prefix.should eq 'foo.bar.car'
+    end
+
+    it "allows dynamic injection of value to prefix" do
+      subject.stubs(:origin_name).returns("")
+      subject.prefix << 'git-sha-1234'
+      subject.data_prefix.should eq 'test.git-sha-1234'
+    end
 
-  it "creates a prefix with origin" do
-    subject.appname = 'astoria'
-    subject.data_prefix.should match /^astoria\.(\S+)\.test$/
   end
 
   it "handles missing configuration namespace" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fozzie
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.27
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-29 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-uname
@@ -262,7 +262,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2413055484564325442
+      hash: 1975054614990968952
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -271,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2413055484564325442
+      hash: 1975054614990968952
 requirements: []
 rubyforge_project: fozzie
 rubygems_version: 1.8.24