skylight-core 3.1.5 → 4.0.0.alpha

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

@@ -4,32 +4,26 @@ module Skylight::Core
       class Probe
         def install
           ::ActionView::TemplateRenderer.class_eval do
-            alias render_with_layout_without_sk render_with_layout
-
-            def render_with_layout(*args, &block) #:nodoc:
-              path, locals = case args.length
-                             when 2
-                               args
-                             when 4
-                               [args[1], args[3]]
-                             end
+            alias_method :render_with_layout_without_sk, :render_with_layout
 
+            def render_with_layout(path, locals, *args, &block) #:nodoc:
               layout = nil
 
               if path
-                if ::ActionView::VERSION::MAJOR >= 5
-                  layout = find_layout(path, locals.keys, [formats.first])
-                else
-                  layout = find_layout(path, locals.keys)
-                end
+                layout =
+                  if ::ActionView.gem_version >= Gem::Version.new("5.x")
+                    find_layout(path, locals.keys, [formats.first])
+                  else
+                    find_layout(path, locals.keys)
+                  end
               end
 
               if layout
-                instrument(:template, :identifier => layout.identifier) do
-                  render_with_layout_without_sk(*args, &block)
+                instrument(:template, identifier: layout.identifier) do
+                  render_with_layout_without_sk(path, locals, *args, &block)
                 end
               else
-                render_with_layout_without_sk(*args, &block)
+                render_with_layout_without_sk(path, locals, *args, &block)
               end
             end
           end

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

@@ -2,15 +2,19 @@ module Skylight::Core
   module Probes
     module ActiveJob
       class Probe
-        TITLE = 'ActiveJob.execute'.freeze
-
         def install
           ::ActiveJob::Base.instance_eval do
             alias execute_without_sk execute
 
             def execute(*args)
-              Skylight.trace(TITLE, 'app.job.execute') do
-                execute_without_sk(*args)
+              Skylight.trace("ActiveJob.execute", "app.job.execute") do |trace|
+                # See normalizers/active_job/perform for endpoint/segment assignment
+                begin
+                  execute_without_sk(*args)
+                rescue Exception
+                  trace.segment = "error" if trace
+                  raise
+                end
               end
             end
           end

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

@@ -21,14 +21,14 @@ module Skylight::Core
           end
 
           self.class.instance_eval do
-            if ::ActiveJob.gem_version >= Gem::Version.new('5.2')
+            if ::ActiveJob.gem_version >= Gem::Version.new("5.2")
               def normalize_adapter_name(job_class)
                 job_class.queue_adapter_name
               end
             else
               def normalize_adapter_name(job_class)
                 adapter_class = job_class.queue_adapter.is_a?(Class) ? job_class.queue_adapter : job_class.queue_adapter.class
-                adapter_class.name.demodulize.remove('Adapter').underscore
+                adapter_class.name.demodulize.remove("Adapter").underscore
               end
             end
           end

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

@@ -6,15 +6,17 @@ module Skylight::Core
           version = nil
 
           # File moved location between version
-          %w(serializer serializers).each do |dir|
+          %w[serializer serializers].each do |dir|
+            # rubocop:disable Lint/HandleExceptions
             begin
               require "active_model/#{dir}/version"
             rescue LoadError
             end
+            # rubocop:enable Lint/HandleExceptions
           end
 
-          if Gem.loaded_specs['active_model_serializers']
-            version = Gem.loaded_specs['active_model_serializers'].version
+          if Gem.loaded_specs["active_model_serializers"]
+            version = Gem.loaded_specs["active_model_serializers"].version
           end
 
           if !version || version < Gem::Version.new("0.5.0")
@@ -36,16 +38,15 @@ module Skylight::Core
 
           [::ActiveModel::Serializer, ::ActiveModel::ArraySerializer].each do |klass|
             klass.class_eval do
-              alias as_json_without_sk as_json
+              alias_method :as_json_without_sk, :as_json
               def as_json(*args)
                 payload = { serializer: self.class }
-                ActiveSupport::Notifications.instrument('render.active_model_serializers', payload) do
+                ActiveSupport::Notifications.instrument("render.active_model_serializers", payload) do
                   as_json_without_sk(*args)
                 end
               end
             end
           end
-
         end
       end
     end

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

