skylight 1.3.1 → 1.4.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83dd7c6f5a27d456efd3e03bfc08303fea5f1085
-  data.tar.gz: c7bfa08ec18f46a18b43ae6e2d7e4d568f54d6b1
+  metadata.gz: 8a44af3f665e6d0fd8a25dc3d867ea86dae43620
+  data.tar.gz: edac70c82631fb57e9990aeeedbb55a62e4111d5
 SHA512:
-  metadata.gz: 5b2faf2103731fc3549aa34da956454461703fff11e05d18de2be546b9adab1f0011b96782894d0aea709b03aa1070a5e27421dc8800c92b2f9a5914cdac418b
-  data.tar.gz: 585d6d962d8473fdf99d5fcc2a97fa97732d9a691e92ffb3e51c4219bdf75fa834f4d7eaefdb96ec9d3a1109616a3e744fd4cb9765829808a7dee8b9a1327482
+  metadata.gz: da6cec1e164c3c49cce1239c88efb74f7dca60e0b699aadf051cf97fb2def14a813e0a99badac04c50c2750ab2bd0f420d69fb88fb2421ce92ef4d9a42dc1bb6
+  data.tar.gz: 12bc7d82549fc243fd7446892d2387ce635a941d5ae23600713e9b2432d68dbb2b7793e8bcaa369227127b1027d964d1125492f273e89f5e5220813fcf027bed

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.4.0-beta (July 13, 2017)
+
+* [FEATURE] Add probe for Rack Middlewares. To enable, add 'middleware' to `config.skylight.probes` list.
+* [IMPROVEMENT] Increase limit for items tracked in a requests
+* [IMPROVEMENT] Allow for more fine-grained control over position of Skylight::Middleware
+* [IMPROVEMENT] Avoid processing Skylight::Middleware unnecessarily
+
 ## 1.3.1 (May 17, 2017)
 
 * [IMPROVEMENT] Better suggestions in `skylight doctor`.

data/ext/libskylight.yml

@@ -1,7 +1,7 @@
 ---
-version: "1.1.0-de45c74"
+version: "1.4.0-7aecded"
 checksums:
-  x86-linux:         "fbfb6a647701403a11e2e81045dd84b3c55ec7fedf60910bfa372c9bf7ef8b5f"
-  x86_64-linux:      "6958c20cc35bea207f12e65530460dda64ed6a31556a76de8911ae9c604cff93"
-  x86_64-linux-musl: "65171091e9262755431e52e1b1c3c7e4881c71bbf8ded322aa599f137baecf10"
-  x86_64-darwin:     "238ae95c68a8d4601d2e4e2c2583090750cd70e647c0342f73699ab772b35335"
+  x86-linux:         "79162dfc4dee8954869d2820e60e8d15d4f4915f66e29bedd15e68030acd5b27"
+  x86_64-linux:      "117ac0ff29240a518717fcf52f7cd3eeec69a135c481693b8eb259bb4c2b528c"
+  x86_64-linux-musl: "bab4030060eb4b83d0543839e0f51b09545d7d5b20c3f7dd35ae6f81f3189499"
+  x86_64-darwin:     "1c0fdb68c0dde34a1b0842403db2ea2ca6a0de2fb7d729e869f395f6d10383b5"

data/lib/skylight/core.rb

