protobuffy 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 999b239c093eb4031dacb08442959c7c30aa24ee
-  data.tar.gz: 3e8287f3fccbb2d9bef79df4dc92bdebe2f94ad6
+  metadata.gz: cc8e8aa7b3ed82b4a15558414ef537ada9e5f84a
+  data.tar.gz: d13a9ec3b735bea4184385b36ff0b7e53f9b8f6d
 SHA512: 
-  metadata.gz: 3b305e8fd6659fe6ef2a7e8d18ec6962badc47217ddde2fbcd84bf6f18ab0ee0fafee6bb655773f6d59b53909d4e4269123a3505a178f1bcd600e78571699d97
-  data.tar.gz: 7c898d816504ac183035b16d41d16ad71910597efa5be4a634a4e69284c26a8881c1153110c15327f093dff527dfda42770b5e40fb9356fc9381afaf80782636
+  metadata.gz: 63d3029e746e4b9cf5c294f8eb172519170266b0a2c161fc24a92d1fd76e47fcd668f5040b70e24cba5e7abd99848a2c04b334afb19fc5bfa72f2c3ac4653cb2
+  data.tar.gz: e94dcd1103b54ad56b5a56d1272f3a408e3c305f0083387a98018ce9858efd5b380df6b59acfda296f535a6ac48d847a721da5ffb0540beb085e16387501762f

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Stable (3.x)
 
+3.2.0
+--------
+
+- Change Protobuf::Rpc::Stats.statsd_client to Protobuf::Statsd.client
+    and track both RPC calls and service handling. [@dgolombek]
+
 3.1.0
 --------
 

data/lib/protobuf/rpc/middleware/statsd.rb

@@ -0,0 +1,55 @@
+require 'protobuf/statsd'
+
+module Protobuf
+  module Rpc
+    module Middleware
+      class Statsd
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          start_time = Time.now.utc
+          begin
+            env = @app.call(env)
+          ensure
+            record_stats(env, start_time)
+          end
+
+          env
+        end
+
+        # Return base path for StatsD metrics
+        def statsd_base_path(env)
+          if env.service_name && env.method_name
+            "rpc-server.#{env.service_name}.#{env.method_name}".gsub('::', '.').downcase
+          else
+            nil
+          end
+        end
+
+        # Send success/failure and timing information to Statsd, if
+        # one was configured in Protobuf::Statsd.
+        def record_stats(env, start_time)
+          statsd_client = Protobuf::Statsd.client
+          path = statsd_base_path(env)
+          return unless statsd_client && path && env.response
+          end_time = Time.now.utc
+
+          if env.response.is_a?(Protobuf::Rpc::PbError)
+            statsd_client.increment("#{path}.failure.total")
+            statsd_client.increment("#{path}.failure.#{env.response.error_type}")
+          else
+            statsd_client.increment("#{path}.success")
+          end
+
+          statsd_client.timing("#{path}.time", end_time - start_time)
+        rescue => e
+          # We insert ourself after Exception handler, so no exceptions allowed!
+          Protobuf::Logger.warn { "Error with Statsd middleware: #{e.message}" }
+        end
+        private :record_stats
+      end
+    end
+  end
+end

data/lib/protobuf/rpc/middleware.rb

@@ -4,6 +4,7 @@ require 'protobuf/rpc/middleware/exception_handler'
 require 'protobuf/rpc/middleware/logger'
 require 'protobuf/rpc/middleware/request_decoder'
 require 'protobuf/rpc/middleware/response_encoder'
+require 'protobuf/rpc/middleware/statsd'
 require 'protobuf/rpc/middleware/runner'
 
 module Protobuf
@@ -16,6 +17,8 @@ module Protobuf
     middleware
   end
 
+  # Statsd comes first so it gets full timing and access to exceptions
+  Rpc.middleware.use(Rpc::Middleware::Statsd)
   Rpc.middleware.use(Rpc::Middleware::ExceptionHandler)
   Rpc.middleware.use(Rpc::Middleware::RequestDecoder)
   Rpc.middleware.use(Rpc::Middleware::Logger)

data/lib/protobuf/rpc/stat.rb

