skylight 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466b969f1013fe2e80edfed072c777a9196bc5e72df4586fd129e71d13f68ef6
-  data.tar.gz: e779017f866e565f5ce333b0c4118f4e6428eed72fc5a931e44dbc82d30f4080
+  metadata.gz: c1219b6ae71c3331396631a73e0866eb68d681eace43059b1c8690daca5e3634
+  data.tar.gz: 1b95ca11947bd572ebf69d5677cb9450533da0f86745a5733af64c4b3bed6fad
 SHA512:
-  metadata.gz: 5f18a8b623a511912750df11dfeb91510510c977a4cc141a329f792ea4065d9ae11155ec68bd9f98cdf6aec7dd93a2e0b707a1955eee3e74a6c51fd6b0c7911f
-  data.tar.gz: 36200567127b6ae47ef97f4c0b1dca385023128f28f63ee5c379c9e34b624fe15ea7565a7d0d5d8816c51427c642006a1e837c46498cc8fd22a5b25e02b10665
+  metadata.gz: 55c2b9c85310d9cb40afa744364759c854ac5b94787a285947986d85477b3df4119ff14da33b44e53fc2383499d61b70d0373aecbcebd9cbfbbe5d0fb11a022f
+  data.tar.gz: ff24d96979a028ba73c8c7d9942ae312d63a6a2eefe49354648fe39832e7f189babd2a85a1f4e06b7de6857c3188efae97f4b1f5e7fff9c30efecafc7b60a94a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.6.0 (March 21, 2018)
+
+* [FEATURE] Time spent the Rails router is now identified separately in the trace
+* [IMPROVEMENT] Switch logger to debug mode if tracing is enabled
+* [IMPROVEMENT] Improved logging for a number of error cases
+* [IMPROVEMENT] Middleware probe should now accept anything allowed by Rack::Lint
+* [IMPROVEMENT] We were using arity checks to determine Rails version but due to other libraries' monkey patches this could sometimes fail. We just check version numbers now.
+* [BUGFIX] Middleware probe no longer errors when Middleware returns a frozen array
+
 ## 1.5.1 (February 7, 2018)
 
 * [BUGFIX] `skylight doctor` no longer erroneously reports inability to reach Skylight servers.

data/ext/extconf.rb

@@ -220,7 +220,7 @@ $CFLAGS << " -std=c99 -Wall -fno-strict-aliasing"
 
 # Allow stricter checks to be turned on for development or debugging
 if SKYLIGHT_EXT_STRICT
-  $CFLAGS << " -pedantic"
+  $CFLAGS << " -Wextra"
 end
 
 # TODO: Compute the relative path to the location

data/lib/skylight/config.rb

@@ -632,13 +632,18 @@ authentication: #{self[:authentication]}
         out = STDOUT if out == '-'
 
         l = create_logger(out)
-        l.level =
-          case get(:log_level)
-          when /^debug$/i then Logger::DEBUG
-          when /^info$/i  then Logger::INFO
-          when /^warn$/i  then Logger::WARN
-          when /^error$/i then Logger::ERROR
-          end
+
+        if ENV[TRACE_ENV_KEY]
+          l.level = Logger::DEBUG
+        else
+          l.level =
+            case get(:log_level)
+            when /^debug$/i then Logger::DEBUG
+            when /^info$/i  then Logger::INFO
+            when /^warn$/i  then Logger::WARN
+            when /^error$/i then Logger::ERROR
+            end
+        end
       end
 
       l

data/lib/skylight/core.rb

@@ -118,6 +118,11 @@ module Skylight
     inst.done(span)
   end
 
+  def self.broken!
+    return unless inst = Instrumenter.instance
+    inst.broken!
+  end
+
   # Temporarily disable
   def self.disable
     unless inst = Instrumenter.instance

data/lib/skylight/instrumenter.rb

@@ -57,15 +57,7 @@ module Skylight
     end
 
     at_exit do
