hoodoo 1.8.2 → 1.8.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWVhNDU3MDkzMjA0YzIwNGRiMGJkZWVjN2JkY2E4OWRiZTQxOWZjMw==
+    Mjk5NDIwYzU1NDI1ODFiYTcxM2FkYTBiZmQwOTg4NmJjMWJhYjFmOQ==
   data.tar.gz: !binary |-
-    ZWJmZjQwY2I4M2I2MTExMmQ0MThlZjk3MTljYTIxMDM5N2E2YjFhZA==
+    YjhkNjVjZDMxYWE2NWZlZDNmMWI0ZjEyMTRiZmY0NjA0MDMyMTVlYQ==
 SHA512:
   metadata.gz: !binary |-
-    ODJmODQ3ZTljMTAwMDcyNDU1YTY2OWJhN2JiY2JkMDgzYzRiM2JmYmYzZTc5
-    NGQ3Yjc2YzEwMTZlODM1MjFhOTBlOTg0NTA4NGUzNmY5NGE4ODEzZjAzZmZj
-    YTEzNzdjMTA0OWY1YTc4NDQ0MWQxZDhlMmFkNTM2ZDg2OTM5OGE=
+    YjRjNzFlZTNhMmEyN2Y1NzQzNjQzYjc5NzUyNjJjNDRkZmEwZDE5NzIwMTY3
+    OTZhYWE3Mzk0MmQ1MzVlNDdiZjE1ZTc3MDUyOGQ2NDMyYTk4MDdmMzJlZGMz
+    NzQ3NWY1OTMzNGFlNDg1MDJjMTI0NDYwZTNmMzAzYmUwNjY5YTg=
   data.tar.gz: !binary |-
-    MWIyNDk0OTE1NTU5MTFmNzU4OTgzZjY4ZjFjZDM0Zjg1NTAxNTVjNWM5YjJk
-    MjU5ZDVhY2YyZjkwODkwOWM1Zjk3ZDg0NDQxMmNhN2Y3ZmEzZTA4MDU4YzZk
-    YTdmM2FjNWQyYWUzMmNjNWE2ZWJjYWRlN2Q5MzUzNzc2ZDRmZjA=
+    ZjM5MjVjYmY4NDI2MjVjOTJmNzYxYWJiZWI0YjFkODUwMWNhNmE4NmUxMjNl
+    NzJmNjM1OTI5ODVmNzU1MjhkYWUzMDBlNThlZDBiZWNiMWNjN2VkY2E2Y2Vi
+    ZDRmMzU3M2Q0MWRiZDYwMzIzZGRmMzMzNDM3NTY0Y2Y4NWI2MGY=

data/lib/hoodoo/monkey.rb

@@ -10,4 +10,5 @@
 ########################################################################
 
 require 'hoodoo/monkey/monkey'
+require 'hoodoo/monkey/patch/newrelic_middleware_analytics'
 require 'hoodoo/monkey/patch/newrelic_traced_amqp'

data/lib/hoodoo/monkey/patch/newrelic_middleware_analytics.rb

@@ -0,0 +1,102 @@
+########################################################################
+# File::    newrelic_middleware_analytics.rb
+# (C)::     Loyalty New Zealand 2016
+#
+# Purpose:: Add custom attributes to NewRelic transactions and improve
+#           visibility over the time spent in implementations separately
+#           from the time spent in middleware.
+#
+#           See Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics for
+#           more.
+# ----------------------------------------------------------------------
+#           06-May-2016 (RJS): Created.
+########################################################################
+
+begin
+  # Raises LoadError if NewRelic is absent
+  require 'new_relic/agent/method_tracer'
+
+  # Add a method tracer on the dispatch method so that the time spent
+  # executing middleware can be distinguished from the time spent
+  # executing the service implementation.
+  #
+  module Hoodoo
+    module Services
+      class Middleware
+        include ::NewRelic::Agent::MethodTracer
+
+        add_method_tracer :dispatch, 'Custom/dispatch'
+      end
+    end
+  end
+rescue LoadError; end
+
+module Hoodoo
+  module Monkey
+    module Patch
+
+      begin
+        require 'newrelic_rpm' # Raises LoadError if NewRelic is absent
+
+        # This module adds custom attributes to NewRelic transaction traces such
+        # that transactions can be filtered by target resource and request
+        # action.
+        #
+        # This module self-registers with Hooodoo::Monkey and, provided
+        # that Hoodoo::Services::Middleware is defined at parse-time,
+        # will be enabled by default.
+        #
+        module NewRelicMiddlewareAnalytics
+
+          # Instance methods to patch over Hoodoo::Services::Middleware.
+          #
+          module InstanceExtensions
+
+            # Add custom attributes to the NewRelic transaction. The original
+            # implementation is called via +super+.
+            #
+            # +interaction+:: Hoodoo::Services::Interaction describing the
+            #                 inbound request. The +interaction_id+,
+            #                 +rack_request+ and +session+ data is used (the
+            #                 latter being optional). If +target_interface+ and
+            #                 +requested_action+ are available, body data
+            #                 _might_ be logged according to secure log settings
+            #                 in the interface; if these values are unset, body
+            #                 data is _not_ logged.
+            #
+            def monkey_log_inbound_request( interaction )
+
+              # Add custom attributes to the NewRelic transaction.
+              ::NewRelic::Agent.add_custom_attributes(
+                {
+                  :target_action => interaction.requested_action,
+                  :target_path   => CGI.unescape( interaction.rack_request.path() )
+                }
+              )
+
+              # Call the original logging method.
+              super( interaction )
+
+            end
+          end
+
+        end
+
+        if defined?( Hoodoo::Services ) &&
+           defined?( Hoodoo::Services::Middleware )
+
+          ::Hoodoo::Monkey.register(
+            target_unit:      Hoodoo::Services::Middleware,
+            extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics
+          )
+
+          ::Hoodoo::Monkey.enable( extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics )
+        end
+
+      rescue LoadError
+        # No NewRelic => do nothing
+      end
+
+    end # module Patch
+  end   # module Monkey
+end     # module Hoodoo

data/lib/hoodoo/services/middleware/middleware.rb

@@ -413,7 +413,6 @@ module Hoodoo; module Services
          service_container.is_a?( NewRelic::Agent::Instrumentation::MiddlewareProxy )
 
         if service_container.respond_to?( :target )
-          newrelic_wrapper  = service_container
           service_container = service_container.target()
         else
           raise "Hoodoo::Services::Middleware instance created with NewRelic-wrapped Service entity, but NewRelic API is not as expected by Hoodoo; incompatible NewRelic version."
@@ -947,6 +946,80 @@ module Hoodoo; module Services
       return result
     end
 
+    # Make an "inbound" call log based on the given interaction.
+    #
+    # +interaction+:: Hoodoo::Services::Interaction describing the inbound
+    #                 request. The +interaction_id+, +rack_request+ and
+    #                 +session+ data is used (the latter being optional).
+    #                 If +target_interface+ and +requested_action+ are
+    #                 available, body data _might_ be logged according to
+    #                 secure log settings in the interface; if these
+    #                 values are unset, body data is _not_ logged.
+    #
+    def monkey_log_inbound_request( interaction )
+
+      data = build_common_log_data_for( interaction )
+
+      # Annoying dance required to extract all HTTP header data from Rack.
+
+      env     = interaction.rack_request.env
+      headers = env.select do | key, value |
+        key.to_s.match( /^HTTP_/ )
+      end
+
+      headers[ 'CONTENT_TYPE'   ] = env[ 'CONTENT_TYPE'   ]
+      headers[ 'CONTENT_LENGTH' ] = env[ 'CONTENT_LENGTH' ]
+
+      data[ :payload ] = {
+        :method  => env[ 'REQUEST_METHOD', ],
+        :scheme  => env[ 'rack.url_scheme' ],
+        :host    => env[ 'SERVER_NAME'     ],
+        :port    => env[ 'SERVER_PORT'     ],
+        :script  => env[ 'SCRIPT_NAME'     ],
+        :path    => env[ 'PATH_INFO'       ],
+        :query   => env[ 'QUERY_STRING'    ],
+        :headers => headers
+      }
+
+      # Deal with body data and security issues.
+
+      secure    = true
+      interface = interaction.target_interface
+      action    = interaction.requested_action
+
+      unless interface.nil? || action.nil?
+        secure_log_actions = interface.secure_log_for()
+        secure_type        = secure_log_actions[ action ]
+
+        # Allow body logging if there's no security specified for this action
+        # or the security is specified for the response only (since we log the
+        # request here).
+        #
+        # This means values of :both or :request will leave "secure" unchanged,
+        # as will any other unexpected value that might get specified.
+
+        secure = false if secure_type.nil? || secure_type == :response
+      end
+
+      # Compile the remaining log payload and send it.
+
+      unless secure
+        body = interaction.rack_request.body.read( MAXIMUM_LOGGED_PAYLOAD_SIZE )
+               interaction.rack_request.body.rewind()
+
+        data[ :payload ][ :body ] = body
+      end
+
+      @@logger.report(
+        :info,
+        :Middleware,
+        :inbound,
+        data
+      )
+
+      return nil
+    end
+
   private
 
     @@interfaces_have_public_methods = false
@@ -1111,80 +1184,6 @@ module Hoodoo; module Services
       return data
     end
 