@@ -1,6 +1,7 @@
 require 'date'
 require 'time'
 require 'protobuf/logger'
+require 'protobuf/statsd'
 
 module Protobuf
   module Rpc
@@ -10,18 +11,6 @@ module Protobuf
 
       MODES = [:SERVER, :CLIENT].freeze
 
-      # Set the StatsD Client to send stats to. The client must match
-      # the interface provided by lookout-statsd
-      # (https://github.com/lookout/statsd).
-      def self.statsd_client=(statsd_client)
-        @statsd_client = statsd_client
-      end
-
-      # The StatsD Client configured, if any.
-      def self.statsd_client
-        @statsd_client
-      end
-
       def initialize(mode = :SERVER)
         @mode = mode
         @request_size = 0
@@ -119,14 +108,14 @@ module Protobuf
 
       # Return base path for StatsD metrics
       def statsd_base_path
-        "rpc.#{service}.#{method_name}".gsub('::', '.').downcase
+        "rpc-client.#{service}.#{method_name}".gsub('::', '.').downcase
       end
 
       # If a StatsD Client has been configured, send stats to it upon
       # completion.
       def call_statsd_client
         path = statsd_base_path
-        statsd_client = self.class.statsd_client
+        statsd_client = Protobuf::Statsd.client
         return unless statsd_client
 
         if @success

data/lib/protobuf/statsd.rb

@@ -0,0 +1,10 @@
+module Protobuf
+  class Statsd
+    class << self
+      # The StatsD Client to send stats to. The client must match the
+      # interface provided by lookout-statsd
+      # (https://github.com/lookout/statsd).
+      attr_accessor :client
+    end
+  end
+end

data/lib/protobuf/version.rb

@@ -1,3 +1,3 @@
 module Protobuf
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/spec/lib/protobuf/rpc/middleware/statsd_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'timecop'
+
+describe Protobuf::Rpc::Middleware::Statsd do
+  let(:app) { Proc.new { |inner_env| Timecop.freeze(Time.now + call_time); inner_env } }
+  let(:env) {
+    Protobuf::Rpc::Env.new(
+      'client_host' => 'client_host.test.co',
+      'encoded_request' => request_wrapper.encode,
+      'encoded_response' => response_wrapper.encode,
+      'method_name' => method_name,
+      'request' => request,
+      'request_type' => rpc_method.request_type,
+      'response' => response,
+      'response_type' => rpc_method.response_type,
+      'rpc_method' => rpc_method,
+      'rpc_service' => service_class,
+      'service_name' => service_name,
+    )
+  }
+  let(:method_name) { :find }
+  let(:request) { request_type.new(:name => 'required') }
+  let(:request_type) { rpc_method.request_type }
+  let(:request_wrapper) {
+    Protobuf::Socketrpc::Request.new(
+      :service_name => service_name,
+      :method_name => method_name.to_s,
+      :request_proto => request
+    )
+  }
+  let(:response) { rpc_method.response_type.new(:name => 'required') }
+  let(:response_wrapper) { Protobuf::Socketrpc::Response.new(:response_proto => response) }
+  let(:rpc_method) { service_class.rpcs[method_name] }
+  let(:rpc_service) { service_class.new(env) }
+  let(:service_class) { Test::ResourceService }
+  let(:service_name) { service_class.to_s }
+  let(:stats_path) { 'rpc-server.test.resourceservice.find' }
+  let(:call_time) { 100 }
+
+  subject { described_class.new(app) }
+
+  describe "#call" do
+    context "without Protobuf::Statsd.client set" do
+      before :each do
+        Protobuf::Statsd.client = nil
+      end
+
+      it "calls the stack" do
+        app.should_receive(:call).with(env)
+        subject.call(env)
+      end
+
+      it "returns the env" do
+        subject.call(env).should eq env
+      end
+    end
+
+    context "with Protobuf::Statsd.client set" do
+      let(:statsd_client) { double("Statsd::Client") }
+
+      before :each do
+        Protobuf::Statsd.client = statsd_client
+        Protobuf::Rpc::Middleware::Statsd.any_instance.stub(:statsd_base_path).and_return(stats_path)
+        Timecop.freeze(Time.now)
+      end
+
+      after :each do
+        Protobuf::Statsd.client = nil
+        Timecop.return
+      end
+
+      context "with success response" do
+        it "should increment the proper stats" do
+          expect(statsd_client).to receive(:increment).with("#{stats_path}.success")
+          expect(statsd_client).to receive(:timing).with("#{stats_path}.time", call_time)
+
+          subject.call(env)
+        end
+      end
+
+      context "with failure response" do
+        let(:type) { Protobuf::Socketrpc::ErrorReason::BAD_REQUEST_DATA }
+        let(:response) { Protobuf::Rpc::PbError.new('ooops', type) }
+        let(:response_wrapper) { response.to_response }
+
+        it "should increment the proper stats" do
+          expect(statsd_client).to receive(:increment).with("#{stats_path}.failure.total")
+          expect(statsd_client).to receive(:increment).with("#{stats_path}.failure.#{type}")
+          expect(statsd_client).to receive(:timing).with("#{stats_path}.time", call_time)
+
+          subject.call(env)
+        end
+      end
+    end
+  end
+
+  describe "#statsd_base_path" do
+    it "should return a good path" do
+      expect(subject.statsd_base_path(env)).to eql "rpc-server.test.resourceservice.find"
+    end
+  end
+end

