flipper 0.6.0 → 0.6.1

data/Changelog.md

@@ -1,3 +1,7 @@
+## 0.6.1
+
+* Added statsd support for instrumentation.
+
 ## 0.4.0
 
 * No longer use #id for detecting actors. You must now define #flipper_id on

data/Gemfile

@@ -3,6 +3,7 @@ gemspec
 
 gem 'rake'
 gem 'metriks', :require => false
+gem 'statsd-ruby', :require => false
 gem 'rspec'
 gem 'rack-test'
 gem 'activesupport', :require => false

data/README.md

@@ -1,4 +1,21 @@
-![flipper logo](https://raw.github.com/jnunemaker/flipper-ui/master/lib/flipper/ui/public/flipper/images/logo.png)
+![flipper logo](https://raw.github.com/jnunemaker/flipper-ui/master/lib/flipper/ui/public/images/logo.png)
+
+<pre>
+__
+                               _.-~  )
+                    _..--~~~~,'   ,-/     _
+                 .-'. . . .'   ,-','    ,' )
+               ,'. . . _   ,--~,-'__..-'  ,'
+             ,'. . .  (@)' ---~~~~      ,'
+            /. . . . '~~             ,-'
+           /. . . . .             ,-'
+          ; . . . .  - .        ,'
+         : . . . .       _     /
+        . . . . .          `-.:
+       . . . ./  - .          )
+      .  . . |  _____..---.._/ _____
+~---~~~~----~~~~             ~~
+</pre>
 
 Feature flipping is the act of enabling or disabling features or parts of your application, ideally without re-deploying or changing anything in your code base.
 
@@ -18,10 +35,6 @@ Or install it yourself with:
 
     $ gem install flipper
 
-## Coming Soon™
-
-* [Web UI](https://github.com/jnunemaker/flipper-ui) (think resque UI for features toggling/status)
-
 ## Usage
 
 The goal of the API for flipper was to have everything revolve around features and what ways they can be enabled. Start with top level and dig into a feature, then dig in further and enable that feature for a given type of access, as opposed to thinking about how the feature will be accessed first (ie: stats.enable vs activate_group(:stats, ...)).
@@ -245,3 +258,7 @@ config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Coming Soon™
+
+* [Web UI](https://github.com/jnunemaker/flipper-ui) (think resque UI for features toggling/status)

data/lib/flipper/instrumentation/metriks_subscriber.rb

@@ -2,90 +2,18 @@
 # ActiveSupport::Notifications. Instead, you should require the metriks file
 # that lives in the same directory as this file. The benefit is that it
 # subscribes to the correct events and does everything for your.
+require 'flipper/instrumentation/subscriber'
 require 'metriks'
 
 module Flipper
   module Instrumentation
-    class MetriksSubscriber
-      # Public: Use this as the subscribed block.
-      def self.call(name, start, ending, transaction_id, payload)
-        new(name, start, ending, transaction_id, payload).update
+    class MetriksSubscriber < Subscriber
+      def update_timer(metric)
+        Metriks.timer(metric).update(@duration)
       end
 
-      # Private: Initializes a new event processing instance.
-      def initialize(name, start, ending, transaction_id, payload)
-        @name = name
-        @start = start
-        @ending = ending
-        @payload = payload
-        @duration = ending - start
-        @transaction_id = transaction_id
-      end
-
-      def update
-        operation_type = @name.split('.').first
-        method_name = "update_#{operation_type}_metrics"
-
-        if respond_to?(method_name)
-          send(method_name)
-        else
-          puts "Could not update #{operation_type} metrics as MetriksSubscriber did not respond to `#{method_name}`"
-        end
-      end
-
-      def update_feature_operation_metrics
-        feature_name = @payload[:feature_name]
-        gate_name = @payload[:gate_name]
-        operation = strip_trailing_question_mark(@payload[:operation])
-        result = @payload[:result]
-        thing = @payload[:thing]
-
-        Metriks.timer("flipper.feature_operation.#{operation}").update(@duration)
-
-        if @payload[:operation] == :enabled?
-          metric_name = if result
-            "flipper.feature.#{feature_name}.enabled"
-          else
-            "flipper.feature.#{feature_name}.disabled"
-          end
-
-          Metriks.meter(metric_name).mark
-        end
-      end
-
-      def update_adapter_operation_metrics
-        adapter_name = @payload[:adapter_name]
-        operation = @payload[:operation]
-        result = @payload[:result]
-        value = @payload[:value]
-        key = @payload[:key]
-
-        Metriks.timer("flipper.adapter.#{adapter_name}.#{operation}").update(@duration)
-      end
-
-      def update_gate_operation_metrics
-        feature_name = @payload[:feature_name]
-        gate_name = @payload[:gate_name]
-        operation = strip_trailing_question_mark(@payload[:operation])
-        result = @payload[:result]
-        thing = @payload[:thing]
-
-        Metriks.timer("flipper.gate_operation.#{gate_name}.#{operation}").update(@duration)
-        Metriks.timer("flipper.feature.#{feature_name}.gate_operation.#{gate_name}.#{operation}").update(@duration)
-
-        if @payload[:operation] == :open?
-          metric_name = if result
-            "flipper.feature.#{feature_name}.gate.#{gate_name}.open"
-          else
-            "flipper.feature.#{feature_name}.gate.#{gate_name}.closed"
-          end
-
-          Metriks.meter(metric_name).mark
-        end
-      end
-
-      def strip_trailing_question_mark(operation)
-        operation.to_s.gsub(/\?$/, '')
+      def update_counter(metric)
+        Metriks.meter(metric).mark
       end
     end
   end

data/lib/flipper/instrumentation/statsd.rb

@@ -0,0 +1,6 @@
+require 'securerandom'
+require 'active_support/notifications'
+require 'flipper/instrumentation/statsd_subscriber'
+
+ActiveSupport::Notifications.subscribe /\.flipper$/,
+  Flipper::Instrumentation::StatsdSubscriber

data/lib/flipper/instrumentation/statsd_subscriber.rb

@@ -0,0 +1,28 @@
+# Note: You should never need to require this file directly if you are using
+# ActiveSupport::Notifications. Instead, you should require the metriks file
+# that lives in the same directory as this file. The benefit is that it
+# subscribes to the correct events and does everything for your.
+require 'flipper/instrumentation/subscriber'
+require 'statsd'
+
+module Flipper
+  module Instrumentation
+    class StatsdSubscriber < Subscriber
+      class << self
+        attr_accessor :client
+      end
+
+      def update_timer(metric)
+        if self.class.client
+          self.class.client.timing metric, (@duration * 1_000).round
+        end
+      end
+
+      def update_counter(metric)
+        if self.class.client
+          self.class.client.increment metric
+        end
+      end
+    end
+  end
+end

data/lib/flipper/instrumentation/subscriber.rb

@@ -0,0 +1,102 @@
+module Flipper
+  module Instrumentation
+    class Subscriber
+      # Public: Use this as the subscribed block.
+      def self.call(name, start, ending, transaction_id, payload)
+        new(name, start, ending, transaction_id, payload).update
+      end
+
+      # Private: Initializes a new event processing instance.
+      def initialize(name, start, ending, transaction_id, payload)
+        @name = name
+        @start = start
+        @ending = ending
+        @payload = payload
+        @duration = ending - start
+        @transaction_id = transaction_id
+      end
+
+      # Internal: Override in subclass.
+      def update_timer(metric)
+        raise 'not implemented'
+      end
+
+      # Internal: Override in subclass.
+      def update_counter(metric)
+        raise 'not implemented'
+      end
+
+      # Private
+      def update
+        operation_type = @name.split('.').first
+        method_name = "update_#{operation_type}_metrics"
+
+        if respond_to?(method_name)
+          send(method_name)
+        else
+          puts "Could not update #{operation_type} metrics as #{self.class} did not respond to `#{method_name}`"
+        end
+      end
+
+      # Private
+      def update_feature_operation_metrics
+        feature_name = @payload[:feature_name]
+        gate_name = @payload[:gate_name]
+        operation = strip_trailing_question_mark(@payload[:operation])
+        result = @payload[:result]
+        thing = @payload[:thing]
+
+        update_timer "flipper.feature_operation.#{operation}"
+
+        if @payload[:operation] == :enabled?
+          metric_name = if result
+            "flipper.feature.#{feature_name}.enabled"
+          else
+            "flipper.feature.#{feature_name}.disabled"
+          end
+
+          update_counter metric_name
+        end
+      end
+
+      # Private
+      def update_adapter_operation_metrics
+        adapter_name = @payload[:adapter_name]
+        operation = @payload[:operation]
+        result = @payload[:result]
+        value = @payload[:value]
+        key = @payload[:key]
+
+
+        update_timer "flipper.adapter.#{adapter_name}.#{operation}"
+      end
+
+      # Private
+      def update_gate_operation_metrics
+        feature_name = @payload[:feature_name]
+        gate_name = @payload[:gate_name]
+        operation = strip_trailing_question_mark(@payload[:operation])
+        result = @payload[:result]
+        thing = @payload[:thing]
+
+        update_timer "flipper.gate_operation.#{gate_name}.#{operation}"
+        update_timer "flipper.feature.#{feature_name}.gate_operation.#{gate_name}.#{operation}"
+
+        if @payload[:operation] == :open?
+          metric_name = if result
+            "flipper.feature.#{feature_name}.gate.#{gate_name}.open"
+          else
+            "flipper.feature.#{feature_name}.gate.#{gate_name}.closed"
+          end
+
+          update_counter metric_name
+        end
+      end
+
+      # Private
+      def strip_trailing_question_mark(operation)
+        operation.to_s.gsub(/\?$/, '')
+      end
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/spec/flipper/instrumentation/metriks_subscriber_spec.rb

@@ -56,11 +56,4 @@ describe Flipper::Instrumentation::MetriksSubscriber do
     Metriks.meter("flipper.feature.stats.gate.actor.open").count.should be(1)
     Metriks.meter("flipper.feature.stats.gate.boolean.closed").count.should be(1)
   end
-
-  # Helper for seeing what is in the metriks registry
-  def print_registry_names
-    Metriks::Registry.default.each do |name, metric|
-      puts name
-    end
-  end
 end

data/spec/flipper/instrumentation/statsd_subscriber_spec.rb

@@ -0,0 +1,76 @@
+require 'helper'
+require 'flipper/adapters/memory'
+require 'flipper/instrumentation/statsd'
+
+describe Flipper::Instrumentation::StatsdSubscriber do
+  let(:statsd_client) { Statsd.new }
+  let(:socket) { FakeUDPSocket.new }
+  let(:adapter) { Flipper::Adapters::Memory.new }
+  let(:flipper) {
+    Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications)
+  }
+
+  let(:user) { user = Struct.new(:flipper_id).new('1') }
+
+  before do
+    described_class.client = statsd_client
+    Thread.current[:statsd_socket] = socket
+  end
+
+  after do
+    described_class.client = nil
+    Thread.current[:statsd_socket] = nil
+  end
+
+  def assert_timer(metric)
+    regex = /#{Regexp.escape metric}\:\d+\|ms/
+    socket.buffer.detect { |op| op.first =~ regex }.should_not be_nil
+  end
+
+  def assert_counter(metric)
+    socket.buffer.detect { |op| op.first == "#{metric}:1|c" }.should_not be_nil
+  end
+
+  context "for enabled feature" do
+    it "updates feature metrics when calls happen" do
+      flipper[:stats].enable(user)
+      assert_timer 'flipper.feature_operation.enable'
+
+      flipper[:stats].enabled?(user)
+      assert_timer 'flipper.feature_operation.enabled'
+      assert_counter 'flipper.feature.stats.enabled'
+    end
+  end
+
+  context "for disabled feature" do
+    it "updates feature metrics when calls happen" do
+      flipper[:stats].disable(user)
+      assert_timer 'flipper.feature_operation.disable'
+
+      flipper[:stats].enabled?(user)
+      assert_timer 'flipper.feature_operation.enabled'
+      assert_counter 'flipper.feature.stats.disabled'
+    end
+  end
+
+  it "updates adapter metrics when calls happen" do
+    flipper[:stats].enable(user)
+    assert_timer 'flipper.adapter.memory.enable'
+
+    flipper[:stats].enabled?(user)
+    assert_timer 'flipper.adapter.memory.get'
+
+    flipper[:stats].disable(user)
+    assert_timer 'flipper.adapter.memory.disable'
+  end
+
+  it "updates gate metrics when calls happen" do
+    flipper[:stats].enable(user)
+    flipper[:stats].enabled?(user)
+
+    assert_timer 'flipper.gate_operation.boolean.open'
+    assert_timer 'flipper.feature.stats.gate_operation.boolean.open'
+    assert_counter 'flipper.feature.stats.gate.actor.open'
+    assert_counter 'flipper.feature.stats.gate.boolean.closed'
+  end
+end

data/spec/helper.rb

@@ -15,6 +15,8 @@ Bundler.setup(:default)
 
 require 'flipper'
 
+Dir[root_path.join("spec/support/**/*.rb")].each { |f| require f }
+
 RSpec.configure do |config|
   config.fail_fast = true
 

data/spec/support/fake_udp_socket.rb

@@ -0,0 +1,27 @@
+class FakeUDPSocket
+  attr_reader :buffer
+
+  def initialize
+    @buffer = []
+  end
+
+  def send(message, *rest)
+    @buffer.push [message]
+  end
+
+  def recv
+    @buffer.shift
+  end
+
+  def clear
+    @buffer = []
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    "<FakeUDPSocket: #{@buffer.inspect}>"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies: []
 description: Feature flipper for any adapter
 email:
@@ -56,6 +56,9 @@ files:
 - lib/flipper/instrumentation/log_subscriber.rb
 - lib/flipper/instrumentation/metriks.rb
 - lib/flipper/instrumentation/metriks_subscriber.rb
+- lib/flipper/instrumentation/statsd.rb
+- lib/flipper/instrumentation/statsd_subscriber.rb
+- lib/flipper/instrumentation/subscriber.rb
 - lib/flipper/instrumenters/memory.rb
 - lib/flipper/instrumenters/noop.rb
 - lib/flipper/middleware/memoizer.rb