@@ -0,0 +1,46 @@
+module Skylight::Core
+  module Probes
+    module DelayedJob
+      class Probe
+        def install
+          return unless validate_version
+          ::Delayed::Worker.class_eval do
+            include Skylight::Core::Util::Logging
+            alias_method :run_without_sk, :run
+            alias_method :handle_failed_job_without_sk, :handle_failed_job
+
+            def run(job, *args)
+              t { "Delayed::Job beginning trace" }
+              Skylight.trace(job.name, "app.delayed_job.worker", "Delayed::Worker#run", segment: job.queue) do
+                run_without_sk(job, *args)
+              end
+            end
+
+            def handle_failed_job(job, error, *args)
+              handle_failed_job_without_sk(job, error, *args)
+              return unless Skylight.trace
+              Skylight.trace.segment = "error"
+            end
+          end
+        end
+
+        private
+
+          def validate_version
+            spec = Gem.loaded_specs["delayed_job"]
+            version = spec && spec.version
+
+            if !version || version < Gem::Version.new("4.0.0")
+              $stderr.puts "[SKYLIGHT::CORE] [#{Skylight::Core::VERSION}] The installed version of DelayedJob is not supported on Skylight. Your jobs will not be tracked."
+
+              return false
+            end
+
+            true
+          end
+      end
+    end
+
+    register(:delayed_job, "Delayed::Worker", "delayed_job", DelayedJob::Probe.new)
+  end
+end

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

@@ -4,14 +4,13 @@ module Skylight::Core
       class Probe
         def install
           ::Elasticsearch::Transport::Transport::Base.class_eval do
-            alias perform_request_without_sk perform_request
+            alias_method :perform_request_without_sk, :perform_request
             def perform_request(method, path, *args, &block)
               ActiveSupport::Notifications.instrument "request.elasticsearch",
-                                                      name:   'Request',
+                                                      name:   "Request",
                                                       method: method,
                                                       path:   path do
 
-
                 # Prevent HTTP-related probes from firing
                 Skylight::Core::Normalizers::Faraday::Request.disable do
                   disable_skylight_probe(:NetHTTP) do
@@ -25,7 +24,7 @@ module Skylight::Core
 
             def disable_skylight_probe(class_name, &block)
               klass = Probes.const_get(class_name).const_get(:Probe) rescue nil
-              klass ? klass.disable(&block) : block.call
+              klass ? klass.disable(&block) : yield
             end
           end
         end

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

@@ -1,12 +1,10 @@
-require 'skylight/core/formatters/http'
+require "skylight/core/formatters/http"
 
 module Skylight::Core
   module Probes
     module Excon
-
       # Middleware for Excon that instruments requests
       class Middleware < ::Excon::Middleware::Base
-
         # This probably won't work since config isn't defined
         include Util::Logging
 
@@ -15,7 +13,7 @@ module Skylight::Core
           super
         end
 
-        # TODO:
+        # TODO: Review the following:
         # - Consider whether a LIFO queue would be sufficient
         # - Check that errors can't be called without a request
 
@@ -55,8 +53,8 @@ module Skylight::Core
           end
 
           def end_instrumentation(datum)
-            if request = @requests.delete(datum.object_id)
-              meta = { }
+            if (request = @requests.delete(datum.object_id))
+              meta = {}
               if datum[:error].is_a?(Exception)
                 meta[:exception_object] = datum[:error]
               end
@@ -65,7 +63,6 @@ module Skylight::Core
           rescue Exception => e
             error "failed to end instrumentation for Excon; msg=%s", e.message
           end
-
       end
     end
   end

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

@@ -6,7 +6,7 @@ module Skylight::Core
         def install
           if defined?(::Excon::Middleware)
             # Don't require until installation since it depends on Excon being loaded
-            require 'skylight/core/probes/excon/middleware'
+            require "skylight/core/probes/excon/middleware"
 
             idx = ::Excon.defaults[:middlewares].index(::Excon::Middleware::Instrumentor)
 
@@ -23,4 +23,4 @@ module Skylight::Core
 
     register(:excon, "Excon", "excon", Excon::Probe.new)
   end
-end
+end

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

@@ -4,7 +4,7 @@ module Skylight::Core
       class Probe
         def install
           ::Faraday::Connection.class_eval do
