thrift_server 0.1.1 → 1.0.0

data/lib/thrift_server/instrumentation_middleware.rb

@@ -0,0 +1,33 @@
+module ThriftServer
+  class InstrumentationMiddleware
+    extend Forwardable
+
+    def_delegators :publisher, :publish
+
+    include Concord.new(:app, :publisher)
+
+    def call(rpc)
+      start_time = Time.now
+
+      publish :rpc_incoming, rpc
+
+      app.call(rpc).tap do |response|
+        latency = (Time.now - start_time) * 1000
+
+        publish :rpc_ok, rpc, response, {
+          latency: latency
+        }
+      end
+    rescue => ex
+      latency = (Time.now - start_time) * 1000
+
+      if rpc.protocol_exception? ex
+        publish :rpc_exception, rpc, ex, latency: latency
+      else
+        publish :rpc_error, rpc, ex, latency: latency
+      end
+
+      raise ex
+    end
+  end
+end

data/lib/thrift_server/log_subscriber.rb

@@ -0,0 +1,60 @@
+module ThriftServer
+  class LogSubscriber
+    include Concord.new(:logger)
+
+    def thread_pool_server_pool_change(meta)
+      logger.debug :server do
+        "Thread pool change: %+d" % [ meta.fetch(:delta) ]
+      end
+    end
+
+    def server_connection_opened(addr)
+      logger.debug :server do
+        "%s:%d connected" % [
+          addr.ip_address,
+          addr.ip_port
+        ]
+      end
+    end
+
+    def server_connection_closed(addr)
+      logger.debug :server do
+        "%s:%d disconnected" % [
+          addr.ip_address,
+          addr.ip_port
+        ]
+      end
+    end
+
+    def rpc_ok(rpc, response, meta)
+      logger.info :processor do
+        "%s => OK (%.2fms)" % [
+          rpc.name,
+          meta.fetch(:latency)
+        ]
+      end
+    end
+
+    def rpc_error(rpc, ex, meta)
+      logger.info :processor do
+        "%s => Error! %s (%.2fms)" % [
+          rpc.name,
+          ex.class.name,
+          meta.fetch(:latency)
+        ]
+      end
+
+      logger.error ex
+    end
+
+    def rpc_exception(rpc, ex, meta)
+      logger.info :processor do
+        "%s => %s (%.2fms)" % [
+          rpc.name,
+          rpc.exception_name(ex),
+          meta.fetch(:latency)
+        ]
+      end
+    end
+  end
+end

data/lib/thrift_server/publisher.rb

@@ -0,0 +1,25 @@
+module ThriftServer
+  class Publisher
+    include Enumerable
+
+    extend Forwardable
+
+    def_delegators :listeners, :each
+
+    attr_reader :listeners
+
+    def initialize
+      @listeners = [ ]
+    end
+
+    def subscribe(object)
+      listeners << object
+    end
+
+    def publish(event, *args)
+      listeners.each do |listener|
+        listener.send(event, *args) if listener.respond_to? event
+      end
+    end
+  end
+end

data/lib/thrift_server/rpc_metrics_subscriber.rb

@@ -0,0 +1,25 @@
+module ThriftServer
+  class RpcMetricsSubscriber
+    include Concord.new(:statsd)
+
+    def rpc_incoming(rpc)
+      statsd.increment "rpc.#{rpc}.incoming"
+    end
+
+    def rpc_ok(rpc, response, meta)
+      statsd.increment "rpc.#{rpc}.success"
+      statsd.timing "rpc.#{rpc}.latency", meta.fetch(:latency)
+    end
+
+    def rpc_exception(rpc, ex, meta)
+      statsd.increment "rpc.#{rpc}.exception"
+      statsd.increment "rpc.#{rpc}.exception.#{rpc.exception_name(ex)}"
+      statsd.timing "rpc.#{rpc}.latency", meta.fetch(:latency)
+    end
+
+    def rpc_error(rpc, ex, meta)
+      statsd.increment "rpc.#{rpc}.error"
+      statsd.timing "rpc.#{rpc}.latency", meta.fetch(:latency)
+    end
+  end
+end

data/lib/thrift_server/server_metrics_subscriber.rb

@@ -0,0 +1,32 @@
+module ThriftServer
+  class ServerMetricsSubscriber
+    include Concord.new(:statsd)
+
+    def server_connection_opened(*)
+      statsd.gauge 'server.connection.active', '+1'
+    end
+
+    def server_connection_closed(*)
+      statsd.gauge 'server.connection.active', '-1'
+    end
+
+    def rpc_incoming(rpc)
+      statsd.increment 'rpc.incoming'
+    end
+
+    def rpc_ok(rpc, response, meta)
+      statsd.increment 'rpc.success'
+      statsd.timing 'rpc.latency', meta.fetch(:latency)
+    end
+
+    def rpc_exception(rpc, ex, meta)
+      statsd.increment 'rpc.exception'
+      statsd.timing 'rpc.latency', meta.fetch(:latency)
+    end
+
+    def rpc_error(rpc, ex, meta)
+      statsd.increment 'rpc.error'
+      statsd.timing 'rpc.latency', meta.fetch(:latency)
+    end
+  end
+end

data/lib/thrift_server/thread_pool_server.rb

@@ -0,0 +1,115 @@
+module ThriftServer
+  class ThreadPoolServer < Thrift::ThreadPoolServer
+    class LogSubscriber
+      include Concord.new(:logger)
+
+      def server_start(server)
+        logger.info :server do
+          "Started on port %d" % [ server.port ]
+        end
+
+        logger.info :server do
+          "-> Threads: %d" % [ server.threads ]
+        end
+
+        logger.info :server do
+          "-> Transport: %s" % [ server.transport ]
+        end
+
+        logger.info :server do
+          "-> Protocol: %s" % [ server.protocol ]
+        end
+      end
+    end
+
+    class MetricsSubscriber
+      include Concord.new(:statsd)
+
+      def thread_pool_server_pool_change(meta)
+        statsd.gauge('server.pool.size', '%+d' % [ meta.fetch(:delta) ])
+      end
+    end
+
+    extend Forwardable
+
+    def_delegators :@processor, :use
+    def_delegators :@processor, :publisher, :publish, :subscribe
+
+    attr_accessor :port
+
+    def log(logger)
+      subscribe LogSubscriber.new(logger)
+      subscribe ThriftServer::LogSubscriber.new(logger)
+    end
+
+    def metrics(statsd)
+      subscribe MetricsSubscriber.new(statsd)
+      subscribe ServerMetricsSubscriber.new(statsd)
+      subscribe RpcMetricsSubscriber.new(statsd)
+    end
+
+    def threads
+      @thread_q.max
+    end
+
+    def protocol
+      @protocol_factory
+    end
+
+    def transport
+      @transport_factory
+    end
+
+    def server_transport
+      @server_transport
+    end
+
+    def start(dry_run: false)
+      publish :server_start, self
+
+      serve unless dry_run
+    end
+
+    # NOTE: this a direct copy of the upstream code with instrumentation added.
+    def serve
+      @server_transport.listen
+
+      begin
+        loop do
+          @thread_q.push(:token)
+          publish :thread_pool_server_pool_change, delta: 1
+
+          Thread.new do
+            begin
+              loop do
+                client = @server_transport.accept
+                remote_address = client.handle.remote_address
+
+                publish :server_connection_opened, remote_address
+
+                trans = @transport_factory.get_transport(client)
+                prot = @protocol_factory.get_protocol(trans)
+                begin
+                  loop do
+                    @processor.process(prot, prot)
+                  end
+                rescue Thrift::TransportException, Thrift::ProtocolException => e
+                  publish :server_connection_closed, remote_address
+                ensure
+                  trans.close
+                end
+              end
+            rescue => e
+              @exception_q.push(e)
+            ensure
+              publish :thread_pool_server_pool_change, delta: -1
+              @thread_q.pop # thread died!
+            end
+          end
+        end
+      ensure
+        @server_transport.close
+      end
+    end
+  end
+end

data/lib/thrift_server/threaded_server.rb

@@ -0,0 +1,87 @@
+module ThriftServer
+  class ThreadedServer < Thrift::ThreadedServer
+    class LogSubscriber
+      include Concord.new(:logger)
+
+      def server_start(server)
+        logger.info :server do
+          "Started on port %d" % [ server.port ]
+        end
+
+        logger.info :server do
+          "-> Transport: %s" % [ server.transport ]
+        end
+
+        logger.info :server do
+          "-> Protocol: %s" % [ server.protocol ]
+        end
+      end
+    end
+
+    extend Forwardable
+
+    def_delegators :@processor, :use
+    def_delegators :@processor, :publisher, :publish, :subscribe
+
+    attr_accessor :port
+
+    def log(logger)
+      subscribe LogSubscriber.new(logger)
+      subscribe ThriftServer::LogSubscriber.new(logger)
+    end
+
+    def metrics(statsd)
+      subscribe ServerMetricsSubscriber.new(statsd)
+      subscribe RpcMetricsSubscriber.new(statsd)
+    end
+
+    def protocol
+      @protocol_factory
+    end
+
+    def transport
+      @transport_factory
+    end
+
+    def server_transport
+      @server_transport
+    end
+
+    def start(dry_run: false)
+      publish :server_start, self
+
+      serve unless dry_run
+    end
+
+    # NOTE: this is a copy of the upstream code with instrumentation added.
+    def serve
+      begin
+        @server_transport.listen
+        loop do
+          client = @server_transport.accept
+
+          remote_address = client.handle.remote_address
+          publish :server_connection_opened, remote_address
+
+          trans = @transport_factory.get_transport(client)
+          prot = @protocol_factory.get_protocol(trans)
+
+          Thread.new(prot, trans) do |p, t|
+            begin
+              loop do
+                @processor.process(p, p)
+              end
+            rescue Thrift::TransportException, Thrift::ProtocolException
+            ensure
+              publish :server_connection_closed, remote_address
+
+              t.close
+            end
+          end
+        end
+      ensure
+        @server_transport.close
+      end
+    end
+  end
+end

