process_handler 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e119788704709faa74d7d32dcd6f51ce7855cca
-  data.tar.gz: b11089474652313aa5ab9b011b2faf98fb3c5675
+  metadata.gz: 503d8ce446eeb4caa121a37d828f72c7662ac37d
+  data.tar.gz: fb470e66c0e819f29ccc74238ece33fe8cb4ea00
 SHA512:
-  metadata.gz: ecf3ec60ff2258b482b4fba84ab246e53863972348393334c17baf7595b596c1c0ec94893fec5661e2bc374e28cd15223ac53ea49e4aea5e3db747f3bd7ea86a
-  data.tar.gz: 39e37e9e8c3e3d6fe0efcb76bb7b9b28f0ee92b467f5b1f51628ed27d658e6b6df10f520c7de039c68758937b887d04e118c8932e559e2c969f372a46e78e355
+  metadata.gz: e509844d303791e07770096198abb40a9dae45c9de590b96ca38b96c3d896d03b52e0d426bba7ea4d3b3b542363bd91f8880d881c1272a8e22f2177d98161590
+  data.tar.gz: 7154af8b659b52b3aca64c12011dc92d7599115bcebadd769eb1fd79f9e1a9b96fc14d1014b410a30be3efb29d510950201c3b8525a45d62c133272069389bb7

data/README.md

@@ -12,8 +12,14 @@ Example of using pivot process:
 ```ruby
   service = MyService.new
   freddy = Freddy.new
+  statsd = Statsd.new
+  logger = Logasm.build('my-app', {stdout: {level: :debug}})
 
-  process = Salemove::ProcessHandler::PivotProcess.new(freddy)
+  process = Salemove::ProcessHandler::PivotProcess.new(
+    freddy: freddy,
+    logger: logger,
+    statsd: statsd
+  )
   process.spawn(service)
 ```
 

data/lib/salemove/process_handler/pivot_process.rb

@@ -1,4 +1,3 @@
-require 'logger'
 require 'benchmark'
 require 'securerandom'
 require_relative 'process_monitor'
@@ -9,17 +8,10 @@ module Salemove
     class PivotProcess
 
       DEFAULT_FULFILLABLE_TIMEOUT = 3
+      DEFAULT_EXECUTION_TIME_KEY = 'service.execution_time'.freeze
 
       attr_reader :process_monitor, :exception_notifier
 
-      def self.logger
-        @logger ||= Logger.new(STDOUT).tap { |l| l.level = Logger::INFO }
-      end
-
-      def self.logger=(logger)
-        @logger = logger
-      end
-
       def self.tracing_supported?
         defined?(Freddy) &&
           Freddy.respond_to?(:trace) &&
@@ -34,13 +26,22 @@ module Salemove
         end
       end
 