-      if RUBY_VERSION == '1.9.2'
-        # workaround for MRI bug losing exit status in at_exit block
-        # http://bugs.ruby-lang.org/issues/5218
-        exit_status = $!.status if $!.is_a?(SystemExit)
-        stop!
-        exit exit_status if exit_status
-      else
-        stop!
-      end
+      stop!
     end
 
     attr_reader :config, :gc, :trace_info
@@ -189,6 +181,11 @@ module Skylight
       trace.done(span)
     end
 
+    def broken!
+      return unless trace = @trace_info.current
+      trace.broken!
+    end
+
     def instrument(cat, title=nil, desc=nil)
       raise ArgumentError, 'cat is required' unless cat
 

data/lib/skylight/middleware.rb

@@ -42,14 +42,14 @@ module Skylight
     end
 
     def self.with_after_close(resp, &block)
-      # Responses should be finished but in some situations they aren't
+      # Responses should be arrays 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
+      # The safest approach seems to be to rely on implicit destructuring
+      #   since that is currently what Rack::Lint does.
+      # See also https://github.com/rack/rack/issues/1239
+      status, headers, body = resp
 
-      resp[2] = BodyProxy.new(resp[2], &block)
-      resp
+      [status, headers, BodyProxy.new(body, &block)]
     end
 
     include Util::Logging
@@ -63,13 +63,11 @@ module Skylight
     end
 
     def call(env)
-      # 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"
+        error "Already instrumenting. Make sure the Middleware hasn't been added more than once."
+      end
+
+      if env["REQUEST_METHOD"] == "HEAD"
         t { "middleware skipping HEAD" }
         @app.call(env)
       else

data/lib/skylight/probes/action_controller.rb

@@ -31,11 +31,16 @@ module Skylight
                   :controller => self.class.name,
                   :action     => self.action_name,
                   :params     => request.filtered_parameters,
-                  :format     => request.format.try(:ref),
                   :method     => request.request_method,
                   :path       => (request.fullpath rescue "unknown")
                 }
 
+                if Gem::Version.new(Rails.version) < Gem::Version.new('3.1')
+                  raw_payload[:formats] = request.formats.map(&:to_sym)
+                else
+                  raw_payload[:format] = request.format.try(:ref)
+                end
+
                 ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)
 
                 ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|

data/lib/skylight/probes/action_view.rb

@@ -18,11 +18,9 @@ module Skylight
               layout = nil
 
               if path
-                if method(:find_layout).arity == 3
-                  # Rails 5
+                if ::ActionView.respond_to?(:gem_version) && ::ActionView.gem_version >= Gem::Version.new('5.x')
                   layout = find_layout(path, locals.keys, [formats.first])
                 else
-                  # Rails 3, 4
                   layout = find_layout(path, locals.keys)
                 end
               end

data/lib/skylight/probes/middleware.rb

@@ -1,8 +1,55 @@
 module Skylight
   module Probes
     module Middleware
+
+      def self.add_instrumentation(middleware, default_name="Anonymous Middleware", category="rack.middleware")
+        middleware.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          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
+              name = self.class.name || "#{default_name}"
+
+              trace.endpoint = name
+
+              span = Skylight.instrument(title: name, category: "#{category}")
+              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
+        RUBY
+      end
+
       class Probe
+
         def install
+          ActionDispatch::MiddlewareStack.class_eval do
+            alias build_without_sk build
+
+            if ::ActionPack.respond_to?(:gem_version) && ::ActionPack.gem_version >= Gem::Version.new('5.x')
+              # Rails 5
+              def build(app = Proc.new)
+                Skylight::Probes::Middleware.add_instrumentation(app, "Rack App", "rack.app")
+                build_without_sk(app)
+              end
+            else
+              # Rails 3 and 4
+              def build(app, &block)
+                app ||= block
+                raise "MiddlewareStack#build requires an app" unless app
+                Skylight::Probes::Middleware.add_instrumentation(app, "Rack App", "rack.app")
+                build_without_sk(app)
+              end
+            end
+          end
+
           ActionDispatch::MiddlewareStack::Middleware.class_eval do
             alias build_without_sk build
             def build(*args)