-            alias initialize_without_sk initialize
+            alias_method :initialize_without_sk, :initialize
 
             def initialize(*args, &block)
               initialize_without_sk(*args, &block)
@@ -13,7 +13,6 @@ module Skylight::Core
             end
           end
         end
-
       end
     end
 

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

@@ -1,4 +1,4 @@
-require 'skylight/core/formatters/http'
+require "skylight/core/formatters/http"
 
 module Skylight::Core
   module Probes
@@ -24,7 +24,7 @@ module Skylight::Core
             # on that, so this instance method override will cover both
             # `HTTPClient.get(...)` and `HTTPClient.new.get(...)`
 
-            alias do_request_without_sk do_request
+            alias_method :do_request_without_sk, :do_request
             def do_request(method, uri, query, body, header, &block)
               if Probes::HTTPClient::Probe.disabled?
                 return do_request_without_sk(method, uri, query, body, header, &block)
@@ -38,8 +38,8 @@ module Skylight::Core
             end
           end
         end
-      end # class Probe
-    end # module Probes::HTTPClient
+      end
+    end
 
     register(:httpclient, "HTTPClient", "httpclient", HTTPClient::Probe.new)
   end

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

@@ -55,7 +55,7 @@ module Skylight::Core
 
         def install
           ::ActionDispatch::MiddlewareStack::Middleware.class_eval do
-            alias build_without_sk build
+            alias_method :build_without_sk, :build
             def build(*args)
               sk_instrument_middleware(build_without_sk(*args))
             end

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

@@ -12,10 +12,10 @@ module Skylight::Core
       class Subscriber
         include Util::Logging
 
-        COMMANDS = [:insert, :find, :count, :distinct, :update, :findandmodify, :delete, :aggregate].freeze
+        COMMANDS = %i[insert find count distinct update findandmodify delete aggregate].freeze
 
         COMMAND_NAMES = {
-          findandmodify: 'findAndModify'.freeze
+          findandmodify: "findAndModify".freeze
         }.freeze
 
         def initialize
@@ -58,7 +58,7 @@ module Skylight::Core
 
             # Not sure if this will always exist
             # Delete so the description will be less redundant
-            if target = command[event.command_name]
+            if (target = command[event.command_name])
               title << " #{target}"
             end
 
@@ -66,50 +66,50 @@ module Skylight::Core
 
             # Ruby Hashes are ordered based on insertion so do the most important ones first
 
-            add_value('key'.freeze, command, payload)
-            add_bound('query'.freeze, command, payload)
-            add_bound('filter'.freeze, command, payload)
-            add_value('sort'.freeze, command, payload)
+            add_value("key".freeze, command, payload)
+            add_bound("query".freeze, command, payload)
+            add_bound("filter".freeze, command, payload)
+            add_value("sort".freeze, command, payload)
 
             if event.command_name == :findandmodify
-              add_bound('update'.freeze, command, payload)
+              add_bound("update".freeze, command, payload)
             end
 
-            add_value('remove'.freeze, command, payload)
-            add_value('new'.freeze, command, payload)
+            add_value("remove".freeze, command, payload)
+            add_value("new".freeze, command, payload)
 
-            if updates = command['updates'.freeze]
+            if (updates = command["updates".freeze])
               # AFAICT the gem generally just sends one item in the updates array
               update = updates[0]
               update_payload = {}
-              add_bound('q'.freeze, update, update_payload)
-              add_bound('u'.freeze, update, update_payload)
-              add_value('multi'.freeze, update, update_payload)
-              add_value('upsert'.freeze, update, update_payload)
+              add_bound("q".freeze, update, update_payload)
+              add_bound("u".freeze, update, update_payload)
+              add_value("multi".freeze, update, update_payload)
+              add_value("upsert".freeze, update, update_payload)
 
-              payload['updates'.freeze] = [update_payload]
+              payload["updates".freeze] = [update_payload]
 
               if updates.length > 1
-                payload['updates'.freeze] << '...'
+                payload["updates".freeze] << "..."
               end
             end
 
-            if deletes = command['deletes'.freeze]
+            if (deletes = command["deletes".freeze])
               # AFAICT the gem generally just sends one item in the updates array
               delete = deletes[0]
               delete_payload = {}
-              add_bound('q'.freeze, delete, delete_payload)
-              add_value('limit'.freeze, delete, delete_payload)
+              add_bound("q".freeze, delete, delete_payload)
+              add_value("limit".freeze, delete, delete_payload)
 