-      def initialize(freddy,
+      def initialize(freddy:,
+                     logger:,
+                     statsd:,
                      notifier: nil,
                      notifier_factory: NotifierFactory,
                      process_monitor: ProcessMonitor.new,
                      process_name: 'Unknown process',
+                     execution_time_key: DEFAULT_EXECUTION_TIME_KEY,
                      exit_enforcer: nil)
         @freddy = freddy
+        @logger = logger
+        @benchmarker = Benchmarker.new(
+          statsd: statsd,
+          application: process_name,
+          execution_time_key: execution_time_key
+        )
         @process_monitor = process_monitor
         @exception_notifier = notifier_factory.get_notifier(process_name, notifier)
         # Needed for forcing exit from jruby with exit(0)
@@ -56,7 +57,15 @@ module Salemove
 
       def spawn_queue_threads(service)
         if service.class.const_defined?(:QUEUE)
-          [ServiceSpawner.spawn(service, @freddy, @exception_notifier)]
+          [
+            ServiceSpawner.new(
+              service,
+              freddy: @freddy,
+              logger: @logger,
+              benchmarker: @benchmarker,
+              exception_notifier: @exception_notifier
+            ).spawn
+          ]
         else
           []
         end
@@ -65,7 +74,13 @@ module Salemove
       def spawn_tap_threads(service)
         if service.class.const_defined?(:TAPPED_QUEUES)
           service.class::TAPPED_QUEUES.map do |queue|
-            spawner = TapServiceSpawner.new(service, @freddy, @exception_notifier)
+            spawner = TapServiceSpawner.new(
+              service,
+              freddy: @freddy,
+              logger: @logger,
+              benchmarker: @benchmarker,
+              exception_notifier: @exception_notifier
+            )
             spawner.spawn(queue)
           end
         else
@@ -75,18 +90,6 @@ module Salemove
 
       private
 
-      def self.benchmark(input, &block)
-        type = input[:type] if input.is_a?(Hash)
-        result = nil
-
-        bm = Benchmark.measure { result = block.call }
-        if defined?(Logasm) && PivotProcess.logger.is_a?(Logasm)
-          PivotProcess.logger.info "Execution time", {
-            type: type, real: bm.real, user: bm.utime, system: bm.stime
-          }.merge(PivotProcess.trace_information)
-        end
-        result
-      end
 
       def wait_for_monitor
         sleep 1 while @process_monitor.running?
@@ -96,9 +99,11 @@ module Salemove
       end
 
       class TapServiceSpawner
-        def initialize(service, freddy, exception_notifier)
+        def initialize(service, freddy:, logger:, benchmarker:, exception_notifier:)
           @service = service
           @freddy = freddy
+          @logger = logger
+          @benchmarker = benchmarker
           @exception_notifier = exception_notifier
         end
 
@@ -109,14 +114,14 @@ module Salemove
         end
 
         def delegate_to_service(input)
-          PivotProcess.logger.info "Received request", PivotProcess.trace_information.merge(input)
-          PivotProcess.benchmark(input) { @service.call(input) }
+          @logger.info 'Received request', PivotProcess.trace_information.merge(input)
+          @benchmarker.call(input) { @service.call(input) }
         rescue => exception
           handle_exception(exception, input)
         end
 
         def handle_exception(e, input)
-          PivotProcess.logger.error(e.inspect + "\n" + e.backtrace.join("\n"), PivotProcess.trace_information)
+          @logger.error(e.inspect + "\n" + e.backtrace.join("\n"), PivotProcess.trace_information)
           if @exception_notifier
             @exception_notifier.notify_or_ignore(e, cgi_data: ENV.to_hash, parameters: input)
           end
@@ -126,13 +131,11 @@ module Salemove
       class ServiceSpawner
         PROCESSED_REQUEST_LOG_KEYS = [:error, :success]
 
-        def self.spawn(service, freddy, exception_notifier)
-          new(service, freddy, exception_notifier).spawn
-        end
-
-        def initialize(service, freddy, exception_notifier)
+        def initialize(service, freddy:, logger:, benchmarker:, exception_notifier:)
           @service = service
           @freddy = freddy
+          @logger = logger
+          @benchmarker = benchmarker
           @exception_notifier = exception_notifier
         end
 
@@ -159,7 +162,7 @@ module Salemove
             end
           end
         rescue Timeout::Error
-          PivotProcess.logger.error "Fullfillable response was not fulfilled in #{timeout} seconds", input
+          @logger.error "Fullfillable response was not fulfilled in #{timeout} seconds", input
           handle_response(handler, success: false, error: "Fulfillable response was not fulfilled")
         end
 
@@ -172,7 +175,7 @@ module Salemove
         end
 
         def handle_request(input)
-          PivotProcess.logger.info "Received request", PivotProcess.trace_information.merge(input)
+          @logger.info 'Received request', PivotProcess.trace_information.merge(input)
           if input.has_key?(:ping)
             { success: true, pong: 'pong' }
           else
@@ -183,7 +186,7 @@ module Salemove
         end
 
         def delegate_to_service(input)
-          result = PivotProcess.benchmark(input) { @service.call(input) }
+          result = @benchmarker.call(input) { @service.call(input) }
           if !result.respond_to?(:fulfilled?)
             log_processed_request(input, result)
           end
@@ -197,17 +200,39 @@ module Salemove
             .merge(type: input[:type])
             .merge(PivotProcess.trace_information)
 
-          PivotProcess.logger.info "Processed request", attributes
+          @logger.info 'Processed request', attributes
         end
 
         def handle_exception(e, input)
-          PivotProcess.logger.error(e.inspect + "\n" + e.backtrace.join("\n"), PivotProcess.trace_information)
+          @logger.error(e.inspect + "\n" + e.backtrace.join("\n"), PivotProcess.trace_information)
           if @exception_notifier
             @exception_notifier.notify_or_ignore(e, cgi_data: ENV.to_hash, parameters: input)
           end
           { success: false, error: e.message }
         end
       end
+
+      class Benchmarker
+        def initialize(statsd:, application:, execution_time_key:)
+          @statsd = statsd
+          @application = application
+          @execution_time_key = execution_time_key
+        end
+
+        def call(input, &block)
+          type = input[:type] if input.is_a?(Hash)
+          result = nil
+
+          bm = Benchmark.measure { result = block.call }
+
+          @statsd.histogram(@execution_time_key, bm.real, tags: [
+            "application:#{@application}",
+            "type:#{type || 'unknown'}"
+          ])
+
+          result
+        end
+      end
     end
   end
 end

data/lib/salemove/process_handler/version.rb

@@ -1,5 +1,5 @@
 module Salemove
   module ProcessHandler
-    VERSION = '1.1.2'
+    VERSION = '2.0.0'
   end
 end

data/spec/fixtures/composite_service.rb

@@ -13,12 +13,17 @@ module Salemove
     end
   end
 
-  class Messenger
+  class Freddy
     def respond_to(*)
       ResponderHandler.new
     end
   end
 
+  class DummyStatsd
+    def histogram(*)
+    end
+  end
+
   class ResponderHandler
     def shutdown
     end
@@ -28,8 +33,11 @@ module Salemove
   cron_process.schedule('0.5')
   cron_process.schedule('5', some: 'params')
 
-  ProcessHandler::PivotProcess.logger = Logger.new('/dev/null')
-  pivot_process = ProcessHandler::PivotProcess.new(Messenger.new)
+  pivot_process = ProcessHandler::PivotProcess.new(
+    freddy: Freddy.new,
+    logger: Logger.new('/dev/null'),
+    statsd: DummyStatsd.new
+  )
 
   ProcessHandler.start_composite do
     add cron_process, EchoResultService.new

data/spec/process_handler/pivot_process_spec.rb

@@ -5,13 +5,24 @@ require 'salemove/process_handler/pivot_process'
 describe ProcessHandler::PivotProcess do
   let(:monitor) { double('Monitor') }
   let(:freddy) { double('Freddy') }
+  let(:statsd) { spy('Statsd') }
   let(:handler) { double('Handler') }
   let(:thread) { double('Thread') }
-  let(:process) { ProcessHandler::PivotProcess.new(freddy, process_params) }
-  let(:process_params) {{ process_monitor: monitor , notifier_factory: notifier_factory}}
   let(:notifier_factory) { double('NotifierFactory') }
   let(:responder) { double(shutdown: true) }
   let(:logger) { Logasm.build('test-app', []) }
+  let(:application) { 'my-app' }
+
+  let(:process) do
+    ProcessHandler::PivotProcess.new(
+      freddy: freddy,
+      logger: logger,
+      statsd: statsd,
+      process_monitor: monitor,
+      process_name: application,
+      notifier_factory: notifier_factory
+    )
+  end
 
   def expect_monitor_to_behave
     expect(monitor).to receive(:start)
@@ -20,7 +31,6 @@ describe ProcessHandler::PivotProcess do
   end
 
   before do
-    ProcessHandler::PivotProcess.logger = logger
     allow(notifier_factory).to receive(:get_notifier) { nil }
     expect_monitor_to_behave
   end
@@ -62,6 +72,15 @@ describe ProcessHandler::PivotProcess do
         subject()
       end
 
+      it 'records execution time' do
+        expect(statsd).to receive(:histogram)
+          .with(
+            'service.execution_time',
+            instance_of(Float),
+            tags: ["application:#{application}", "type:unknown"]
+          )
+        subject()
+      end
     end
 
     describe 'when service responds with an error' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process_handler
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake