skylight 5.0.0.beta → 5.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7cc16a9f8a59047a74b34d19ed0f85e696e893d0f5c1c6984604a1358df6efb
-  data.tar.gz: b50cb4b7962f3b78bbccb5b3025bc051febcf6c8cd95303439add2f3df5cb75e
+  metadata.gz: 2b77ca3f00aac3011421d279776acf31f9259debecb3319689250e49fbd3310f
+  data.tar.gz: 6cee4d4a09aa991c3e5d3cf65bc9534797f59fc8951a7d088025271068d9e9cc
 SHA512:
-  metadata.gz: dc3445e94e0b3c5dc4936569df35f60b7ce9ac5f82492f92c247aca1cb44f9570092b11f532d28a6d795b39d2a65eae4bac16b5ca1a9c4e7b1ae2b47eb6c87ff
-  data.tar.gz: c591bb63cd56354d0954955f93720f1183afb0f71bd6c0fd2df7cfb8f32dab2a4988eaa20fe3018615cbb47531163b09dddd1c849f430989ffb589f98b03f7c5
+  metadata.gz: 98649cab11fb628dcfdade4a7dc5507d7640f5f90b6aa9230305fc1c5261d5f73ff3014bc399595f4bc6c85fafb334668f1b81e9020ea5e1f644f3e60ad966d7
+  data.tar.gz: edfacb9d5322768a0dbdd9acbdd31ea5305a077dee1a24076078c448c73a9cd7b0b1889ead269db9e661ed49d11e02e2da38326bad90448b12db72718b949a81

data/CHANGELOG.md

@@ -1,8 +1,14 @@
+## 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.
+* [BREAKING] Drop support for Ruby 2.4
+* [IMPROVEMENT] Improved Delayed::Job probe
+
 ## 5.0.0.beta
 * [BREAKING] Merge skylight-core into skylight. All classes previously namespaced under `Skylight::Core` have been moved to `Skylight`.
 * [BREAKING] Remove `Skylight::Util::Inflector`
 * [BREAKING] Drop support for Rails 4
-* [BREAKING] Drop support for Rails 2.3
+* [BREAKING] Drop support for Ruby 2.3
 * [IMPROVEMENT] Maintain method visibility when instrumenting with `instrument_method`
 * [IMPROVEMENT] Update probes to use `Module#prepend` where possible
 * [IMPROVEMENT] New tokio-based skylightd

data/ext/extconf.rb

@@ -42,7 +42,7 @@ SKYLIGHT_CHECKSUM = ENV["SKYLIGHT_CHECKSUM"]
 SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV["SKYLIGHT_EXT_STRICT"] =~ /^true$/i
 
 # Setup logger
-LOG = Logger.new(MultiIO.new(STDOUT, File.open(SKYLIGHT_INSTALL_LOG, "a")))
+LOG = Logger.new(MultiIO.new($stdout, File.open(SKYLIGHT_INSTALL_LOG, "a")))
 
 # Handles terminating in the case of a failure. If we have a bug, we do not
 # want to break our customer's deploy, but extconf.rb requires a Makefile to be
@@ -69,7 +69,7 @@ end
 if Platform::OS == "darwin"
   # If the user installs Xcode-only, they have to approve the
   # license or no "xc*" tool will work.
-  if `/usr/bin/xcrun clang 2>&1` =~ /license/ && !$CHILD_STATUS.success?
+  if `/usr/bin/xcrun clang 2>&1` =~ /license/ && !$CHILD_STATUS.success? # rubocop:disable Style/SoleNestedConditional
     fail <<~MESSAGE
       You have not agreed to the Xcode license and so we are unable to build the native agent.
       To resolve this, you can agree to the license by opening Xcode.app or running:

data/lib/skylight/cli/doctor.rb

@@ -85,20 +85,18 @@ module Skylight
         say "Checking for valid configuration"
 
         indent do
-          begin
-            config.validate!
-            say "Configuration is valid", :green
-          rescue ConfigError => e
-            encountered_error!
-
-            say "Configuration is invalid", :red
-            indent do
-              say e.message, :red
-              say "This may occur if you are configuring with ENV variables and didn't set them in this shell."
-            end
-
-            done!
+          config.validate!
+          say "Configuration is valid", :green
+        rescue ConfigError => e
+          encountered_error!
+
+          say "Configuration is invalid", :red
+          indent do
+            say e.message, :red
+            say "This may occur if you are configuring with ENV variables and didn't set them in this shell."
           end
+
+          done!
         end
 
         puts "\n"

data/lib/skylight/config.rb

@@ -119,9 +119,7 @@ module Skylight
       native_log_level: "LOG_LEVEL"
     }.freeze
 
-    SERVER_VALIDATE = %i[
-      enable_source_locations
-    ].freeze
+    SERVER_VALIDATE = %i[].freeze
 
     DEFAULT_IGNORED_SOURCE_LOCATION_GEMS = [
       -"skylight",
@@ -150,7 +148,7 @@ module Skylight
             enable_segments:           true,
             enable_sidekiq:            false,
             sinatra_route_prefixes:    false,
-            enable_source_locations:   false,
+            enable_source_locations:   true,
 
             # Deploys
             'heroku.dyno_info_path':   -"/etc/heroku/dyno",
@@ -243,7 +241,7 @@ module Skylight
     end
 
     # @api private
-    attr_reader :environment
+    attr_reader :priority_key
 
     # @api private
     def initialize(*args)
@@ -253,16 +251,16 @@ module Skylight
         attrs = args.pop.dup
       end
 
-      @values   = {}
+      @values = {}
       @priority = {}
-      @regexp   = nil
+      @priority_regexp = nil
       @alert_logger = nil
       @logger = nil
 
       p = attrs.delete(:priority)
 
-      if (@environment = args[0])
-        @regexp = /^#{Regexp.escape(@environment)}\.(.+)$/
+      if (@priority_key = args[0])
+        @priority_regexp = /^#{Regexp.escape(priority_key)}\.(.+)$/
       end
 
       attrs.each do |k, v|
@@ -277,7 +275,8 @@ module Skylight
     def self.load(opts = {}, env = ENV)
       attrs = {}
       path = opts.delete(:file)
-      environment = opts.delete(:environment)
+      priority_key = opts.delete(:priority_key)
+      priority_key ||= opts[:env] # if a priority_key is not given, use env if available
 
       if path
         error = nil
@@ -295,11 +294,14 @@ module Skylight
         raise ConfigError, "could not load config file; msg=#{error}" if error
       end
 
+      # The key-value pairs in this `priority` option are inserted into the
+      # config's @priority hash *after* anything listed under priority_key;
+      # i.e., ENV takes precendence over priority_key
       if env
         attrs[:priority] = remap_env(env)
       end
 
-      config = new(environment, attrs)
+      config = new(priority_key, attrs)
 
       opts.each do |k, v|
         config[k] = v
@@ -439,7 +441,7 @@ module Skylight
           end
         end
 
-        if @regexp && k =~ @regexp
+        if @priority_regexp && k =~ @priority_regexp
           @priority[$1.to_sym] = val
         end
 
@@ -586,7 +588,7 @@ module Skylight
       end
     end
 
-    attr_writer :logger
+    attr_writer :logger, :alert_logger
 
     def alert_logger
       @alert_logger ||= MUTEX.synchronize do
@@ -601,8 +603,6 @@ module Skylight
       end
     end
 
-    attr_writer :alert_logger
-
     def enable_segments?
       !!get(:enable_segments)
     end
@@ -638,13 +638,13 @@ module Skylight
 
         Logger.new(out, progname: "Skylight", level: level)
       rescue
-        Logger.new(STDOUT, progname: "Skylight", level: level)
+        Logger.new($stdout, progname: "Skylight", level: level)
       end
 
       def load_logger
         unless (l = @logger)
           out = get(:log_file)
-          out = STDOUT if out == "-"
+          out = $stdout if out == "-"
           l = create_logger(out, level: log_level)
         end
 
@@ -700,7 +700,7 @@ module Skylight
 
             # This is a weird way to handle priorities
             # See https://github.com/tildeio/direwolf-agent/issues/275
-            k = "#{environment}.#{k}" if environment
+            k = "#{priority_key}.#{k}" if priority_key
 
             set(k, v)
           end

data/lib/skylight/deprecation.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require "active_support/deprecation"
 
 module Skylight
-  SKYLIGHT_GEM_ROOT = File.expand_path("../..", __dir__) + "/"
+  SKYLIGHT_GEM_ROOT = "#{File.expand_path('../..', __dir__)}/"
 
   class Deprecation < ActiveSupport::Deprecation
     private

data/lib/skylight/extensions.rb

@@ -32,6 +32,12 @@ module Skylight
         !!extensions.detect { |x| x.is_a?(ext_class) }
       end
 
+      def process_trace_meta(meta)
+        extensions.each do |ext|
+          ext.process_trace_meta(meta)
+        end
+      end
+
       # meta is a mutable hash that will be passed to the instrumenter.
       # This method bridges Skylight.instrument and instrumenter.instrument.
       def process_instrument_options(opts, meta)
@@ -83,6 +89,8 @@ module Skylight
         @config = config
       end
 
+      def process_trace_meta(_meta); end
+
       def process_instrument_options(_opts, _meta); end
 
       def process_normalizer_meta(_payload, _meta, **opts); end

data/lib/skylight/extensions/source_location.rb

@@ -19,13 +19,29 @@ module Skylight
         gem_require_trie # memoize this at startup
       end
 
+      def process_trace_meta(meta)
+        unless meta[:source_location] || meta[:source_file]
+          warn "Ignoring source_line without source_file" if meta[:source_line]
+          if (location = find_caller)
+            meta[:source_file] = location.absolute_path
+            meta[:source_line] = location.lineno
+          end
+        end
+      end
+
       def process_instrument_options(opts, meta)
         source_location = opts[:source_location] || opts[:meta]&.[](:source_location)
         source_file = opts[:source_file] || opts[:meta]&.[](:source_file)
         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)
 
         if source_location
           meta[:source_location] = source_location
