skylight 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55eaebadf3fb220c9b3dbccdfc9a7a24daff7eda6775b89e58ea5fe0e2a1ba56
-  data.tar.gz: 894eb4d03f6b66ca6301884c98f754f0d03dbdb416e40a662b34733e2c5c19f5
+  metadata.gz: ad288b69779cb31529b64adbc47d976b06f5300cbb7ff0687b94d412880311dc
+  data.tar.gz: de757d14b9080b43e2e0d139965fade57bcaabe924e975b4b46ddbe1f7907563
 SHA512:
-  metadata.gz: 9e18ee5d48433c0bdb42090e975ccffbd28b34e179a77f252048bccc27669f41b08a6648aabc55b79eac2158ee57ac74b3308f22bc8ff25e2da1d50efe552073
-  data.tar.gz: d346a3b7a24e4453324273320c8400d998302a4c658957aef9274fd40f8735c2f33f8245e6ef33ed1dbc39ac081b0fb7bee7addce81f02c4c1457257bf3cddb7
+  metadata.gz: 023eff94d6cacf557aeac45a4fee501bf90ac4595d58a671789f3bb6b4726230be6fe3b36805af173809226bbc8c1181d0c073f45d935486da818b824ae47f3f
+  data.tar.gz: 4e538a415d63cd62208c6b51ed816e0202e20b9ffc926628e631eeedd896d6dc3c95d83bfc24d1894e83664dadee68a0b80d94e49c2207c5c55b286c333b6e61

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.7.1 (October 16 2018)
+* [BUGFIX] (Backported from 2.x series) Fix issue wherein certain error-handling patterns could break the middleware probe.
+
 ## 1.7.0 (April 24, 2018)
 
 * [FEATURE] New API for loading Probes. Example: `Skylight.probe(:excon')`

data/lib/skylight/probes/middleware.rb

@@ -17,11 +17,21 @@ module Skylight
               span = Skylight.instrument(title: name, category: "#{category}")
               resp = call_without_sk(*args, &block)
 
-              Skylight::Middleware.with_after_close(resp) { trace.done(span) }
-            rescue Exception
+              proxied_response = Skylight::Middleware.with_after_close(resp) do
+                trace.done(span)
+              end
+            rescue Exception => err
               # FIXME: Log this?
-              trace.done(span)
+              trace.done(span, exception_object: err)
               raise
+            ensure
+              unless err || proxied_response
+                # If we've gotten to this point, the most likely scenario is that
+                # a throw/catch has bypassed a portion of the callstack. Since these spans would not otherwise
+                # be closed, mark them deferred to indicate that they should be implicitly closed.
+                # See Core::Trace#deferred_spans or Core::Trace#stop for more information.
+                trace.done(span, defer: true)
+              end
             end
           end
         RUBY

data/lib/skylight/trace.rb

@@ -95,9 +95,15 @@ module Skylight
       nil
     end
 
-    def done(span)
+    def done(span, meta=nil)
       return unless span
       return if broken?
+
+      if meta && meta[:defer]
+        deferred_spans[span] ||= (Util::Clock.nanos - gc_time)
+        return
+      end
+
       stop(span, Util::Clock.nanos - gc_time)
     rescue => e
       error "failed to close span; msg=%s; endpoint=%s", e.message, endpoint
@@ -105,6 +111,13 @@ module Skylight
       nil
     end
 
+    # Middleware spans that were interrupted by a throw/catch should be cached here.
+    # keys: span ids
+    # values: nsec timestamp at which the span was cached here.
+    def deferred_spans
+      @deferred_spans ||= {}
+    end
+
     def release
       return unless @instrumenter.current_trace == self
       @instrumenter.current_trace = nil
@@ -171,29 +184,43 @@ module Skylight
     def stop(span, time)
       t { "stopping span: #{span}" }
 
-      expected = @spans.pop
-      unless span == expected
-        message = "[E0001] Spans were closed out of order.\n"
+      # If `stop` is called for a span that is not the last item in the stack,
+      # check to see if the last item has been marked as deferred. If so, close
+      # that span first, then try to close the original.
+      while deferred_spans[expected = @spans.pop]
+        normalized_stop(expected, deferred_spans.delete(expected))
+      end
+
+      handle_unexpected_stop(expected, span) unless span == expected
 
-        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
+      normalized_stop(span, time)
+      nil
+    end
 
-        message << "This request will not be tracked. Please contact support@skylight.io for more information."
+    def normalized_stop(span, time)
+      time = self.class.normalize_time(time)
+      native_stop_span(span, time)
+    end
 
-        error message
+    def handle_unexpected_stop(expected, span)
+      message = "[E0001] Spans were closed out of order.\n"
 
-        broken!
+      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
 
-      time = self.class.normalize_time(time)
-      native_stop_span(span, time)
-      nil
+      message << "\nThis request will not be tracked. Please contact support@skylight.io for more information."
+
+      error message
+
+      t { "expected=#{expected}, actual=#{span}" }
+
+      broken!
     end
 
     def gc_time

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.7.0'
+  VERSION = '1.7.1'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport