skylight-core 3.1.5 → 4.0.0.alpha

data/lib/skylight/core/instrumenter.rb

@@ -1,18 +1,17 @@
-require 'thread'
-require 'strscan'
-require 'securerandom'
+require "strscan"
+require "securerandom"
 
 module Skylight::Core
   # @api private
   class Instrumenter
-    KEY  = :__skylight_current_trace
+    KEY = :__skylight_current_trace
 
-    TOO_MANY_UNIQUES = "<too many unique descriptions>"
+    TOO_MANY_UNIQUES = "<too many unique descriptions>".freeze
 
     include Util::Logging
 
     class TraceInfo
-      def initialize(key=KEY)
+      def initialize(key = KEY)
         @key = key
       end
 
@@ -50,7 +49,7 @@ module Skylight::Core
       @config = config
       @subscriber = Subscriber.new(config, self)
 
-      key = "#{KEY}_#{self.class.trace_class.name}".gsub(/\W/, '_')
+      key = "#{KEY}_#{self.class.trace_class.name}".gsub(/\W/, "_")
       @trace_info = @config[:trace_info] || TraceInfo.new(key)
     end
 
@@ -79,7 +78,7 @@ module Skylight::Core
     end
 
     def current_trace=(trace)
-      t { "setting current_trace=#{trace ? trace.uuid : "nil"}; thread=#{Thread.current.object_id}" }
+      t { "setting current_trace=#{trace ? trace.uuid : 'nil'}; thread=#{Thread.current.object_id}" }
       @trace_info.current = trace
     end
 
@@ -110,7 +109,6 @@ module Skylight::Core
       ActiveSupport::Notifications.instrument("started_instrumenter.skylight", instrumenter: self)
 
       self
-
     rescue Exception => e
       log_error "failed to start instrumenter; msg=%s; config=%s", e.message, config.inspect
       t { e.backtrace.join("\n") }
@@ -122,15 +120,15 @@ module Skylight::Core
       native_stop
     end
 
-    def trace(endpoint, cat, title=nil, desc=nil, meta=nil)
+    def trace(endpoint, cat, title = nil, desc = nil, meta = nil, segment: nil)
       # If a trace is already in progress, continue with that one
-      if trace = @trace_info.current
+      if (trace = @trace_info.current)
         return yield(trace) if block_given?
         return trace
       end
 
       begin
-        trace = self.class.trace_class.new(self, endpoint, Util::Clock.nanos, cat, title, desc, meta)
+        trace = self.class.trace_class.new(self, endpoint, Util::Clock.nanos, cat, title, desc, meta, segment: segment)
       rescue Exception => e
         log_error e.message
         t { e.backtrace.join("\n") }
@@ -142,7 +140,6 @@ module Skylight::Core
 
       begin
         yield trace
-
       ensure
         @trace_info.current = nil
         t { "instrumenter submitting trace; trace=#{trace.uuid}" }
@@ -162,7 +159,7 @@ module Skylight::Core
     end
 
     def self.match?(string, regex)
-      @scanner ||= StringScanner.new('')
+      @scanner ||= StringScanner.new("")
       @scanner.string = string
       @scanner.match?(regex)
     end
@@ -171,10 +168,10 @@ module Skylight::Core
       self.class.match?(string, regex)
     end
 
-    def instrument(cat, title=nil, desc=nil, meta=nil)
-      raise ArgumentError, 'cat is required' unless cat
+    def instrument(cat, title = nil, desc = nil, meta = nil)
+      raise ArgumentError, "cat is required" unless cat
 
-      unless trace = @trace_info.current
+      unless (trace = @trace_info.current)
         return yield if block_given?
         return
       end
@@ -189,7 +186,7 @@ module Skylight::Core
 
       cat = "other.#{cat}" unless match?(cat, Skylight::TIER_REGEX)
 
-      unless sp = trace.instrument(cat, title, desc, meta)
+      unless (sp = trace.instrument(cat, title, desc, meta))
         return yield if block_given?
         return
       end
@@ -208,17 +205,17 @@ module Skylight::Core
     end
 
     def span_correlation_header(span)
-      return unless trace = @trace_info.current
+      return unless (trace = @trace_info.current)
       trace.span_correlation_header(span)
     end
 
     def broken!
-      return unless trace = @trace_info.current
+      return unless (trace = @trace_info.current)
       trace.broken!
     end
 
-    def done(span, meta=nil)
-      return unless trace = @trace_info.current
+    def done(span, meta = nil)
+      return unless (trace = @trace_info.current)
       trace.done(span, meta)
     end
 
@@ -243,6 +240,7 @@ module Skylight::Core
       end
 
       begin
+        finalize_endpoint_segment(trace)
         native_submit_trace(trace)
         true
       rescue => e
@@ -253,7 +251,7 @@ module Skylight::Core
     end
 
     def ignore?(trace)
-      config.ignored_endpoints.include?(trace.endpoint.sub(%r{<sk-segment>.+</sk-segment>}, ''))
+      config.ignored_endpoints.include?(trace.endpoint)
     end
 
     # Return [title, sql]
@@ -261,5 +259,9 @@ module Skylight::Core
       [nil, sql]
     end
 
+    def finalize_endpoint_segment(trace)
+      return unless trace.segment
+      trace.endpoint += "<sk-segment>#{trace.segment}</sk-segment>"
+    end
   end
 end

data/lib/skylight/core/middleware.rb

@@ -1,17 +1,18 @@
-require 'securerandom'
+require "securerandom"
 
 module Skylight::Core
   # @api private
   class Middleware
-
     class BodyProxy
       def initialize(body, &block)
-        @body, @block, @closed = body, block, false
+        @body = body
+        @block = block
+        @closed = false
       end
 
-      def respond_to?(*args)
-        return false if args.first.to_s =~ /^to_ary$/
-        super or @body.respond_to?(*args)
+      def respond_to_missing?(*args)
+        return false if args.first.to_s !~ /^to_ary$/
+        @body.respond_to?(*args)
       end
 
       def close
@@ -59,7 +60,7 @@ module Skylight::Core
     # For Util::Logging
     attr_reader :config
 
-    def initialize(app, opts={})
+    def initialize(app, opts = {})
       @app = app
       @config = opts[:config]
     end
@@ -77,7 +78,7 @@ module Skylight::Core
       else
         begin
           t { "middleware beginning trace" }
-          trace = instrumentable.trace(endpoint_name(env), 'app.rack.request', nil, endpoint_meta(env))
+          trace = instrumentable.trace(endpoint_name(env), "app.rack.request", nil, endpoint_meta(env))
           t { "middleware began trace=#{trace.uuid}" }
 
           resp = @app.call(env)
@@ -88,7 +89,7 @@ module Skylight::Core
             resp
           end
         rescue Exception
-          t { "middleware exception: #{trace}"}
+          t { "middleware exception: #{trace}" }
           trace.submit if trace
           raise
         end
@@ -118,7 +119,7 @@ module Skylight::Core
 
       # Request ID code based on ActionDispatch::RequestId
       def set_request_id(env)
-        existing_request_id = env["action_dispatch.request_id"] || env['HTTP_X_REQUEST_ID'];
+        existing_request_id = env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
         @current_request_id = env["skylight.request_id"] = make_request_id(existing_request_id)
       end
 

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

@@ -17,12 +17,12 @@ module Skylight::Core
         # @option payload [String] :controller Controller name
         # @option payload [String] :action Action name
         # @return [Array]
-        def normalize(trace, name, payload)
+        def normalize(trace, _name, payload)
           trace.endpoint = controller_action(payload)
-          [ CAT, trace.endpoint, nil ]
+          [CAT, trace.endpoint, nil]
         end
 
-        def normalize_after(trace, span, name, payload)
+        def normalize_after(trace, _span, _name, payload)
           return unless config.enable_segments?
 
           # Show 'error' if there's an unhandled exception or if the status is 4xx or 5xx
@@ -31,19 +31,19 @@ module Skylight::Core
           # We won't have a rendered_format if it's a `head` outside of a `respond_to` block.
           elsif payload[:rendered_format]
             # We only show the variant if we actually have a format
-            segment = [payload[:rendered_format], payload[:variant]].compact.flatten.join('+')
+            segment = [payload[:rendered_format], payload[:variant]].compact.flatten.join("+")
           end
 
           if segment
-            trace.endpoint += "<sk-segment>#{segment}</sk-segment>"
+            trace.segment = segment
           end
         end
 
-      private
+        private
 
-        def controller_action(payload)
-          "#{payload[:controller]}##{payload[:action]}"
-        end
+          def controller_action(payload)
+            "#{payload[:controller]}##{payload[:action]}"
+          end
       end
     end
   end

data/lib/skylight/core/normalizers/action_controller/send_file.rb

@@ -1,22 +1,25 @@
 module Skylight::Core
   module Normalizers
     module ActionController