-              payload['deletes'.freeze] = [delete_payload]
+              payload["deletes".freeze] = [delete_payload]
 
               if deletes.length > 1
-                payload['deletes'.freeze] << '...'
+                payload["deletes".freeze] << "..."
               end
             end
 
-            if (pipeline = command['pipeline'.freeze])
-              payload['pipeline'.freeze] = pipeline.map { |segment| extract_binds(segment) }
+            if (pipeline = command["pipeline".freeze])
+              payload["pipeline".freeze] = pipeline.map { |segment| extract_binds(segment) }
             end
 
             # We're ignoring documents from insert because they could have completely inconsistent
@@ -128,7 +128,7 @@ module Skylight::Core
           end
 
           def end_instrumentation(event)
-            if original_event = @events.delete(event.operation_id)
+            if (original_event = @events.delete(event.operation_id))
               meta = {}
               if event.is_a?(::Mongo::Monitoring::Event::CommandFailed)
                 meta[:exception] = ["CommandFailed", event.message]
@@ -140,14 +140,14 @@ module Skylight::Core
           end
 
           def add_value(key, command, payload)
-            if command.has_key?(key)
+            if command.key?(key)
               value = command[key]
               payload[key] = value
             end
           end
 
           def add_bound(key, command, payload)
-            if value = command[key]
+            if (value = command[key])
               payload[key] = extract_binds(value)
             end
           end
@@ -155,17 +155,12 @@ module Skylight::Core
           def extract_binds(hash)
             ret = {}
 
-            hash.each do |k,v|
-              if v.is_a?(Hash)
-                ret[k] = extract_binds(v)
-              else
-                ret[k] = '?'.freeze
-              end
+            hash.each do |k, v|
+              ret[k] = v.is_a?(Hash) ? extract_binds(v) : "?".freeze
             end
 
             ret
           end
-
       end
     end
 

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

@@ -2,9 +2,8 @@ module Skylight::Core
   module Probes
     module Mongoid
       class Probe
-
         def install
-          require 'mongoid/version'
+          require "mongoid/version"
           version = Gem::Version.new(::Mongoid::VERSION)
 
           if version < Gem::Version.new("5.0")
@@ -18,4 +17,4 @@ module Skylight::Core
 
     register(:mongoid, "Mongoid", "mongoid", Mongoid::Probe.new)
   end
-end
+end

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

@@ -2,7 +2,6 @@ module Skylight::Core
   module Probes
     module Moped
       class Probe
-
         def install
           unless defined?(::Moped::Instrumentable)
             # Using $stderr here isn't great, but we don't have a logger accessible
@@ -13,27 +12,27 @@ module Skylight::Core
           end
 
           ::Moped::Instrumentable.module_eval do
-            alias instrument_without_sk instrument
+            alias_method :instrument_without_sk, :instrument
 
             def instrument(*args, &block)
               # Mongoid sets the instrumenter to AS::N
-              if instrumenter == ActiveSupport::Notifications
-                asn_block = block
-              else
-                # If the instrumenter hasn't been changed to AS::N use both
-                asn_block = Proc.new do
-                  ActiveSupport::Notifications.instrument(*args, &block)
+              asn_block =
+                if instrumenter == ActiveSupport::Notifications
+                  block
+                else
+                  # If the instrumenter hasn't been changed to AS::N use both
+                  proc do
+                    ActiveSupport::Notifications.instrument(*args, &block)
+                  end
                 end
-              end
 
               instrument_without_sk(*args, &asn_block)
             end
           end
         end
-
       end
     end
 
     register(:moped, "Moped", "moped", Moped::Probe.new)
   end
-end
+end

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

@@ -1,4 +1,4 @@
-require 'skylight/core/formatters/http'
+require "skylight/core/formatters/http"
 
 module Skylight::Core
   module Probes
@@ -20,7 +20,7 @@ module Skylight::Core
 
         def install
           Net::HTTP.class_eval do
-            alias request_without_sk request
+            alias_method :request_without_sk, :request
 
             def request(req, body = nil, &block)
               if !started? || Probes::NetHTTP::Probe.disabled?
@@ -30,11 +30,11 @@ module Skylight::Core
               method = req.method
 
               # req['host'] also includes special handling for default ports
