skylight 5.0.0.beta → 5.0.0

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

@@ -14,7 +14,7 @@ module Skylight
 
         if (opts = @__sk_instrument_next_method)
           @__sk_instrument_next_method = nil
-          instrument_method(name, opts)
+          instrument_method(name, **opts)
         end
       end
 
@@ -24,7 +24,7 @@ module Skylight
 
         if (opts = @__sk_instrument_next_method)
           @__sk_instrument_next_method = nil
-          instrument_class_method(name, opts)
+          instrument_class_method(name, **opts)
         end
       end
 
@@ -77,14 +77,12 @@ module Skylight
       #         do_expensive_stuff
       #       end
       #     end
-      def instrument_method(*args)
-        opts = args.pop if args.last.is_a?(Hash)
-
+      def instrument_method(*args, **opts)
         if (name = args.pop)
           title = "#{self}##{name}"
-          __sk_instrument_method_on(self, name, title, opts || {})
+          __sk_instrument_method_on(self, name, title, **opts)
         else
-          @__sk_instrument_next_method = opts || {}
+          @__sk_instrument_next_method = opts
         end
       end
 
@@ -123,14 +121,18 @@ module Skylight
       #
       #       instrument_class_method :my_method, title: 'Expensive work'
       #     end
-      def instrument_class_method(name, opts = {})
+      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 || {})
+        __sk_instrument_method_on(__sk_singleton_class, name, title, **opts)
       end
 
       private
 
-        def __sk_instrument_method_on(klass, name, title, opts)
+        HAS_KW_ARGUMENT_FORWARDING = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
+
+        def __sk_instrument_method_on(klass, name, title, **opts)
           category = (opts[:category] || "app.method").to_s
           title    = (opts[:title] || title).to_s
           desc     = opts[:description].to_s if opts[:description]
@@ -143,33 +145,40 @@ module Skylight
           # source_file and source_line to be removed from the trace span before it is submitted.
           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
+          arg_string =
+            if HAS_KW_ARGUMENT_FORWARDING
+              "*args, **kwargs, &blk"
+            else
+              "*args, &blk"
             end
 
-            if protected_method_defined?(:"before_instrument_#{name}")
-              protected :"#{name}"
-            elsif private_method_defined?(:"before_instrument_#{name}")
-              private :"#{name}"
-            end
+          klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            alias_method :"before_instrument_#{name}", :"#{name}"       # alias_method :"before_instrument_process", :"process"
+            def #{name}(#{arg_string})                                  # def process(*args, **kwargs, &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}, #{arg_string})         #     send(:before_instrument_process, *args, **kwargs, &blk)
+              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/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)
+        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.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/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
 
@@ -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
@@ -78,7 +79,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,
@@ -144,7 +145,8 @@ module Skylight
         graphiti/resolve
         graphiti/render
         graphql/base
-        sequel/sql].each do |file|
+        sequel/sql
+        shrine].each do |file|
       require "skylight/normalizers/#{file}"
     end
   end

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/shrine.rb

@@ -0,0 +1,34 @@
+module Skylight
+  module Normalizers
+    class Shrine < Normalizer
+      TITLES = {
+        "upload.shrine"           => "Upload",
+        "download.shrine"         => "Download",
+        "open.shrine"             => "Open",
+        "exists.shrine"           => "Exists",
+        "delete.shrine"           => "Delete",
+        "metadata.shrine"         => "Metadata",
+        "mime_type.shrine"        => "MIME Type",
+        "image_dimensions.shrine" => "Image Dimensions",
+        "signature.shrine"        => "Signature",
+        "extension.shrine"        => "Extension",
+        "derivation.shrine"       => "Derivation",
+        "derivatives.shrine"      => "Derivatives",
+        "data_uri.shrine"         => "Data URI",
+        "remote_url.shrine"       => "Remote URL"
+      }.freeze
+
+      TITLES.each_key do |key|
+        register key
+      end
+
+      def normalize(_trace, name, _payload)
+        title = ["Shrine", TITLES[name]].join(" ")
+
+        cat = "app.#{name.split('.').reverse.join('.')}"
+
+        [cat, title, nil]
+      end
+    end
+  end
+end

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