@@ -83,6 +86,7 @@ files:
 - spec/flipper/gates/percentage_of_random_spec.rb
 - spec/flipper/instrumentation/log_subscriber_spec.rb
 - spec/flipper/instrumentation/metriks_subscriber_spec.rb
+- spec/flipper/instrumentation/statsd_subscriber_spec.rb
 - spec/flipper/instrumenters/memory_spec.rb
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
@@ -96,6 +100,7 @@ files:
 - spec/flipper_spec.rb
 - spec/helper.rb
 - spec/integration_spec.rb
+- spec/support/fake_udp_socket.rb
 homepage: http://jnunemaker.github.com/flipper
 licenses: []
 post_install_message: 
@@ -110,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 592688489057647185
+      hash: -2625440176401499604
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 592688489057647185
+      hash: -2625440176401499604
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -141,6 +146,7 @@ test_files:
 - spec/flipper/gates/percentage_of_random_spec.rb
 - spec/flipper/instrumentation/log_subscriber_spec.rb
 - spec/flipper/instrumentation/metriks_subscriber_spec.rb
+- spec/flipper/instrumentation/statsd_subscriber_spec.rb
 - spec/flipper/instrumenters/memory_spec.rb
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
@@ -154,3 +160,4 @@ test_files:
 - spec/flipper_spec.rb
 - spec/helper.rb
 - spec/integration_spec.rb
+- spec/support/fake_udp_socket.rb