-              host, port = req['host'] ? req['host'].split(':') : nil
+              host, port = req["host"] ? req["host"].split(":") : nil
 
               # If we're connected with a persistent socket
-              host ||= self.address
-              port ||= self.port
+              host ||= address
+              port ||= port
 
               path   = req.path
               scheme = use_ssl? ? "https" : "http"

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

@@ -13,7 +13,7 @@ module Skylight::Core
           end
 
           ::Redis::Client.class_eval do
-            alias call_without_sk call
+            alias_method :call_without_sk, :call
 
             def call(command, &block)
               command_name = command[0]
@@ -46,7 +46,7 @@ module Skylight::Core
         }.freeze
 
         ::Redis.class_eval do
-          alias pipelined_without_sk pipelined
+          alias_method :pipelined_without_sk, :pipelined
 
           def pipelined(&block)
             Skylight::Core::Fanout.instrument(PIPELINED_OPTS) do
@@ -54,8 +54,7 @@ module Skylight::Core
             end
           end
 
-
-          alias multi_without_sk multi
+          alias_method :multi_without_sk, :multi
 
           def multi(&block)
             Skylight::Core::Fanout.instrument(MULTI_OPTS) do

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

@@ -4,11 +4,11 @@ module Skylight::Core
     module Sequel
       class Probe
         def install
-          require 'sequel/database/logging'
+          require "sequel/database/logging"
 
-          method_name = ::Sequel::Database.method_defined?(:log_connection_yield) ? 'log_connection_yield' : 'log_yield'
+          method_name = ::Sequel::Database.method_defined?(:log_connection_yield) ? "log_connection_yield" : "log_yield"
 
-          ::Sequel::Database.class_eval <<-end_eval
+          ::Sequel::Database.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             alias #{method_name}_without_sk #{method_name}
 
             def #{method_name}(sql, *args, &block)
@@ -23,7 +23,7 @@ module Skylight::Core
                 end
               end
             end
-          end_eval
+          RUBY
         end
       end
     end

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

@@ -3,14 +3,14 @@ module Skylight::Core
     module Sinatra
       class Probe
         def install
-          if ::Sinatra::VERSION < '1.4.0'
+          if ::Sinatra::VERSION < "1.4.0"
             # Using $stderr here isn't great, but we don't have a logger accessible
             $stderr.puts "[SKYLIGHT::CORE] [#{Skylight::VERSION}] Sinatra must be version 1.4.0 or greater."
             return
           end
 
           class << ::Sinatra::Base
-            alias compile_without_sk! compile!
+            alias_method :compile_without_sk!, :compile!
 
             def compile!(verb, path, *args, &block)
               compile_without_sk!(verb, path, *args, &block).tap do |_, _, keys_or_wrapper, wrapper|
@@ -29,14 +29,14 @@ module Skylight::Core
           end
 
           ::Sinatra::Base.class_eval do
-            alias dispatch_without_sk! dispatch!
-            alias compile_template_without_sk compile_template
+            alias_method :dispatch_without_sk!, :dispatch!
+            alias_method :compile_template_without_sk, :compile_template
 
             def dispatch!(*args, &block)
               dispatch_without_sk!(*args, &block).tap do
                 Skylight::Core::Fanout.each_trace do |trace|
                   # Set the endpoint name to the route name
-                  route = env['sinatra.route']
+                  route = env["sinatra.route"]
                   trace.endpoint = route if route
                 end
               end
@@ -45,12 +45,7 @@ module Skylight::Core
             def compile_template(engine, data, options, *args, &block)
               # Pass along a useful "virtual path" to Tilt. The Tilt probe will handle
               # instrumenting correctly.
-              case data
-              when Symbol
-                options[:sky_virtual_path] = data.to_s
-              else
-                options[:sky_virtual_path] = "Inline template (#{engine})"
-              end
+              options[:sky_virtual_path] = data.is_a?(Symbol) ? data.to_s : "Inline template (#{engine})"
 
               compile_template_without_sk(engine, data, options, *args, &block)
             end

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

@@ -5,7 +5,7 @@ module Skylight::Core
       class Probe
         def install
           ::Tilt::Template.class_eval do
-            alias render_without_sk render
+            alias_method :render_without_sk, :render
 
             def render(*args, &block)
               opts = {