data/lib/thrift_server/validation_middleware.rb

@@ -0,0 +1,14 @@
+module ThriftServer
+  class ValidationMiddleware
+    include Concord.new(:app)
+
+    def call(rpc)
+      app.call(rpc).tap do |response|
+        case response
+        when Thrift::Struct, Thrift::Struct_Union
+          Thrift::Validator.new.validate response
+        end
+      end
+    end
+  end
+end

data/lib/thrift_server/version.rb

@@ -1,3 +1,3 @@
-class ThriftServer
-  VERSION = "0.1.1"
+module ThriftServer
+  VERSION = "1.0.0"
 end

data/script/circleci/cache-image

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -eou pipefail
+
+if [ ! -f "${1}.tar.gz" ]; then
+	docker pull "$2"
+	docker save "$2" | gzip --fast > "${1}.tar.gz"
+else
+	gunzip -c "${1}.tar.gz" | docker load
+fi

data/test/log_subscriber_test.rb

@@ -0,0 +1,86 @@
+require_relative 'test_helper'
+
+class LogSubscriberTest < MiniTest::Unit::TestCase
+  attr_reader :logger, :subscriber, :rpc
+
+  def setup
+    @logger = mock
+    @subscriber = ThriftServer::LogSubscriber.new LogYielder.new(logger)
+
+    @rpc = ThriftServer::RPC.new :foo, :bar
+  end
+
+  def test_thread_pool_server_pool_change_with_positive_delta
+    logger.expects(:debug).with do |line|
+      line =~ /\+1/
+    end
+
+    subscriber.thread_pool_server_pool_change delta: 1
+  end
+
+  def test_thread_pool_server_pool_change_with_negative_delta
+    logger.expects(:debug).with do |line|
+      line =~ /-1/
+    end
+
+    subscriber.thread_pool_server_pool_change delta: -1
+  end
+
+  def test_server_connection_opened
+    addr = stub ip_address: 'stub_ip', ip_port: 823
+
+    logger.expects(:debug).with do |line|
+      line =~ /stub_ip/ && line =~ /823/
+    end
+
+    subscriber.server_connection_opened addr
+  end
+
+  def test_server_connection_closed
+    addr = stub ip_address: 'stub_ip', ip_port: 823
+
+    logger.expects(:debug).with do |line|
+      line =~ /stub_ip/ && line =~ /823/
+    end
+
+    subscriber.server_connection_closed addr
+  end
+
+  def test_rpc_ok_logs_result_to_info
+    logger.expects(:info).with do |line|
+      assert_match /foo/, line, 'RPC name not printed'
+      assert_match /OK/, line
+      assert_match /5.*ms/, line, 'Timing not printed'
+    end
+
+    subscriber.rpc_ok rpc, :response, latency: 5
+  end
+
+  def test_rpc_error_prints_result_and_trace
+    error = StandardError.new
+
+    logger.expects(:info).with do |line|
+      assert_match /foo/, line, 'RPC name not printed'
+      refute_match /OK/, line
+      assert_match /StandardError/, line
+      assert_match /5.*ms/, line, 'Timing not printed'
+    end
+
+    logger.expects(:error).with(error)
+
+    subscriber.rpc_error rpc, error, latency: 5
+  end
+
+  def test_rpc_exception_prints_protocol_name
+    rpc.exceptions = { exName: TestException }
+
+    logger.expects(:info).with do |line|
+      assert_match /foo/, line, 'RPC name not printed'
+      refute_match /OK/, line
+      assert_match /exName/, line
+      assert_match /5.*ms/, line, 'Timing not printed'
+    end
+
+    subscriber.rpc_exception rpc, TestException.new(:message), latency: 5
+  end
+end