+        elsif source_name_hint
+          source_location = dispatch_hinted_source_location(source_name_hint, const_name, method_name)
+          meta[:source_file], meta[:source_line] = source_location
+          meta.delete(:source_location_hint) if source_location
         elsif source_file
           meta[:source_file] = source_file
           meta[:source_line] = source_line
@@ -41,14 +57,21 @@ module Skylight
       end
 
       def process_normalizer_meta(payload, meta, **opts)
-        sl = if ((source_name, *args) = opts[:source_location])
-               dispatch_hinted_source_location(
-                 source_name,
-                 payload,
-                 meta,
-                 args: args, **opts
-               )
-             end
+        if opts[:source_location] && (opts[:source_file] || opts[:source_line])
+          warn "Found both source_location and source_file or source_line in normalizer\n" \
+              "  location=#{opts[:source_location]}; file=#{opts[:source_file]}; line=#{opts[:source_line]}"
+        end
+
+        sl =
+          if (source_name, constant_name, method_name = opts[:source_location_hint])
+            dispatch_hinted_source_location(
+              source_name,
+              constant_name,
+              method_name
+            )
+          elsif opts[:source_file]
+            [opts[:source_file], opts[:source_line]]
+          end
 
         sl ||= source_location(payload, meta, cache_key: opts[:cache_key])
 
@@ -91,86 +114,88 @@ module Skylight
 
       protected
 
-      def dispatch_hinted_source_location(source_name, payload, meta, args:, **opts)
-        const_name, method_name = args
-        return unless const_name && method_name
+        def dispatch_hinted_source_location(source_name, const_name, method_name)
+          return unless const_name && method_name
 
-        instance_method_source_location(const_name, method_name, source_name: source_name)
-      end
+          instance_method_source_location(const_name, method_name, source_name: source_name)
+        end
 
-      # from normalizers.rb
-      # Returns an array of file and line
-      def source_location(payload, meta, cache_key: nil)
-        # FIXME: what should precedence be?
-        if meta.is_a?(Hash) && meta[:source_location]
-          meta.delete(:source_location)
-        elsif payload.is_a?(Hash) && payload[:sk_source_location]
-          payload[:sk_source_location]
-        elsif (location = find_caller(cache_key: cache_key))
-          [location.absolute_path, location.lineno]
+        # from normalizers.rb
+        # Returns an array of file and line
+        def source_location(payload, meta, cache_key: nil)
+          # FIXME: what should precedence be?
+          if meta.is_a?(Hash) && meta[:source_location]
+            meta.delete(:source_location)
+          elsif payload.is_a?(Hash) && payload[:sk_source_location]
+            payload[:sk_source_location]
+          elsif (location = find_caller(cache_key: cache_key))
+            [location.absolute_path, location.lineno]
+          end
         end
-      end
 
-      def find_caller(cache_key: nil)
-        if cache_key
-          @caller_cache.fetch(cache_key) { find_caller_inner }
-        else
-          find_caller_inner
+        def find_caller(cache_key: nil)
+          if cache_key
+            @caller_cache.fetch(cache_key) { find_caller_inner }
+          else
+            find_caller_inner
+          end
         end
-      end
 
-      def project_path?(path)
-        # Must be in the project root
-        return false unless path.start_with?(config.root.to_s)
-        # Must not be Bundler's vendor location
-        return false if defined?(Bundler) && path.start_with?(Bundler.bundle_path.to_s)
-        # Must not be Ruby files
-        return false if path.include?("/ruby-#{RUBY_VERSION}/lib/ruby/")
+        def project_path?(path)
+          return false unless path
 
-        # So it must be a project file
-        true
-      end
+          # Must be in the project root
+          return false unless path.start_with?(config.root.to_s)
+          # Must not be Bundler's vendor location
+          return false if defined?(Bundler) && path.start_with?(Bundler.bundle_path.to_s)
+          # Must not be Ruby files
+          return false if path.include?("/ruby-#{RUBY_VERSION}/lib/ruby/")
 
