skylight-core 2.0.1 → 2.0.2.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe55886e88fc2828fad4c6565eb0c1db58d0901e751602306079fa1b42e3be43
-  data.tar.gz: d0598c4efa965eb3911c59991eca2664b53cfd0eb6e86a712ca642ca2fc24b6f
+  metadata.gz: d9ef05dea2241e0a6ec4b0d5cef5803457a80b5e40ef5d8b166640528da91555
+  data.tar.gz: fea0b9a66551b26c8d0f0cc4daf6f59ac320e80fa4b860c5d299547ac243eb1b
 SHA512:
-  metadata.gz: 3aed5c95952a9b1db5ae89e2c8085aea8bb00c614ffe9974e4f75d77a1a34c1cfa07910009c35cdaffd8ccf35ab2d3a64380acfeb26b386ec07da4f131187765
-  data.tar.gz: 6308094a1e5611924304bd14512deb40ca6d161d51ddb24c0c50e892bb1c5af0766e3542b3c54ff883f8d6692f2e92428031cd985a8430745dcd064100195f06
+  metadata.gz: dff2bc263dbdf1335e7c84123fca8814f3f32ef883420730e7a08bf3e5e8449c11470ccaf61b691829178c49dffbcc62360a8f6153c93d53232dac2906e51c45
+  data.tar.gz: 9cae9daf7ddf1302125b68ea98eacb27d34b6444e2bd8a0ac92dfdc0c34b532562f95179ea17b5394f8b6457d21f3fd2c6b5cd3ab489d6c8f1f1b542e95616c8

data/lib/skylight/core/config.rb

@@ -32,12 +32,12 @@ module Skylight::Core
 
         # == Instrumenter ==
         "ENABLE_SEGMENTS" => :enable_segments,
+        "ENABLE_SIDEKIQ" => :enable_sidekiq,
 
         # == User config settings ==
         "USER_CONFIG_PATH" => :'user_config_path',
 
         # == Heroku settings ==
-        #
         "HEROKU_DYNO_INFO_PATH" => :'heroku.dyno_info_path'
       }
     end
@@ -50,6 +50,7 @@ module Skylight::Core
         :alert_log_file       => '-'.freeze,
         :log_sql_parse_errors => true,
         :enable_segments      => true,
+        :enable_sidekiq       => false,
         :'heroku.dyno_info_path' => '/etc/heroku/dyno'
       }
     end
@@ -404,6 +405,10 @@ module Skylight::Core
       !!get(:enable_segments)
     end
 
+    def enable_sidekiq?
+      !!get(:enable_sidekiq)
+    end
+
     def user_config
       @user_config ||= UserConfig.new(self)
     end
@@ -445,6 +450,8 @@ module Skylight::Core
             when /^info$/i  then Logger::INFO
             when /^warn$/i  then Logger::WARN
             when /^error$/i then Logger::ERROR
+            when /^fatal$/i then Logger::FATAL
+            else Logger::ERROR
             end
         end
       end

data/lib/skylight/core/fanout.rb

@@ -42,7 +42,6 @@ module Skylight
       def self.broken!
         registered.each(&:broken!)
       end
-
     end
   end
 end

data/lib/skylight/core/instrumenter.rb

@@ -107,6 +107,8 @@ module Skylight::Core
       config.gc.enable
       @subscriber.register!
 
+      ActiveSupport::Notifications.instrument("started_instrumenter.skylight", instrumenter: self)
+
       self
 
     rescue Exception => e

data/lib/skylight/core/middleware.rb

@@ -124,7 +124,7 @@ module Skylight::Core
 
       def make_request_id(request_id)
         if request_id && !request_id.empty?
-          request_id.gsub(/[^\w\-]/, "".freeze).first(255)
+          request_id.gsub(/[^\w\-]/, "".freeze)[0...255]
         else
           internal_request_id
         end

data/lib/skylight/core/normalizers/active_record/sql.rb

@@ -21,7 +21,7 @@ module Skylight::Core
             meta[:adapter] = config[:adapter]
             meta[:database] = config[:database]
           rescue => e
-            warn "Unable to get ActiveRecord config; e=#{e}"
+            trace.instrumenter.warn "Unable to get ActiveRecord config; e=#{e}"
           end
 
           [name, title, description, meta]

data/lib/skylight/core/normalizers/grape/endpoint.rb

@@ -8,6 +8,8 @@ module Skylight::Core
           require "skylight/core/normalizers/grape/endpoint_#{type}"
         end
 
+        require 'skylight/core/normalizers/grape/format_response'
+
         private
 
           def get_method(endpoint)