+      enabled = true
 
       # Temporary hacks
       begin
         require "action_dispatch/http/mime_type"
         require "action_dispatch/http/mime_types"
         require "rack/utils"
+      rescue LoadError
+        enabled = false
+      end
 
+      if enabled
         class SendFile < Normalizer
           register "send_file.action_controller"
 
           CAT = "app.controller.send_file".freeze
           TITLE = "send file".freeze
 
-          def normalize(trace, name, payload)
-            path = payload[:path]
-
+          def normalize(_trace, _name, _payload)
             title = TITLE
 
             # depending on normalization, we probably want this to eventually
@@ -24,27 +27,24 @@ module Skylight::Core
             # deduping strategy first.
             desc = nil
 
-            [ CAT, title, desc ]
+            [CAT, title, desc]
           end
 
-        private
+          private
 
-          OCTET_STREAM = "application/octet-stream".freeze
-          ATTACHMENT = "attachment".freeze
+            OCTET_STREAM = "application/octet-stream".freeze
+            ATTACHMENT = "attachment".freeze
 
-          def initialize(*)
-            super
+            def initialize(*)
+              super
 
-            @mimes = Mime::SET.reduce({}) do |hash, mime|
-              hash[mime.symbol] = mime.to_s.dup.freeze
-              hash
+              @mimes = Mime::SET.each_with_object({}) do |mime, hash|
+                hash[mime.symbol] = mime.to_s.dup.freeze
+                hash
+              end
             end
-          end
         end
-
-      rescue LoadError
       end
-
     end
   end
 end

data/lib/skylight/core/normalizers/action_view/render_collection.rb

@@ -1,4 +1,4 @@
-require 'skylight/core/normalizers/render'
+require "skylight/core/normalizers/render"
 
 module Skylight::Core
   module Normalizers
@@ -15,7 +15,7 @@ module Skylight::Core
         # @option payload (see RenderNormalizer#normalize_render)
         # @option payload [Integer] :count
         # @return (see RenderNormalizer#normalize_render)
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           normalize_render(CAT, payload)
         end
       end

data/lib/skylight/core/normalizers/action_view/render_partial.rb

@@ -1,4 +1,4 @@
-require 'skylight/core/normalizers/render'
+require "skylight/core/normalizers/render"
 
 module Skylight::Core
   module Normalizers
@@ -14,7 +14,7 @@ module Skylight::Core
         # @param payload (see RenderNormalizer#normalize_render)
         # @option payload (see RenderNormalizer#normalize_render)
         # @return (see RenderNormalizer#normalize_render)
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           normalize_render(CAT, payload)
         end
       end

data/lib/skylight/core/normalizers/action_view/render_template.rb

@@ -1,4 +1,4 @@
-require 'skylight/core/normalizers/render'
+require "skylight/core/normalizers/render"
 
 module Skylight::Core
   module Normalizers
@@ -14,7 +14,7 @@ module Skylight::Core
         # @param payload (see RenderNormalizer#normalize_render)
         # @option payload (see RenderNormalizer#normalize_render)
         # @return (see RenderNormalizer#normalize_render)
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           normalize_render(CAT, payload)
         end
       end

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

@@ -7,40 +7,28 @@ module Skylight::Core
         CAT = "app.job.perform".freeze
 
         def normalize(trace, _name, payload)
-          title = normalize_title(payload[:job])
+          title = payload[:job].class.to_s
           adapter_name = normalize_adapter_name(payload[:adapter])
           desc = "{ adapter: '#{adapter_name}', queue: '#{payload[:job].queue_name}' }"
 
-          trace.endpoint = title if assign_endpoint?(trace, payload)
+          trace.endpoint = title
 
-          [ CAT, title, desc ]
+          [CAT, title, desc]
         end
 
         def normalize_after(trace, _span, _name, payload)
-          return unless config.enable_segments? && assign_endpoint?(trace, payload)
-
-          trace.endpoint += "<sk-segment>#{payload[:job].queue_name}</sk-segment>"
+          return unless config.enable_segments?
+          trace.segment = payload[:job].queue_name
         end
 
         private
 
-        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
-        rescue
-          'active_job'
-        end
-
-        def assign_endpoint?(trace, payload)
-          return false unless defined?(Skylight::Core::Probes::ActiveJob::Probe::TITLE)
-
-          trace.endpoint == Skylight::Core::Probes::ActiveJob::Probe::TITLE ||
-            trace.endpoint == normalize_title(payload[:job])
-        end
-
-        def normalize_title(job_instance)
-          "#{job_instance.class}"
-        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
+          rescue
+            "active_job"
+          end
       end
     end
   end