@@ -38,6 +38,7 @@ module Skylight
 
   # @api private
   TIERS = %w(
+    rack
     api
     app
     view
@@ -67,6 +68,12 @@ module Skylight
     Instrumenter.stop!(*args)
   end
 
+  # Check tracing
+  def self.tracing?
+    inst = Instrumenter.instance
+    inst && inst.current_trace
+  end
+
   # Start a trace
   def self.trace(endpoint=nil, cat=nil, title=nil)
     unless inst = Instrumenter.instance

data/lib/skylight/middleware.rb

@@ -40,6 +40,17 @@ module Skylight
       end
     end
 
+    def self.with_after_close(resp, &block)
+      # Responses should be finished but in some situations they aren't
+      #   e.g. https://github.com/ruby-grape/grape/issues/1041
+      if resp.respond_to?(:finish)
+        resp = resp.finish
+      end
+
+      resp[2] = BodyProxy.new(resp[2], &block)
+      resp
+    end
+
     include Util::Logging
 
     # For Util::Logging
@@ -51,7 +62,13 @@ module Skylight
     end
 
     def call(env)
-      if env["REQUEST_METHOD"] == "HEAD"
+      # Skylight can handle double tracing, but avoid the BodyProxy if we don't need it
+      # This generally shouldn't happen, but older verions of Rails can allow the same
+      # middleware to be inserted multiple times
+      if Skylight.tracing?
+        t { "already tracing, skipping" }
+        @app.call(env)
+      elsif env["REQUEST_METHOD"] == "HEAD"
         t { "middleware skipping HEAD" }
         @app.call(env)
       else
@@ -60,14 +77,11 @@ module Skylight
           trace = Skylight.trace "Rack", 'app.rack.request'
           resp = @app.call(env)
 
-          # Responses should be finished but in some situations they aren't
-          #   e.g. https://github.com/ruby-grape/grape/issues/1041
-          if resp.respond_to?(:finish)
-            resp = resp.finish
+          if trace
+            Middleware.with_after_close(resp) { trace.submit }
+          else
+            resp
           end
-
-          resp[2] = BodyProxy.new(resp[2]) { trace.submit } if trace
-          resp
         rescue Exception
           t { "middleware exception: #{trace}"}
           trace.submit if trace

data/lib/skylight/probes/middleware.rb

@@ -0,0 +1,51 @@
+module Skylight
+  module Probes
+    module Middleware
+      class Probe
+        def install
+          ActionDispatch::MiddlewareStack::Middleware.class_eval do
+            alias build_without_sk build
+            def build(*args)
+              sk_instrument_middleware(build_without_sk(*args))
+            end
+
+            def sk_instrument_middleware(middleware)
+              return middleware if middleware.is_a?(Skylight::Middleware)
+
+              # Not sure how this would actually happen
+              return middleware if middleware.respond_to?(:call_without_sk)
+
+              # On Rails 3, ActionDispatch::Session::CookieStore is frozen, for one
+              return middleware if middleware.frozen?
+
+              middleware.instance_eval do
+                alias call_without_sk call
+                def call(*args, &block)
+                  trace = Skylight::Instrumenter.try(:instance).try(:current_trace)
+                  return call_without_sk(*args, &block) unless trace
+
+                  begin
+                    trace.endpoint = self.class.name
+
+                    span = Skylight.instrument(title: self.class.name, category: "rack.middleware")
+                    resp = call_without_sk(*args, &block)
+
+                    Skylight::Middleware.with_after_close(resp) { trace.done(span) }
+                  rescue Exception
+                    # FIXME: Log this?
+                    trace.done(span)
+                    raise
+                  end
+                end
+              end
+
+              middleware
+            end
+          end
+        end
+      end
+    end
+
+    register("ActionDispatch::MiddlewareStack::Middleware", "actionpack/action_dispatch", Middleware::Probe.new)
+  end
+end

data/lib/skylight/railtie.rb

@@ -17,6 +17,10 @@ module Skylight
     #   Also available: excon, redis, sinatra, tilt, sequel
     config.skylight.probes = ['net_http', 'action_controller', 'action_view', 'grape']
 
+    # The position in the middleware stack to place Skylight
+    # Default is first, but can be `{ after: Middleware::Name }` or `{ before: Middleware::Name }`
+    config.skylight.middleware_position = 0
+
     initializer 'skylight.configure' do |app|
       # Load probes even when agent is inactive to catch probe related bugs sooner
       load_probes
@@ -27,7 +31,7 @@ module Skylight
         if config
           begin
             if Instrumenter.start!(config)
-              app.middleware.insert 0, Middleware, config: config
+              set_middleware_position(app, config)
               Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Skylight agent enabled"
             else
               Rails.logger.info "[SKYLIGHT] [#{Skylight::VERSION}] Unable to start, see the Skylight logs for more details"
@@ -121,5 +125,31 @@ module Skylight
         require "skylight/probes/#{p}"
       end
     end
+
+    def middleware_position
+      config.skylight.middleware_position.is_a?(Hash) ? config.skylight.middleware_position.symbolize_keys : config.skylight.middleware_position
+    end
+
+    def insert_middleware(app, config)
+      if middleware_position.has_key?(:after)
+        app.middleware.insert_after(middleware_position[:after], Skylight::Middleware, config: config)
+      elsif middleware_position.has_key?(:before)
+        app.middleware.insert_before(middleware_position[:before], Skylight::Middleware, config: config)
+      else
+        raise "The middleware position you have set is invalid. Please be sure `config.skylight.middleware_position` is set up correctly."
+      end
+    end
+
+    def set_middleware_position(app, config)
+      if middleware_position.is_a?(Integer)
+        app.middleware.insert middleware_position, Middleware, config: config
+      elsif middleware_position.is_a?(Hash) && middleware_position.keys.count == 1
+        insert_middleware(app, config)
+      elsif middleware_position.nil?
+        app.middleware.insert 0, Middleware, config: config
+      else
+        raise "The middleware position you have set is invalid. Please be sure `config.skylight.middleware_position` is set up correctly."
+      end
+    end
   end
 end

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.3.1'
+  VERSION = '1.4.0-beta'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0.beta
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,6 +95,7 @@ files:
 - lib/skylight/probes/excon/middleware.rb
 - lib/skylight/probes/grape.rb
 - lib/skylight/probes/httpclient.rb
+- lib/skylight/probes/middleware.rb
 - lib/skylight/probes/mongo.rb
 - lib/skylight/probes/mongoid.rb
 - lib/skylight/probes/moped.rb
@@ -184,9 +185,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11