-    # Make an "inbound" call log based on the given interaction.
-    #
-    # +interaction+:: Hoodoo::Services::Interaction describing the inbound
-    #                 request. The +interaction_id+, +rack_request+ and
-    #                 +session+ data is used (the latter being optional).
-    #                 If +target_interface+ and +requested_action+ are
-    #                 available, body data _might_ be logged according to
-    #                 secure log settings in the interface; if these
-    #                 values are unset, body data is _not_ logged.
-    #
-    def log_inbound_request( interaction )
-
-      data = build_common_log_data_for( interaction )
-
-      # Annoying dance required to extract all HTTP header data from Rack.
-
-      env     = interaction.rack_request.env
-      headers = env.select do | key, value |
-        key.to_s.match( /^HTTP_/ )
-      end
-
-      headers[ 'CONTENT_TYPE'   ] = env[ 'CONTENT_TYPE'   ]
-      headers[ 'CONTENT_LENGTH' ] = env[ 'CONTENT_LENGTH' ]
-
-      data[ :payload ] = {
-        :method  => env[ 'REQUEST_METHOD', ],
-        :scheme  => env[ 'rack.url_scheme' ],
-        :host    => env[ 'SERVER_NAME'     ],
-        :port    => env[ 'SERVER_PORT'     ],
-        :script  => env[ 'SCRIPT_NAME'     ],
-        :path    => env[ 'PATH_INFO'       ],
-        :query   => env[ 'QUERY_STRING'    ],
-        :headers => headers
-      }
-
-      # Deal with body data and security issues.
-
-      secure    = true
-      interface = interaction.target_interface
-      action    = interaction.requested_action
-
-      unless interface.nil? || action.nil?
-        secure_log_actions = interface.secure_log_for()
-        secure_type        = secure_log_actions[ action ]
-
-        # Allow body logging if there's no security specified for this action
-        # or the security is specified for the response only (since we log the
-        # request here).
-        #
-        # This means values of :both or :request will leave "secure" unchanged,
-        # as will any other unexpected value that might get specified.
-
-        secure = false if secure_type.nil? || secure_type == :response
-      end
-
-      # Compile the remaining log payload and send it.
-
-      unless secure
-        body = interaction.rack_request.body.read( MAXIMUM_LOGGED_PAYLOAD_SIZE )
-               interaction.rack_request.body.rewind()
-
-        data[ :payload ][ :body ] = body
-      end
-
-      @@logger.report(
-        :info,
-        :Middleware,
-        :inbound,
-        data
-      )
-
-      return nil
-    end
-
     # This is part of the formalised structured logging interface upon which
     # external entites might depend. Change with care.
     #
@@ -1637,7 +1636,7 @@ module Hoodoo; module Services
     # order to give later processing stages a chance to determine if the
     # body data could be safely logged (since it's useful to have). Thus,
     # later processing stages will still need to make a call to
-    # "log_inbound_request".
+    # "monkey_log_inbound_request".
     #
     # +interaction+:: Hoodoo::Services::Middleware::Interaction instance
     #                 describing the current interaction. Parts of this may
@@ -1657,7 +1656,7 @@ module Hoodoo; module Services
       # target resource or action, so we won't accidentally log secure data in
       # the inbound payload (if any).
 
-      log_inbound_request( interaction )
+      monkey_log_inbound_request( interaction )
       set_common_response_headers( interaction )
 
       # Potential special-case early exit for CORS preflight.
@@ -1756,7 +1755,7 @@ module Hoodoo; module Services
       # We finally have enough data to log the inbound call again, with body
       # data included if allowed by the target resource.
 
-      log_inbound_request( interaction )
+      monkey_log_inbound_request( interaction )
 
       authorisation = determine_authorisation( interaction )
       return if response.halt_processing?
@@ -1857,7 +1856,6 @@ module Hoodoo; module Services
 
       # Set up some convenience variables
 
-      interface      = interaction.target_interface
       implementation = interaction.target_implementation
       action         = interaction.requested_action
       context        = interaction.context
@@ -2831,7 +2829,7 @@ module Hoodoo; module Services
 
         end
 
-      rescue => e
+      rescue
         payload_hash = {}
         interaction.context.response.errors.add_error( 'generic.malformed' )
 

data/lib/hoodoo/version.rb

@@ -12,6 +12,6 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, ensure that the date in
   # "hoodoo.gemspec" is correct and run "bundle install" (or "update").
   #
-  VERSION = '1.8.2'
+  VERSION = '1.8.3'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -330,6 +330,7 @@ files:
 - lib/hoodoo/middleware.rb
 - lib/hoodoo/monkey.rb
 - lib/hoodoo/monkey/monkey.rb
+- lib/hoodoo/monkey/patch/newrelic_middleware_analytics.rb
 - lib/hoodoo/monkey/patch/newrelic_traced_amqp.rb
 - lib/hoodoo/presenters.rb
 - lib/hoodoo/presenters/base.rb