@@ -18,28 +65,7 @@ module Skylight
               # 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
-                    name = self.class.name || "Anonymous Middleware"
-
-                    trace.endpoint = name
-
-                    span = Skylight.instrument(title: 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
+              Skylight::Probes::Middleware.add_instrumentation(middleware)
 
               middleware
             end

data/lib/skylight/trace.rb

@@ -47,8 +47,12 @@ module Skylight
       @instrumenter.config
     end
 
+    def broken?
+      !!@broken
+    end
+
     def record(cat, title=nil, desc=nil)
-      return if @broken
+      return if broken?
 
       title.freeze if title.is_a?(String)
       desc.freeze  if desc.is_a?(String)
@@ -62,12 +66,12 @@ module Skylight
       nil
     rescue => e
       error "failed to record span; msg=%s", e.message
-      @broken = true
+      broken!
       nil
     end
 
     def instrument(cat, title=nil, desc=nil)
-      return if @broken
+      return if broken?
       t { "instrument: #{cat}, #{title}" }
 
       title.freeze if title.is_a?(String)
@@ -78,7 +82,8 @@ module Skylight
       desc          = @instrumenter.limited_description(desc)
 
       if desc == Instrumenter::TOO_MANY_UNIQUES
-        debug "[SKYLIGHT] [#{Skylight::VERSION}] A payload description produced <too many uniques>"
+        error "[SKYLIGHT] [#{Skylight::VERSION}] [E0002] You've exceeded the number of unique span descriptions per-request " \
+                  "for endpoint: #{endpoint}."
         debug "original desc=%s", original_desc
         debug "cat=%s, title=%s, desc=%s", cat, title, desc
       end
@@ -86,17 +91,17 @@ module Skylight
       start(now - gc_time, cat, title, desc)
     rescue => e
       error "failed to instrument span; msg=%s", e.message
-      @broken = true
+      broken!
       nil
     end
 
     def done(span)
       return unless span
-      return if @broken
+      return if broken?
       stop(span, Util::Clock.nanos - gc_time)
     rescue => e
       error "failed to close span; msg=%s", e.message
-      @broken = true
+      broken!
       nil
     end
 
@@ -105,6 +110,11 @@ module Skylight
       @instrumenter.current_trace = nil
     end
 
+    def broken!
+      debug "trace is broken"
+      @broken = true
+    end
+
     def traced
       time = gc_time
       now = Util::Clock.nanos
@@ -118,7 +128,7 @@ module Skylight
     end
 
     def submit
-      return if @broken
+      return if broken?
 
       t { "submitting trace" }
 
@@ -158,9 +168,22 @@ module Skylight
 
       expected = @spans.pop
       unless span == expected
-        error "invalid span nesting"
-        # TODO: Actually log span title here
-        t { "expected=#{expected}, actual=#{span}" }
+        message = "[E0001] Spans were closed out of order.\n"
+
+        if Skylight::Util::Logging.trace?
+          message << "Expected #{expected}, but received #{span}. See prior logs to match id to a name.\n" \
+                        "If the received span was a Middleware it may be one that doesn't fully conform to " \
+                        "the Rack SPEC."
+        else
+          message << "To debug this issue set `SKYLIGHT_ENABLE_TRACE_LOGS=true` " \
+                        "in your environment. (Beware, it is quite noisy!)\n"
+        end
+
+        message << "This request will not be tracked. Please contact support@skylight.io for more information."
+
+        error message
+
+        broken!
       end
 
       time = self.class.normalize_time(time)

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 description: 
 email:
 - engineering@tilde.io
@@ -189,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="