skylight 5.0.0.beta2 → 5.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b77ca3f00aac3011421d279776acf31f9259debecb3319689250e49fbd3310f
-  data.tar.gz: 6cee4d4a09aa991c3e5d3cf65bc9534797f59fc8951a7d088025271068d9e9cc
+  metadata.gz: c951c13914411fa23c37504ba022bd55229c2c4c59dc4dcf0a751b24b9dad33c
+  data.tar.gz: 93734aa403e74cbcc5c7afda5473800b962a1fe4a0b06fff0cbfab2a23d7d316
 SHA512:
-  metadata.gz: 98649cab11fb628dcfdade4a7dc5507d7640f5f90b6aa9230305fc1c5261d5f73ff3014bc399595f4bc6c85fafb334668f1b81e9020ea5e1f644f3e60ad966d7
-  data.tar.gz: edfacb9d5322768a0dbdd9acbdd31ea5305a077dee1a24076078c448c73a9cd7b0b1889ead269db9e661ed49d11e02e2da38326bad90448b12db72718b949a81
+  metadata.gz: 7901ffd7e863387424ab384d8276472a6d2c3dfabef2075cb859db8e1ff8f81643cce80f2ac9ffba1f3cb1c27d06338a6b6477347f7e7db58745d9ede000a78b
+  data.tar.gz: a404ebc97ac20f763f21df54e444e0abf72b4ad442bb39efca1c6b19a408f0d8edab2021032237aac044cb39c333815ed101ad6015fdd4246d3a66932cd9b7e9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 5.0.0.beta3
+* [IMPROVEMENT] Optimizations for the Source Locations extension
+* [FEATURE] Configuration for the Source Locations caches via `SYLIGHT_SOURCE_LOCATION_CACHE_SIZE`
+* [BUGFIX] Fix issue with missing metadata in MongoDB probe
+* [BUGFIX] Resolve an inability to parse certain SQL queries containing arrays
+
 ## 5.0.0.beta2
 * [FEATURE] Source Locations detection and reporting is now enabled by default (can be disabled with `SKYLIGHT_ENABLE_SOURCE_LOCATIONS=false`)
 * [BREAKING] Rename `environment` keyword argument to `priority_key`. Note `env` has not changed.

data/ext/libskylight.yml

@@ -1,6 +1,6 @@
-version: "5.0.0-45b02dd"
+version: "5.0.0-7111415"
 checksums:
-  x86-linux:         "218a51683cbe3f6e7f1d31097a7e732c6bac3e3780a707312f8441dd45d8f3a6"
-  x86_64-linux:      "2426968fef8cd7fe0fd0ea582fd8098db78025ce936bac9d72b7753995bd1ea9"
-  x86_64-linux-musl: "ca07748d43fac0b4a05b38b5ce0fc4cb7e43469a183919c5d9980a8b2e0b01ab"
-  x86_64-darwin:     "8b19eb2ffd19f78ee6e547b37fcf5cad2e49aa9a8bc2b9615a791ccfc91c2552"
+  x86-linux:         "c304b73401b82adcbede23886168ca3487ca5901ebeddd6377d8ce758bf9d72d"
+  x86_64-linux:      "4005f06b71295c77dccc7369f313452c7a26fe4c8de1108988e4d06d8f5fb36e"
+  x86_64-linux-musl: "0b8c582f99cc65ef466a506b9f589d634c8b502d4de5991c80c38e9efa812909"
+  x86_64-darwin:     "efbd36e1cbea562ca9b76342cc3e938a6c0c506e7e7e1c0daaafff71da68364e"

data/lib/skylight.rb

@@ -101,7 +101,7 @@ module Skylight
                           message: e.message, klass: e.class)]
         end
 
-      if config&.respond_to?("log_#{level}") && config&.respond_to?(:log_trace)
+      if config.respond_to?("log_#{level}") && config.respond_to?(:log_trace)
         config.send("log_#{level}", message)
         config.log_trace e.backtrace.join("\n")
       else
@@ -194,10 +194,17 @@ module Skylight
         opts        = {}
       end
 