-      def instance_method_source_location(constant_name, method_name, source_name: :instance_method)
-        @instance_method_source_location_cache.fetch([constant_name, method_name, source_name]) do
-          if (constant = ::ActiveSupport::Dependencies.safe_constantize(constant_name))
-            if constant.instance_methods.include?(:"before_instrument_#{method_name}")
-              method_name = :"before_instrument_#{method_name}"
-            end
-            begin
-              unbound_method = case source_name
-                               when :instance_method
-                                 find_instance_method(constant, method_name)
-                               when :own_instance_method
-                                 find_own_instance_method(constant, method_name)
-                               when :instance_method_super
-                                 find_instance_method_super(constant, method_name)
-                               end
-
-              unbound_method&.source_location
-            rescue NameError
-              nil
+          # So it must be a project file
+          true
+        end
+
+        def instance_method_source_location(constant_name, method_name, source_name: :instance_method)
+          @instance_method_source_location_cache.fetch([constant_name, method_name, source_name]) do
+            if (constant = ::ActiveSupport::Dependencies.safe_constantize(constant_name))
+              if constant.instance_methods.include?(:"before_instrument_#{method_name}")
+                method_name = :"before_instrument_#{method_name}"
+              end
+              begin
+                unbound_method = case source_name
+                                 when :instance_method
+                                   find_instance_method(constant, method_name)
+                                 when :own_instance_method
+                                   find_own_instance_method(constant, method_name)
+                                 when :instance_method_super
+                                   find_instance_method_super(constant, method_name)
+                                 when :class_method
+                                   find_class_method(constant, method_name)
+                                 end
+
+                unbound_method&.source_location
+              rescue NameError
+                nil
+              end
             end
           end
         end
-      end
 
-      def sanitize_source_location(path, line)
-        # Do this first since gems may be vendored in the app repo. However, it might be slower.
-        # Should we cache matches?
-        if (gem_name = find_source_gem(path))
-          find_source_gem(path)
-          path = gem_name
-          line = nil
-        elsif project_path?(path)
-          # Get relative path to root
-          path = Pathname.new(path).relative_path_from(config.root).to_s
-        else
-          return
-        end
+        def sanitize_source_location(path, line)
+          # Do this first since gems may be vendored in the app repo. However, it might be slower.
+          # Should we cache matches?
+          if (gem_name = find_source_gem(path))
+            path = gem_name
+            line = nil
+          elsif project_path?(path)
+            # Get relative path to root
+            path = Pathname.new(path).relative_path_from(config.root).to_s
+          else
+            return
+          end
 
-        line ? "#{path}:#{line}" : path
-      end
+          line ? "#{path}:#{line}" : path
+        end
 
       private
 
@@ -198,11 +223,13 @@ module Skylight
         end
 
         def find_source_gem(path)
+          return nil unless path
+
           trie = gem_require_trie
 
           path.split(File::SEPARATOR).each do |segment|
             trie = trie[segment]
-            return unless trie
+            break unless trie
             return trie[:name] if trie[:name]
           end
 
@@ -211,6 +238,7 @@ module Skylight
 
         def find_caller_inner
           # 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)
           end
@@ -244,6 +272,9 @@ module Skylight
           constant.instance_method(method_name)
         end
 
+        def find_class_method(constant, method_name)
+          constant.method(method_name)
+        end
     end
   end
 end

data/lib/skylight/instrumenter.rb

@@ -60,8 +60,6 @@ module Skylight
       @trace_info = @config[:trace_info] || TraceInfo.new(KEY)
       @mutex = Mutex.new
       @extensions = Skylight::Extensions::Collection.new(@config)
-
-      enable_extension!(:source_location) if @config.enable_source_locations?
     end
 
     def enable_extension!(name)
@@ -176,6 +174,7 @@ module Skylight
         return
       end
 
+      enable_extension!(:source_location) if @config.enable_source_locations?
       config.gc.enable
       @subscriber.register!
 
@@ -202,6 +201,8 @@ module Skylight
       end
 
       begin
+        meta ||= {}
+        extensions.process_trace_meta(meta)
         trace = Trace.new(self, endpoint, Skylight::Util::Clock.nanos, cat, title, desc,
                           meta: meta, segment: segment, component: component)
       rescue Exception => e

data/lib/skylight/middleware.rb

@@ -10,10 +10,10 @@ module Skylight
         @closed = false
       end
 
-      def respond_to_missing?(*args)
-        return false if args.first.to_s !~ /^to_ary$/
+      def respond_to_missing?(name, include_all = false) # rubocop:disable Lint/MissingSuper, Style/OptionalBooleanParameter
+        return false if name.to_s !~ /^to_ary$/
 
-        @body.respond_to?(*args)
+        @body.respond_to?(name, include_all)
       end
 
       def close
@@ -117,7 +117,7 @@ module Skylight
       end
 
       def endpoint_meta(_env)
-        nil
+        { source_location: Trace::SYNTHETIC }
       end
 
       # Request ID code based on ActionDispatch::RequestId

data/lib/skylight/native_ext_fetcher.rb

@@ -23,7 +23,7 @@ module Skylight
     # @param opts [Hash]
     def self.fetch(**args)
       args[:source] ||= BASE_URL
-      args[:logger] ||= Logger.new(STDOUT)
+      args[:logger] ||= Logger.new($stdout)
       new(**args).fetch
     end
 
@@ -35,7 +35,7 @@ module Skylight
     # @param required [Boolean] whether the download is required to be successful
     # @param platform
     # @param log [Logger]
-    def initialize(source:, target:, version:, checksum:, arch:, required: false, platform: nil, logger:)
+    def initialize(source:, target:, version:, checksum:, arch:, logger:, required: false, platform: nil)
       raise "source required" unless source
       raise "target required" unless target
       raise "checksum required" unless checksum

data/lib/skylight/normalizers.rb

@@ -20,7 +20,7 @@ module Skylight
         matches = registry.select { |n, _| n =~ /(^|\.)#{name}$/ }
         raise ArgumentError, "no normalizers match #{name}" if matches.empty?
 
-        matches.values.each { |v| v[1] = enabled }
+        matches.each_value { |v| v[1] = enabled }
       end
     end
 
@@ -78,7 +78,7 @@ module Skylight
 
       private
 
-        def process_meta(trace, name, payload, meta, cache_key: nil)
+        def process_meta(trace, _name, payload, meta, cache_key: nil)
           trace.instrumenter.extensions.process_normalizer_meta(
             payload,
             meta,

data/lib/skylight/normalizers/action_controller/process_action.rb

@@ -38,7 +38,7 @@ module Skylight
 
           def process_meta_options(payload)
             # provide hints to override default source_location behavior
-            super.merge(source_location: [:instance_method, payload[:controller], payload[:action]])
+            super.merge(source_location_hint: [:instance_method, payload[:controller], payload[:action]])
           end
 
           def segment_from_payload(payload)

data/lib/skylight/normalizers/action_dispatch/route_set.rb

@@ -19,7 +19,7 @@ module Skylight
 
           def process_meta_options(_payload)
             # provide hints to override default source_location behavior
-            super.merge(source_location: [:own_instance_method, router_class_name, "call"])
+            super.merge(source_location_hint: [:own_instance_method, router_class_name, "call"])
           end
       end
     end

data/lib/skylight/normalizers/active_job/perform.rb

@@ -36,6 +36,11 @@ module Skylight
 
         private
 
+          def process_meta_options(payload)
+            # provide hints to override default source_location behavior
+            super.merge(source_location_hint: [:instance_method, payload[:job].class.to_s, "perform"])
+          end
+
           def normalize_adapter_name(adapter)
             adapter_string = adapter.is_a?(Class) ? adapter.to_s : adapter.class.to_s
             adapter_string[/ActiveJob::QueueAdapters::(\w+)Adapter/, 1].underscore

data/lib/skylight/normalizers/graphql/base.rb

@@ -24,6 +24,7 @@ module Skylight::Normalizers::GraphQL
     end
 
     def self.inherited(klass)
+      super
       klass.const_set(
         :KEY,
         ActiveSupport::Inflector.underscore(

data/lib/skylight/normalizers/render.rb

@@ -40,7 +40,7 @@ module Skylight
             # Matches a Gem Version or 12-digit hex (sha)
             # that is preceeded by a `-` and followed by `/`
             # Also matches 'app/views/' if it exists
-            %r{-(?:#{Gem::Version::VERSION_PATTERN}|[0-9a-f]{12})\/(?:app\/views\/)*},
+            %r{-(?:#{Gem::Version::VERSION_PATTERN}|[0-9a-f]{12})/(?:app/views/)*},
             ": ".freeze
           )
         else

data/lib/skylight/normalizers/sql.rb

@@ -14,7 +14,7 @@ module Skylight
       # @option payload [String] [:name] The SQL operation
       # @option payload [Hash] [:binds] The bound parameters
       # @return [Array]
-      def normalize(trace, name, payload)
+      def normalize(_trace, name, payload)
         case payload[:name]
         when "SCHEMA", "CACHE"
           return :skip
@@ -29,7 +29,8 @@ module Skylight
 
         unless sql.valid_encoding?
           if config[:log_sql_parse_errors]
-            config.logger.error "[#{Skylight::SqlLexError.formatted_code}] Unable to extract binds from non-UTF-8 query. " \
+            config.logger.error "[#{Skylight::SqlLexError.formatted_code}] Unable to extract binds from non-UTF-8 " \
+                                "query. " \
                                 "encoding=#{payload[:sql].encoding.name} " \
                                 "sql=#{payload[:sql].inspect} "
           end

data/lib/skylight/probes.rb

@@ -16,11 +16,41 @@ module Skylight
 
       def install
         probe.install
+      rescue StandardError, LoadError => e
+        log_install_exception(e)
       end
 
       def constant_available?
         Skylight::Probes.constant_available?(const_name)
       end
+
+      private
+
+        def log_install_exception(err)
+          description = err.class.to_s
+          description << ": #{err.message}" unless err.message.empty?
+
+          backtrace = err.backtrace.map { |l| "  #{l}" }.join("\n")
+
+          gems =
+            begin
+              Bundler.locked_gems.dependencies.map { |d| [d.name, d.requirement.to_s] }
+            rescue # rubocop:disable Lint/SuppressedException
+            end
+
+          error = "[SKYLIGHT] [#{Skylight::VERSION}] Encountered an error while installing the " \
+                          "probe for #{const_name}. Please notify support@skylight.io with the debugging " \
+                          "information below. It's recommended that you disable this probe until the " \
+                          "issue is resolved." \
+                          "\n\nERROR: #{description}\n\n#{backtrace}\n\n"
+
+          if gems
+            gems_string = gems.map { |g| "  #{g[0]}   #{g[1]}" }.join("\n")
+            error << "GEMS:\n\n#{gems_string}\n\n"
+          end
+
+          $stderr.puts(error)
+        end
     end
 
     class << self
@@ -99,12 +129,12 @@ module Skylight
       def require_hook(require_path)
         each_by_require_path(require_path) do |registration|
           # Double check constant is available
-          if registration.constant_available?
-            install_probe(registration)
+          next unless registration.constant_available?
 
-            # Don't need this to be called again
-            unregister_require_hook(registration)
-          end
+          install_probe(registration)
+
+          # Don't need this to be called again
+          unregister_require_hook(registration)
         end
       end
 
@@ -143,11 +173,9 @@ module Kernel
 
   def require(name)
     require_without_sk(name).tap do
-      begin
-        Skylight::Probes.require_hook(name)
-      rescue Exception => e # rubocop:disable Lint/SuppressedException
-        warn("[SKYLIGHT] Rescued exception in require hook", e)
-      end
+      Skylight::Probes.require_hook(name)
+    rescue Exception => e
+      warn("[SKYLIGHT] Rescued exception in require hook", e)
     end
   end
 end

data/lib/skylight/probes/active_job.rb

@@ -7,12 +7,10 @@ module Skylight
         def execute(*)
           Skylight.trace(TITLE, "app.job.execute", component: :worker) do |trace|
             # See normalizers/active_job/perform for endpoint/segment assignment
-            begin
-              super
-            rescue Exception
-              trace.segment = "error" if trace
-              raise
-            end
+            super
+          rescue Exception
+            trace.segment = "error" if trace
+            raise
           end
         end
       end

data/lib/skylight/probes/active_job_enqueue.rb

@@ -6,21 +6,19 @@ module Skylight
 
         def install
           ::ActiveJob::Base.around_enqueue do |job, block|
-            begin
-              job_class = job.class
-              adapter_name = EnqueueProbe.normalize_adapter_name(job_class)
+            job_class = job.class
+            adapter_name = EnqueueProbe.normalize_adapter_name(job_class)
 
-              # If this is an ActionMailer::DeliveryJob, we'll report this as the mailer title
-              # and include ActionMailer::DeliveryJob in the description.
-              name, job_class_name = Normalizers::ActiveJob::Perform.normalize_title(job)
-              descriptors = ["adapter: '#{adapter_name}'", "queue: '#{job.queue_name}'"]
-              descriptors << "job: '#{job_class_name}'" if job_class_name
-              desc = "{ #{descriptors.join(', ')} }"
-            rescue
-              block.call
-            else
-              Skylight.instrument(title: "Enqueue #{name}", category: CAT, description: desc, &block)
-            end
+            # If this is an ActionMailer::DeliveryJob, we'll report this as the mailer title
+            # and include ActionMailer::DeliveryJob in the description.
+            name, job_class_name = Normalizers::ActiveJob::Perform.normalize_title(job)
+            descriptors = ["adapter: '#{adapter_name}'", "queue: '#{job.queue_name}'"]
+            descriptors << "job: '#{job_class_name}'" if job_class_name
+            desc = "{ #{descriptors.join(', ')} }"
+          rescue
+            block.call
+          else
+            Skylight.instrument(title: "Enqueue #{name}", category: CAT, description: desc, &block)
           end
 
           self.class.instance_eval do

data/lib/skylight/probes/active_model_serializers.rb

@@ -14,12 +14,8 @@ module Skylight
 
           # File moved location between version
           %w[serializer serializers].each do |dir|
-            # rubocop:disable Lint/SuppressedException
-            begin
-              require "active_model/#{dir}/version"
-            rescue LoadError
-            end
-            # rubocop:enable Lint/SuppressedException
+            require "active_model/#{dir}/version"
+          rescue LoadError # rubocop:disable Lint/SuppressedException
           end
 
           if Gem.loaded_specs["active_model_serializers"]

data/lib/skylight/probes/delayed_job.rb

@@ -1,46 +1,132 @@
+# frozen_string_literal: true
+
+require "delegate"
+
 module Skylight
   module Probes
     module DelayedJob
-      module Instrumentation
-        include Skylight::Util::Logging
-
-        def run(job, *)
-          t { "Delayed::Job beginning trace" }
-
-          handler_name =
-            begin
-              if defined?(::Delayed::PerformableMethod) && job.payload_object.is_a?(::Delayed::PerformableMethod)
-                job.name
-              else
-                job.payload_object.class.name
-              end
-            rescue
-              UNKNOWN
+      begin
+        require "delayed/plugin"
+
+        class Plugin < ::Delayed::Plugin
+          callbacks do |lifecycle|
+            lifecycle.around(:perform) do |worker, job, &block|
+              sk_instrument(worker, job, &block)
             end
 
-          Skylight.trace(handler_name, "app.delayed_job.worker", "Delayed::Worker#run",
-                         component: :worker, segment: job.queue) { super }
+            lifecycle.after(:error) do |_worker, _job|
+              Skylight.trace&.segment = "error"
+            end
+          end
+
+          class << self
+            include Skylight::Util::Logging
+
+            def sk_instrument(_worker, job)
+              endpoint = Skylight::Probes::DelayedJob.handler_name(job)
+
+              Skylight.trace(endpoint,
+                             "app.delayed_job.worker",
+                             "Delayed::Worker#run",
+                             component: :worker,
+                             segment:   job.queue,
+                             meta:      { source_location: "delayed_job" }) do
+                               t { "Delayed::Job beginning trace" }
+                               yield
+                             end
+            end
+          end
         end
+      rescue LoadError
+        $stderr.puts "[SKYLIGHT] The delayed_job probe was requested, but Delayed::Plugin was not defined."
+      end
+
+      UNKNOWN = "<Delayed::Job Unknown>"
 
-        def handle_failed_job(*)
-          super
-          return unless Skylight.trace
+      def self.handler_name(job)
+        payload_object = if job.respond_to?(:payload_object_without_sk)
+                           job.payload_object_without_sk
+                         else
+                           job.payload_object
+                         end
+
+        payload_object_name(payload_object)
+      end
 
-          Skylight.trace.segment = "error"
+      def self.payload_object_name(payload_object)
+        if payload_object.is_a?(::Delayed::PerformableMethod)
+          payload_object.display_name
+        else
+          # In the case of ActiveJob-wrapped jobs, there is quite a bit of job-specific metadata
+          # in `job.name`, which would break aggregation and potentially leak private data in job args.
+          # Use class name instead to avoid this.
+          payload_object.class.name
         end
+      rescue
+        UNKNOWN
       end
 
-      class Probe
-        UNKNOWN = "<Delayed::Job Unknown>".freeze
+      def self.payload_object_source_meta(payload_object)
+        if payload_object.is_a?(::Delayed::PerformableMethod)
+          if payload_object.object.is_a?(Module)
+            [:class_method, payload_object.object.name, payload_object.method_name.to_s]
+          else
+            [:instance_method, payload_object.object.class.name, payload_object.method_name.to_s]
+          end
+        else
+          [:instance_method, payload_object.class.name, "perform"]
+        end
+      end
 
+      class InstrumentationProxy < SimpleDelegator
+        def perform
+          source_meta = Skylight::Probes::DelayedJob.payload_object_source_meta(__getobj__)
+
+          opts = {
+            category: "app.delayed_job.job",
+            title:    format_source(*source_meta),
+            meta:     { source_location_hint: source_meta }
+          }
+
+          Skylight.instrument(opts) { __getobj__.perform }
+        end
+
+        # Used by Delayed::Backend::Base to determine Job#name
+        def display_name
+          __getobj__.respond_to?(:display_name) ? __getobj__.display_name : __getobj__.class.name
+        end
+
+        private
+
+          def format_source(method_type, constant_name, method_name)
+            if method_type == :instance_method
+              "#{constant_name}##{method_name}"
+            else
+              "#{constant_name}.#{method_name}"
+            end
+          end
+      end
+
+      class Probe
         def install
-          return unless validate_version
+          return unless validate_version && plugin_defined?
+
+          ::Delayed::Worker.plugins = [Skylight::Probes::DelayedJob::Plugin] | ::Delayed::Worker.plugins
+          ::Delayed::Backend::Base.class_eval do
+            alias_method :payload_object_without_sk, :payload_object
 
-          ::Delayed::Worker.prepend(Instrumentation)
+            def payload_object
+              Skylight::Probes::DelayedJob::InstrumentationProxy.new(payload_object_without_sk)
+            end
+          end
         end
 
         private
 
+          def plugin_defined?
+            defined?(::Skylight::Probes::DelayedJob::Plugin)
+          end
+
           def validate_version
             spec = Gem.loaded_specs["delayed_job"]
             version = spec&.version

data/lib/skylight/probes/middleware.rb

@@ -72,7 +72,8 @@ module Skylight
 
               source_file, source_line = method(__method__).super_method.source_location
 
-              spans = Skylight.instrument(title: name, category: __sk_category, source_file: source_file, source_line: source_line)
+              spans = Skylight.instrument(title: name, category: __sk_category,
+                                          source_file: source_file, source_line: source_line)
 
               proxied_response =
                 Skylight::Middleware.with_after_close(super(*args), debug_identifier: "Middleware: #{name}") do

data/lib/skylight/probes/net_http.rb

@@ -14,7 +14,6 @@ module Skylight
 
           # If we're connected with a persistent socket
           host ||= address
-          port ||= port
 
           path   = req.path
           scheme = use_ssl? ? "https" : "http"

data/lib/skylight/railtie.rb

@@ -99,7 +99,7 @@ module Skylight
           return nil
         end
 
-        config = Config.load(file: path, environment: Rails.env.to_s)
+        config = Config.load(file: path, priority_key: Rails.env.to_s)
         config[:root] = Rails.root
 
         configure_logging(config, app)

data/lib/skylight/sidekiq.rb

@@ -19,16 +19,21 @@ module Skylight
     class ServerMiddleware
       include Util::Logging
 
-      def call(_worker, job, queue)
+      def call(worker, job, queue)
         t { "Sidekiq middleware beginning trace" }
         title = job["wrapped"] || job["class"]
-        Skylight.trace(title, "app.sidekiq.worker", title, segment: queue, component: :worker) do |trace|
-          begin
-            yield
-          rescue Exception # includes Sidekiq::Shutdown
-            trace.segment = "error" if trace
-            raise
+
+        # TODO: Using hints here would be ideal but requires further refactoring
+        meta =
+          if (source_location = worker.method(:perform).source_location)
+            { source_file: source_location[0], source_line: source_location[1] }
           end
+
+        Skylight.trace(title, "app.sidekiq.worker", title, meta: meta, segment: queue, component: :worker) do |trace|
+          yield
+        rescue Exception # includes Sidekiq::Shutdown
+          trace.segment = "error" if trace
+          raise
         end
       end
     end

data/lib/skylight/subscriber.rb

@@ -14,7 +14,7 @@ module Skylight
 
     def register!
       unregister!
-      @normalizers.keys.each do |key|
+      @normalizers.keys.each do |key| # rubocop:disable Style/HashEachMethods
         @subscribers << ActiveSupport::Notifications.subscribe(key, self)
       end
     end

data/lib/skylight/trace.rb

@@ -4,6 +4,7 @@ require "skylight/util/logging"
 module Skylight
   class Trace
     GC_CAT = "noise.gc".freeze
+    SYNTHETIC = "<synthetic>".freeze
 
     META_KEYS = %i[mute_children].freeze
 
@@ -39,6 +40,8 @@ module Skylight
 
       @spans = []
 
+      preprocess_meta(meta) if meta
+
       # create the root node
       @root = start(native_get_started_at, cat, title, desc, meta, normalize: false)
 
@@ -217,7 +220,8 @@ module Skylight
 
         if time > 0
           t { fmt "tracking GC time; duration=%d", time }
-          stop(start(now - time, GC_CAT, nil, nil, nil), now)
+          meta = { source_location: SYNTHETIC }
+          stop(start(now - time, GC_CAT, nil, nil, meta), now)
         end
       end
 

data/lib/skylight/util/deploy.rb

@@ -13,8 +13,7 @@ module Skylight
       end
 
       class EmptyDeploy
-        attr_reader :config
-        attr_reader :timestamp
+        attr_reader :config, :timestamp
 
         def initialize(config)
           @config = config
@@ -90,10 +89,8 @@ module Skylight
           def get_info
             info_path = config[:'heroku.dyno_info_path']
 
-            if File.exist?(info_path)
-              if (info = JSON.parse(File.read(info_path)))
-                info["release"]
-              end
+            if File.exist?(info_path) && (info = JSON.parse(File.read(info_path)))
+              info["release"]
             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)
+          def respond_to_missing?(name, include_all = false) # rubocop:disable Style/OptionalBooleanParameter
             super || body.respond_to?(name, include_all)
           end
 

data/lib/skylight/util/logging.rb

@@ -9,12 +9,12 @@ module Skylight
       end
 
       def write(*args)
-        STDERR.write(*args)
+        $stderr.write(*args)
 
         # 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
-        if logger_out != STDOUT && logger_out != STDERR
+        if logger_out != $stdout && logger_out != $stderr
           @logger.<<(*args)
         end
       end

data/lib/skylight/util/lru_cache.rb

@@ -11,9 +11,7 @@ module Skylight
         raise ArgumentError, :max_size if @max_size < 1
 
         @max_size = size
-        while @data.size > @max_size
-          @data.shift
-        end
+        @data.shift while @data.size > @max_size
       end
 
       # Individual hash operations here are atomic in MRI.

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-beta".freeze
+  VERSION = "5.0.0-beta2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta
+  version: 5.0.0.beta2
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -211,7 +211,6 @@ files:
 - lib/skylight/errors.rb
 - lib/skylight/extensions.rb
 - lib/skylight/extensions/source_location.rb
-- lib/skylight/fanout.rb
 - lib/skylight/formatters/http.rb
 - lib/skylight/gc.rb
 - lib/skylight/helpers.rb
@@ -361,7 +360,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"