@@ -27,4 +29,4 @@ module Skylight::Core
       end
     end
   end
-end
+end

data/lib/skylight/core/normalizers/grape/format_response.rb

@@ -0,0 +1,21 @@
+module Skylight::Core
+  module Normalizers
+    module Grape
+      class FormatResponse < Normalizer
+        register "format_response.grape"
+
+        CAT = "view.grape.format_response".freeze
+
+        def normalize(_trace, _name, payload)
+          if (formatter = payload[:formatter])
+            title = formatter.is_a?(Module) ?  formatter.to_s : formatter.class.to_s
+            [CAT, title, nil]
+          else
+            :skip
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/skylight/core/probes/middleware.rb

@@ -36,13 +36,21 @@ module Skylight::Core
                 spans = Skylight::Core::Fanout.instrument(title: name, category: "#{category}")
                 resp = call_without_sk(*args, &block)
 
-                Skylight::Core::Middleware.with_after_close(resp) do
+                proxied_response = Skylight::Core::Middleware.with_after_close(resp) do
                   Skylight::Core::Fanout.done(spans)
                 end
-              rescue Exception => e
+              rescue Exception => err
                 # FIXME: Log this?
-                Skylight::Core::Fanout.done(spans, exception_object: e)
+                Skylight::Core::Fanout.done(spans, 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.
+                  Skylight::Core::Fanout.done(spans, defer: true)
+                end
               end
             end
           RUBY

data/lib/skylight/core/probes/tilt.rb

@@ -10,7 +10,7 @@ module Skylight::Core
             def render(*args, &block)
               opts = {
                 category: "view.render.template",
-                title: options[:sky_virtual_path] || "Unknown template name"
+                title: options[:sky_virtual_path] || basename || "Unknown template name"
               }
 
               Skylight::Core::Fanout.instrument(opts) do

data/lib/skylight/core/sidekiq.rb

@@ -0,0 +1,41 @@
+module Skylight
+  module Core
+    module Sidekiq
+      def self.add_middleware(instrumentable)
+        ::Sidekiq.configure_server do |sidekiq_config|
+          instrumentable.debug "Adding Sidekiq Middleware"
+
+          sidekiq_config.server_middleware do |chain|
+            # Put it at the front
+            chain.prepend ServerMiddleware, instrumentable
+          end
+        end
+      end
+
+      class ServerMiddleware
+        include Util::Logging
+
+        def initialize(instrumentable)
+          @instrumentable = instrumentable
+        end
+
+        def call(_worker, job, queue)
+          t { "Sidekiq middleware beginning trace" }
+          job_class = job['wrapped'] || job['class']
+          title = "#{job_class}#perform"
+          segment = queue != 'default' ? "<sk-segment>#{queue}</sk-segment>" : ""
+          @instrumentable.trace("#{title}#{segment}", 'app.sidekiq.worker', title) do
+            yield
+          end
+        end
+      end
+
+      ActiveSupport::Notifications.subscribe("started_instrumenter.skylight") \
+          do |_name, _started, _finished, _unique_id, payload|
+        if payload[:instrumenter].config.enable_sidekiq?
+          add_middleware(payload[:instrumenter])
+        end
+      end
+    end
+  end
+end

data/lib/skylight/core/subscriber.rb

@@ -7,32 +7,22 @@ module Skylight::Core
 
     def initialize(config, instrumenter)
       @config       = config
-      @subscriber   = nil
       @normalizers  = Normalizers.build(config)
       @instrumenter = instrumenter
+      @subscribers  = []
     end
 
     def register!
-      unregister! if @subscriber
-      pattern = ArrayPattern.new(@normalizers.keys)
-      @subscriber = ActiveSupport::Notifications.subscribe pattern, self
+      unregister!
+      @normalizers.keys.each do |key|
+        @subscribers << ActiveSupport::Notifications.subscribe(key, self)
+      end
     end
 
     def unregister!
-      ActiveSupport::Notifications.unsubscribe @subscriber
-      @subscriber = nil
-    end
-
-    class ArrayPattern
-
-      def initialize(keys)
-        @keys = Set.new keys
+      until @subscribers.empty?
+        ActiveSupport::Notifications.unsubscribe @subscribers.shift
       end
-
-      def ===(item)
-        @keys.include?(item)
-      end
-
     end
 
     #
@@ -57,10 +47,8 @@ module Skylight::Core
 
       unless result == :skip
         case result.size
-        when 4
+        when 3, 4
           cat, title, desc, meta = result
-        when 3
-          cat, title, desc = result
         else
           raise "Invalid normalizer result: #{result.inspect}"
         end

data/lib/skylight/core/trace.rb

@@ -122,6 +122,11 @@ module Skylight::Core
 
       return if broken?
 
+      if meta && meta[:defer]
+        deferred_spans[span] ||= (Util::Clock.nanos - gc_time)
+        return
+      end
+
       if meta && (meta[:exception_object] || meta[:exception])
         native_span_set_exception(span, meta[:exception_object], meta[:exception])
       end
@@ -201,37 +206,59 @@ module Skylight::Core
       sp
     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 stop(span, time)
       t { "stopping span: #{span}" }
 
-      expected = @spans.pop
-      unless span == expected
-        message = "[E0001] Spans were closed out of order. Expected to see '#{native_span_get_title(expected)}', " \
-                    "but got '#{native_span_get_title(span)}' instead."
-
-        if native_span_get_category(span) == "rack.middleware" &&
-            Probes.installed.keys.include?("ActionDispatch::MiddlewareStack::Middleware")
-          if Probes::Middleware::Probe.disabled?
-            message << "\nWe disabled the Middleware probe but unfortunately, this didn't solve the issue."
-          else
-            Probes::Middleware::Probe.disable!
-            message << "\n#{native_span_get_title(span)} may be a Middleware that doesn't fully conform " \
-                        "to the Rack SPEC. We've disabled the Middleware probe to see if that resolves the issue."
-          end
-        end
+      # 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
 
-        message << "\nThis request will not be tracked. Please contact support@skylight.io for more information."
+      handle_unexpected_stop(expected, span) unless span == expected
 
-        error message
+      normalized_stop(span, time)
+      nil
+    end
 
-        t { "expected=#{expected}, actual=#{span}" }
+    def normalized_stop(span, time)
+      time = self.class.normalize_time(time)
+      native_stop_span(span, time)
+    end
 
-        broken!
+    # Originally extracted from `stop`.
+    # If we attempt to close spans out of order, and it appears to be a middleware issue,
+    # disable the middleware probe and mark trace as broken.
+    def handle_unexpected_stop(expected, span)
+      message = "[E0001] Spans were closed out of order. Expected to see '#{native_span_get_title(expected)}', " \
+                  "but got '#{native_span_get_title(span)}' instead."
+
+      if native_span_get_category(span) == "rack.middleware" &&
+          Probes.installed.keys.include?("ActionDispatch::MiddlewareStack::Middleware")
+        if Probes::Middleware::Probe.disabled?
+          message << "\nWe disabled the Middleware probe but unfortunately, this didn't solve the issue."
+        else
+          Probes::Middleware::Probe.disable!
+          message << "\n#{native_span_get_title(span)} may be a Middleware that doesn't fully conform " \
+                      "to the Rack SPEC. We've disabled the Middleware probe to see if that resolves the issue."
+        end
       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/core/user_config.rb

@@ -29,7 +29,7 @@ module Skylight::Core
     end
 
     def disable_dev_warning?
-      disable_dev_warning
+      disable_dev_warning || ENV['SKYLIGHT_DISABLE_DEV_WARNING'] =~ /^true$/i
     end
 
     def disable_env_warning?

data/lib/skylight/core/version.rb

@@ -1,6 +1,6 @@
 module Skylight
   module Core
-    VERSION = '2.0.1'
+    VERSION = '2.0.2.beta'
   end
 end
 

data/lib/skylight/core.rb

@@ -67,6 +67,7 @@ module Skylight
   require 'skylight/core/vm/gc'
   require 'skylight/core/util'
   require 'skylight/core/middleware'
+  require 'skylight/core/sidekiq'
   require 'skylight/core/subscriber'
   require 'skylight/core/instrumentable'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight-core
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2.beta
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,6 +184,7 @@ files:
 - lib/skylight/core/normalizers/grape/endpoint_render.rb
 - lib/skylight/core/normalizers/grape/endpoint_run.rb
 - lib/skylight/core/normalizers/grape/endpoint_run_filters.rb
+- lib/skylight/core/normalizers/grape/format_response.rb
 - lib/skylight/core/normalizers/moped/query.rb
 - lib/skylight/core/normalizers/render.rb
 - lib/skylight/core/normalizers/sequel/sql.rb
@@ -210,6 +211,7 @@ files:
 - lib/skylight/core/probes/sinatra.rb
 - lib/skylight/core/probes/tilt.rb
 - lib/skylight/core/railtie.rb
+- lib/skylight/core/sidekiq.rb
 - lib/skylight/core/subscriber.rb
 - lib/skylight/core/test.rb
 - lib/skylight/core/trace.rb
@@ -244,9 +246,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6