data/lib/skylight/core/normalizers/active_model_serializers/render.rb

@@ -6,19 +6,19 @@ module Skylight::Core
 
         CAT = "view.render.active_model_serializers".freeze
 
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           serializer_class = payload[:serializer]
 
-          title = serializer_class.name.sub(/^ActiveModel::(Serializer::)?/, '')
+          title = serializer_class.name.sub(/^ActiveModel::(Serializer::)?/, "")
 
-          if adapter_instance = payload[:adapter]
+          if (adapter_instance = payload[:adapter])
             adapter_name = adapter_instance.class.name
-                              .sub(/^ActiveModel::Serializer::Adapter::/, '')
-                              .sub(/^ActiveModelSerializers::Adapter::/, '')
+                                           .sub(/^ActiveModel::Serializer::Adapter::/, "")
+                                           .sub(/^ActiveModelSerializers::Adapter::/, "")
             desc = "Adapter: #{adapter_name}"
           end
 
-          [ CAT, title, desc ]
+          [CAT, title, desc]
         end
       end
     end

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

@@ -6,11 +6,10 @@ module Skylight::Core
 
         CAT = "db.active_record.instantiation".freeze
 
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           # Payload also includes `:record_count` but this will be variable
-          [ CAT, "#{payload[:class_name]} Instantiation", nil]
+          [CAT, "#{payload[:class_name]} Instantiation", nil]
         end
-
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require 'skylight/core/normalizers/sql'
+require "skylight/core/normalizers/sql"
 
 module Skylight::Core
   module Normalizers
@@ -26,7 +26,6 @@ module Skylight::Core
 
           [name, title, description, meta]
         end
-
       end
     end
   end

data/lib/skylight/core/normalizers/active_support/cache.rb

@@ -2,16 +2,18 @@ module Skylight::Core
   module Normalizers
     module ActiveSupport
       class Cache < Normalizer
-        %w(clear
-            decrement
-            delete
-            exist
-            fetch_hit
-            generate
-            increment
-            read
-            read_multi
-            write).each do |type|
+        %w[
+          clear
+          decrement
+          delete
+          exist
+          fetch_hit
+          generate
+          increment
+          read
+          read_multi
+          write
+        ].each do |type|
           require "skylight/core/normalizers/active_support/cache_#{type}"
         end
       end

data/lib/skylight/core/normalizers/active_support/cache_clear.rb

@@ -7,8 +7,8 @@ module Skylight::Core
         CAT = "app.cache.clear".freeze
         TITLE = "cache clear".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_decrement.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_decrement.active_support"
 
         CAT = "app.cache.decrement".freeze
-        TITLE = "cache decrement"
+        TITLE = "cache decrement".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_delete.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_delete.active_support"
 
         CAT = "app.cache.delete".freeze
-        TITLE = "cache delete"
+        TITLE = "cache delete".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_exist.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_exist?.active_support"
 
         CAT = "app.cache.exist".freeze
-        TITLE = "cache exist?"
+        TITLE = "cache exist?".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_fetch_hit.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_fetch_hit.active_support"
 
         CAT = "app.cache.fetch_hit".freeze
-        TITLE = "cache fetch hit"
+        TITLE = "cache fetch hit".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_generate.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_generate.active_support"
 
         CAT = "app.cache.generate".freeze
-        TITLE = "cache generate"
+        TITLE = "cache generate".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_increment.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_increment.active_support"
 
         CAT = "app.cache.increment".freeze
-        TITLE = "cache increment"
+        TITLE = "cache increment".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_read.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_read.active_support"
 
         CAT = "app.cache.read".freeze
-        TITLE = "cache read"
+        TITLE = "cache read".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_read_multi.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_read_multi.active_support"
 
         CAT = "app.cache.read_multi".freeze
-        TITLE = "cache read multi"
+        TITLE = "cache read multi".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end

data/lib/skylight/core/normalizers/active_support/cache_write.rb

@@ -5,10 +5,10 @@ module Skylight::Core
         register "cache_write.active_support"
 
         CAT = "app.cache.write".freeze
-        TITLE = "cache write"
+        TITLE = "cache write".freeze
 
-        def normalize(trace, name, payload)
-          [ CAT, TITLE, nil ]
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
         end
       end
     end