data/spec/lib/protobuf/rpc/stat_spec.rb

@@ -77,7 +77,7 @@ describe ::Protobuf::Rpc::Stat do
     end
 
     it "should use correct base path" do
-      expect(statsd_base_path).to eq "rpc.foo.barservice.find_bars"
+      expect(statsd_base_path).to eq "rpc-client.foo.barservice.find_bars"
     end
   end
 
@@ -87,7 +87,7 @@ describe ::Protobuf::Rpc::Stat do
     let(:end_time) { Time.now }
     let(:service) { 'Foo::BarService' }
     let(:method_name) { 'find_bars' }
-    let(:stats_path) { 'rpc.foo.barservice.find_bars' }
+    let(:stats_path) { 'rpc-client.foo.barservice.find_bars' }
 
     before :each do
       stats.service = service
@@ -109,11 +109,11 @@ describe ::Protobuf::Rpc::Stat do
       let(:statsd_client) { double("Statsd::Client") }
 
       before :each do
-        Protobuf::Rpc::Stat.statsd_client = statsd_client
+        Protobuf::Statsd.client = statsd_client
       end
 
       after :each do
-        Protobuf::Rpc::Stat.statsd_client = nil
+        Protobuf::Statsd.client = nil
       end
 
       context "on success" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: protobuffy
 version: !ruby/object:Gem::Version 
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors: 
 - BJ Neilsen
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-10-13 00:00:00 Z
+date: 2014-10-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -237,6 +237,7 @@ files:
 - lib/protobuf/rpc/middleware/request_decoder.rb
 - lib/protobuf/rpc/middleware/response_encoder.rb
 - lib/protobuf/rpc/middleware/runner.rb
+- lib/protobuf/rpc/middleware/statsd.rb
 - lib/protobuf/rpc/rpc.pb.rb
 - lib/protobuf/rpc/server.rb
 - lib/protobuf/rpc/servers/http/server.rb
@@ -255,6 +256,7 @@ files:
 - lib/protobuf/rpc/service_filters.rb
 - lib/protobuf/rpc/stat.rb
 - lib/protobuf/socket.rb
+- lib/protobuf/statsd.rb
 - lib/protobuf/tasks.rb
 - lib/protobuf/tasks/compile.rake
 - lib/protobuf/version.rb
@@ -302,6 +304,7 @@ files:
 - spec/lib/protobuf/rpc/middleware/logger_spec.rb
 - spec/lib/protobuf/rpc/middleware/request_decoder_spec.rb
 - spec/lib/protobuf/rpc/middleware/response_encoder_spec.rb
+- spec/lib/protobuf/rpc/middleware/statsd_spec.rb
 - spec/lib/protobuf/rpc/servers/http/server_spec.rb
 - spec/lib/protobuf/rpc/servers/socket_server_spec.rb
 - spec/lib/protobuf/rpc/servers/zmq/server_spec.rb