+      # NOTE: unless we have `:internal` (indicating a built-in Skylight instrument block),
+      # or we already have a `source_file` or `source_line` (probably set by `instrument_method`),
+      # we set the caller location to the second item on the stack
+      # (immediate caller of the `instrument` method).
+      unless opts[:source_file] || opts[:source_line] || opts[:internal]
+        opts = opts.merge(sk_instrument_location: caller_locations(1..1).first)
+      end
+
       meta ||= {}
 
       instrumenter.extensions.process_instrument_options(opts, meta)
-
       instrumenter.instrument(category, title, desc, meta, &block)
     end
 

data/lib/skylight/config.rb

@@ -110,7 +110,8 @@ module Skylight
       -"HEROKU_DYNO_INFO_PATH"        => :'heroku.dyno_info_path',
 
       # == Source Location ==
-      -"SOURCE_LOCATION_IGNORED_GEMS" => :source_location_ignored_gems
+      -"SOURCE_LOCATION_IGNORED_GEMS" => :source_location_ignored_gems,
+      -"SOURCE_LOCATION_CACHE_SIZE"   => :source_location_cache_size
     }.freeze
 
     KEY_TO_NATIVE_ENV = {
@@ -551,7 +552,7 @@ module Skylight
           when /^warn$/i  then Logger::WARN
           when /^error$/i then Logger::ERROR
           when /^fatal$/i then Logger::FATAL
-          else Logger::ERROR
+          else Logger::ERROR # rubocop:disable Lint/DuplicateBranch
           end
         end
     end

data/lib/skylight/errors.rb

@@ -13,10 +13,10 @@ module Skylight
       end
 
       Skylight.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        class #{name}Error < NativeError
-          def self.code; #{code}; end
-          def self.message; #{message.to_json}; end
-        end
+        class #{name}Error < NativeError            # class SqlLexError < NativeError
+          def self.code; #{code}; end               #   def self.code; 4; end
+          def self.message; #{message.to_json}; end #   def self.message; "Failed to lex SQL query."; end
+        end                                         # end
       RUBY
 
       klass = Skylight.const_get("#{name}Error")

data/lib/skylight/extensions/source_location.rb

@@ -11,11 +11,13 @@ module Skylight
       include Util::Logging
 
       META_KEYS = %i[source_location source_file source_line].freeze
+      MAX_CALLER_DEPTH = 75
 
       def initialize(*)
         super
-        @caller_cache = Util::LruCache.new(100)
-        @instance_method_source_location_cache = Util::LruCache.new(100)
+        cache_size = (config[:source_location_cache_size] || 1000).to_i
+        @caller_cache = Util::LruCache.new(cache_size)
+        @instance_method_source_location_cache = Util::LruCache.new(cache_size)
         gem_require_trie # memoize this at startup
       end
 
@@ -35,6 +37,7 @@ module Skylight
         source_line = opts[:source_line] || opts[:meta]&.[](:source_line)
         source_name_hint, const_name, method_name = opts[:source_location_hint] ||
                                                     opts[:meta]&.[](:source_location_hint)
+        instrument_location = opts[:sk_instrument_location]
 
         if source_location
           meta[:source_location] = source_location
@@ -45,6 +48,9 @@ module Skylight
         elsif source_file
           meta[:source_file] = source_file
           meta[:source_line] = source_line
+        elsif instrument_location && project_path?(instrument_location.absolute_path)
+          meta[:source_file] = instrument_location.absolute_path
+          meta[:source_line] = instrument_location.lineno
         else
           warn "Ignoring source_line without source_file" if source_line
           if (location = find_caller(cache_key: opts.hash))
@@ -134,10 +140,14 @@ module Skylight
         end
 
         def find_caller(cache_key: nil)
+          # starting at 4 to skip Skylight extension processing logic
+          locations = ::Kernel.caller_locations(4..MAX_CALLER_DEPTH)
+
           if cache_key
-            @caller_cache.fetch(cache_key) { find_caller_inner }
+            localized_cache_key = [cache_key, locations.map(&:lineno)].hash
+            @caller_cache.fetch(localized_cache_key) { find_caller_inner(locations) }
           else
-            find_caller_inner
+            find_caller_inner(locations)
           end
         end
 
@@ -236,11 +246,12 @@ module Skylight
           nil
         end
 
-        def find_caller_inner
+        def find_caller_inner(locations)
           # Start at file before this one
           # NOTE: We could start farther back now to avoid more Skylight files
-          caller_locations(1).find do |l|
-            find_source_gem(l.absolute_path) || project_path?(l.absolute_path)
+          locations.find do |l|
+            absolute_path = l.absolute_path
+            find_source_gem(absolute_path) || project_path?(absolute_path)
           end
         end
 

data/lib/skylight/formatters/http.rb

@@ -12,7 +12,8 @@ module Skylight
       # @return [Hash] a hash containing `:category`, `:title`, and `:annotations`
       def self.build_opts(method, _scheme, host, _port, _path, _query)
         { category: "api.http.#{method.downcase}",
-          title:    "#{method.upcase} #{host}" }
+          title:    "#{method.upcase} #{host}",
+          internal: true }
       end
     end
   end

data/lib/skylight/helpers.rb

@@ -124,6 +124,8 @@ module Skylight
       #       instrument_class_method :my_method, title: 'Expensive work'
       #     end
       def instrument_class_method(name, opts = {})
+        # NOTE: If the class is defined anonymously and then assigned to a variable this code
+        #   will not be aware of the updated name.
         title = "#{self}.#{name}"
         __sk_instrument_method_on(__sk_singleton_class, name, title, opts || {})
       end
@@ -144,32 +146,32 @@ module Skylight
           source_file, source_line = klass.instance_method(name).source_location
 
           klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            alias_method :"before_instrument_#{name}", :"#{name}"
-
-            def #{name}(*args, &blk)
-              span = Skylight.instrument(
-                category:    :"#{category}",
-                title:       #{title.inspect},
-                description: #{desc.inspect},
-                source_file: #{source_file.inspect},
-                source_line: #{source_line.inspect})
-
-              meta = {}
-              begin
-                send(:before_instrument_#{name}, *args, &blk)
-              rescue Exception => e
-                meta[:exception_object] = e
-                raise e
-              ensure
-                Skylight.done(span, meta) if span
-              end
-            end
-
-            if protected_method_defined?(:"before_instrument_#{name}")
-              protected :"#{name}"
-            elsif private_method_defined?(:"before_instrument_#{name}")
-              private :"#{name}"
-            end
+            alias_method :"before_instrument_#{name}", :"#{name}"       # alias_method :"before_instrument_process", :"process"
+                                                                        #
+            def #{name}(*args, &blk)                                    # def process(*args, &blk)
+              span = Skylight.instrument(                               #   span = Skylight.instrument(
+                category:    :"#{category}",                            #     category:    :"app.method",
+                title:       #{title.inspect},                          #     title:       "process",
+                description: #{desc.inspect},                           #     description: "Process data",
+                source_file: #{source_file.inspect},                    #     source_file: "myapp/lib/processor.rb",
+                source_line: #{source_line.inspect})                    #     source_line: 123)
+                                                                        #
+              meta = {}                                                 #   meta = {}
+              begin                                                     #   begin
+                send(:before_instrument_#{name}, *args, &blk)           #     send(:before_instrument_process)
+              rescue Exception => e                                     #   rescue Exception => e
+                meta[:exception_object] = e                             #     meta[:exception_object] = e
+                raise e                                                 #     raise e
+              ensure                                                    #   ensure
+                Skylight.done(span, meta) if span                       #     Skylight.done(span, meta) if span
+              end                                                       #   end
+            end                                                         # end
+                                                                        #
+            if protected_method_defined?(:"before_instrument_#{name}")  # if protected_method_defined?(:"before_instrument_process")
+              protected :"#{name}"                                      #   protected :"process"
+            elsif private_method_defined?(:"before_instrument_#{name}") # elsif private_method_defined?(:"before_instrument_process")
+              private :"#{name}"                                        #   private :"process"
+            end                                                         # end
           RUBY
         end
 

data/lib/skylight/middleware.rb

@@ -10,7 +10,7 @@ module Skylight
         @closed = false
       end
 
-      def respond_to_missing?(name, include_all = false) # rubocop:disable Lint/MissingSuper, Style/OptionalBooleanParameter
+      def respond_to_missing?(name, include_all = false) # rubocop:disable Lint/MissingSuper
         return false if name.to_s !~ /^to_ary$/
 
         @body.respond_to?(name, include_all)

data/lib/skylight/native.rb

@@ -101,7 +101,7 @@ module Skylight
 
   # @api private
   def self.check_install_errors(config)
-    # Note: An unsupported arch doesn't count as an error.
+    # NOTE: An unsupported arch doesn't count as an error.
     install_log = File.expand_path("../../ext/install.log", __dir__)
 
     if File.exist?(install_log) && File.read(install_log) =~ /ERROR/

data/lib/skylight/normalizers.rb

@@ -69,7 +69,8 @@ module Skylight
         return cat if cat == :skip
 
         meta ||= {}
-        process_meta(trace, name, payload, meta, cache_key: ret.hash)
+        cache_key = ret.hash
+        process_meta(trace, name, payload, meta, cache_key: cache_key)
 
         [cat, title, desc, meta]
       end

data/lib/skylight/probes/active_job_enqueue.rb

@@ -18,7 +18,13 @@ module Skylight
           rescue
             block.call
           else
-            Skylight.instrument(title: "Enqueue #{name}", category: CAT, description: desc, &block)
+            Skylight.instrument(
+              title:       "Enqueue #{name}",
+              category:    CAT,
+              description: desc,
+              internal:    true,
+              &block
+            )
           end
 
           self.class.instance_eval do

data/lib/skylight/probes/delayed_job.rb

@@ -85,7 +85,8 @@ module Skylight
           opts = {
             category: "app.delayed_job.job",
             title:    format_source(*source_meta),
-            meta:     { source_location_hint: source_meta }
+            meta:     { source_location_hint: source_meta },
+            internal: true
           }
 
           Skylight.instrument(opts) { __getobj__.perform }

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

@@ -6,7 +6,7 @@ module Skylight
       # Middleware for Excon that instruments requests
       class Middleware < ::Excon::Middleware::Base
         def initialize(*)
-          @requests = {}
+          @requests = {}.compare_by_identity
           super
         end
 
@@ -38,19 +38,19 @@ module Skylight
             scheme = datum[:scheme]
             host   = datum[:host]
             # TODO: Maybe don't show other default ports like 443
-            port   = datum[:port] != 80 ? datum[:port] : nil
+            port   = datum[:port] == 80 ? nil : datum[:port]
             path   = datum[:path]
             query  = datum[:query]
 
             opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
 
-            @requests[datum.object_id] = Skylight.instrument(opts)
+            @requests[datum] = Skylight.instrument(opts)
           rescue Exception => e
             Skylight.error "failed to begin instrumentation for Excon; msg=%s", e.message
           end
 
           def end_instrumentation(datum)
-            if (request = @requests.delete(datum.object_id))
+            if (request = @requests.delete(datum))
               meta = {}
               if datum[:error].is_a?(Exception)
                 meta[:exception_object] = datum[:error]

data/lib/skylight/probes/mongo.rb

@@ -113,7 +113,8 @@ module Skylight
               category:    CAT,
               title:       title,
               description: payload.empty? ? nil : payload.to_json,
-              meta:        { database: event.database_name }
+              meta:        { database: event.database_name },
+              internal:    true
             }
 
             @events[event.operation_id] = Skylight.instrument(opts)

data/lib/skylight/probes/redis.rb

@@ -6,12 +6,14 @@ module Skylight
 
       PIPELINED_OPTS = {
         category: "db.redis.pipelined".freeze,
-        title:    "PIPELINE".freeze
+        title:    "PIPELINE".freeze,
+        internal: true
       }.freeze
 
       MULTI_OPTS = {
         category: "db.redis.multi".freeze,
-        title:    "MULTI".freeze
+        title:    "MULTI".freeze,
+        internal: true
       }.freeze
 
       module ClientInstrumentation
@@ -22,7 +24,8 @@ module Skylight
 
           opts = {
             category: "db.redis.command",
-            title:    command_name.upcase.to_s
+            title:    command_name.upcase.to_s,
+            internal: true
           }
 
           Skylight.instrument(opts) { super }

data/lib/skylight/trace.rb

@@ -6,7 +6,7 @@ module Skylight
     GC_CAT = "noise.gc".freeze
     SYNTHETIC = "<synthetic>".freeze
 
-    META_KEYS = %i[mute_children].freeze
+    META_KEYS = %i[mute_children database].freeze
 
     include Util::Logging
 
@@ -340,8 +340,10 @@ module Skylight
       def validate_meta(meta)
         unknown_keys = meta.keys - allowed_meta_keys
         if unknown_keys.any?
-          warn "Unknown meta keys will be ignored; keys=#{unknown_keys.inspect}"
-          unknown_keys.each { |key| meta.delete(key) }
+          unknown_keys.each do |key|
+            maybe_warn("unknown_meta:#{key}", "Unknown meta key will be ignored; key=#{key.inspect}")
+            meta.delete(key)
+          end
         end
       end
 

data/lib/skylight/util/http.rb

@@ -192,7 +192,7 @@ module Skylight
             body.dig(*key.split(".")) if body.is_a?(Hash)
           end
 
-          def respond_to_missing?(name, include_all = false) # rubocop:disable Style/OptionalBooleanParameter
+          def respond_to_missing?(name, include_all = false)
             super || body.respond_to?(name, include_all)
           end
 

data/lib/skylight/util/instrumenter_method.rb

@@ -4,20 +4,20 @@ module Skylight
       def instrumenter_method(name, block: false)
         if block
           module_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{name}(*args)
-              unless instrumenter
-                return yield if block_given?
-                return
-              end
-
-              instrumenter.#{name}(*args) { yield }
-            end
+            def #{name}(*args)                      # def mute(*args)
+              unless instrumenter                   #   unless instrumenter
+                return yield if block_given?        #     return yield if block_given?
+                return                              #     return
+              end                                   #   end
+                                                    #
+              instrumenter.#{name}(*args) { yield } #   instrumenter.mute(*args) { yield }
+            end                                     # end
           RUBY
         else
           module_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{name}(*args)
-              instrumenter&.#{name}(*args)
-            end
+            def #{name}(*args)              # def config(*args)
+              instrumenter&.#{name}(*args)  #   instrumenter&.config(*args)
+            end                             # end
           RUBY
         end
       end

data/lib/skylight/util/logging.rb

@@ -13,7 +13,7 @@ module Skylight
 
         # Try to avoid writing to STDOUT/STDERR twice
         logger_logdev = @logger.instance_variable_get(:@logdev)
-        logger_out = logger_logdev&.respond_to?(:dev) ? logger_logdev.dev : nil
+        logger_out = logger_logdev.respond_to?(:dev) ? logger_logdev.dev : nil
         if logger_out != $stdout && logger_out != $stderr
           @logger.<<(*args)
         end
@@ -114,10 +114,10 @@ module Skylight
 
         if logger
           if logger.respond_to?(level)
-            if !args.empty?
-              logger.send level, format(msg, *args)
-            else
+            if args.empty?
               logger.send level, msg
+            else
+              logger.send level, format(msg, *args)
             end
             return # rubocop:disable Style/RedundantReturn
           else

data/lib/skylight/util/platform.rb

@@ -56,7 +56,7 @@ module Skylight
           "so"
         when /windows|cygwin/
           "dll"
-        else
+        else # rubocop:disable Lint/DuplicateBranch
           "so"
         end
 

data/lib/skylight/version.rb

@@ -3,5 +3,5 @@ module Skylight
   # for compatibility with semver when it is parsed by the rust agent.
   # This string will be transformed in the gemspec to "5.0.0.alpha"
   # to conform with rubygems.
-  VERSION = "5.0.0-beta2".freeze
+  VERSION = "5.0.0-beta3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta2
+  version: 5.0.0.beta3
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -367,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Skylight is a smart profiler for Rails, Sinatra, and other Ruby apps.