skylight-core 2.0.0.beta3 → 2.0.0

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

@@ -1,3 +1,5 @@
+require 'skylight/core/normalizers/render'
+
 module Skylight::Core
   module Normalizers
     module ActionView

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

@@ -1,3 +1,5 @@
+require 'skylight/core/normalizers/render'
+
 module Skylight::Core
   module Normalizers
     module ActionView

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

@@ -0,0 +1,77 @@
+module Skylight::Core
+  module Normalizers
+    # Base Normalizer for Rails rendering
+    class RenderNormalizer < Normalizer
+      include Util::AllocationFree
+
+      def setup
+        @paths = config['normalizers.render.view_paths'] || []
+      end
+
+      # Generic normalizer for renders
+      # @param category [String]
+      # @param payload [Hash]
+      # @option payload [String] :identifier
+      # @return [Array]
+      def normalize_render(category, payload)
+        if path = payload[:identifier]
+          title = relative_path(path)
+          path = nil if path == title
+        end
+
+        [ category, title, nil ]
+      end
+
+      def relative_path(path)
+        return path if relative_path?(path)
+
+        root = array_find(@paths) { |p| path.start_with?(p) }
+        type = :project
+
+        unless root
+          root = array_find(Gem.path) { |p| path.start_with?(p) }
+          type = :gem
+        end
+
+        if root
+          start = root.size
+          start += 1 if path.getbyte(start) == SEPARATOR_BYTE
+          if type == :gem
+            "$GEM_PATH/#{path[start, path.size]}"
+          else
+            path[start, path.size]
+          end
+        else
+          "Absolute Path"
+        end
+      end
+
+    private
+      def relative_path?(path)
+        !absolute_path?(path)
+      end
+
+      SEPARATOR_BYTE = File::SEPARATOR.ord
+
+      if File.const_defined?(:NULL) ? File::NULL == "NUL" : RbConfig::CONFIG['host_os'] =~ /mingw|mswin32/
+        # This is a DOSish environment
+        ALT_SEPARATOR_BYTE = File::ALT_SEPARATOR && File::ALT_SEPARATOR.ord
+        COLON_BYTE = ":".ord
+        def absolute_path?(path)
+          if alpha?(path.getbyte(0)) && path.getbyte(1) == COLON_BYTE
+            byte2 = path.getbyte(2)
+            byte2 == SEPARATOR_BYTE || byte2 == ALT_SEPARATOR_BYTE
+          end
+        end
+
+        def alpha?(byte)
+          byte >= 65 and byte <= 90 || byte >= 97 and byte <= 122
+        end
+      else
+        def absolute_path?(path)
+          path.getbyte(0) == SEPARATOR_BYTE
+        end
+      end
+    end
+  end
+end

data/lib/skylight/core/probes.rb

@@ -1,110 +1,118 @@
+require 'pathname'
+
 module Skylight::Core
   # @api private
   module Probes
+    class ProbeRegistration
+      attr_reader :name, :klass_name, :require_paths, :probe
 
-    @@available = nil
+      def initialize(name, klass_name, require_paths, probe)
+        @name = name
+        @klass_name = klass_name
+        @require_paths = Array(require_paths)
+        @probe = probe
+      end
 
-    def self.available
-      unless @@available
-        root = File.expand_path("../probes", __FILE__)
-        @@available = {}
-        Dir["#{root}/*.rb"].each do |f|
-          name = File.basename(f, '.rb')
-          @@available[name] = "skylight/core/probes/#{name}"
-        end
+      def install
+        probe.install
       end
-      @@available
     end
 
-    def self.probe(*probes)
-      unknown = probes.map(&:to_s) - available.keys
-      unless unknown.empty?
-        raise ArgumentError, "unknown probes: #{unknown.join(', ')}"
-      end
+    class << self
 
-      probes.each do |p|
-        require available[p.to_s]
+      def paths
+        @paths ||= []
       end
-    end
 
-    class ProbeRegistration
-      attr_reader :klass_name, :require_paths, :probe
+      def add_path(path)
+        root = Pathname.new(path)
+        Pathname.glob(root.join("./**/*.rb")).each do |f|
+          name = f.relative_path_from(root).sub_ext('').to_s
+          if available.key?(name)
+            raise "duplicate probe name: #{name}; original=#{available[name]}; new=#{f}"
+          end
+          available[name] = f
+        end
+      end
 
-      def initialize(klass_name, require_paths, probe)
-        @klass_name = klass_name
-        @require_paths = Array(require_paths)
-        @probe = probe
+      def available
+        @available ||= {}
       end
 
-      def install
-        probe.install
+      def probe(*probes)
+        unknown = probes.map(&:to_s) - available.keys
+        unless unknown.empty?
+          raise ArgumentError, "unknown probes: #{unknown.join(', ')}"
+        end
+
+        probes.each do |p|
+          require available[p.to_s]
+        end
       end
-    end
 
-    def self.require_hooks
-      @require_hooks ||= {}
-    end
+      def require_hooks
+        @require_hooks ||= {}
+      end
 
-    def self.installed
-      @installed ||= {}
-    end
+      def installed
+        @installed ||= {}
+      end
 
-    def self.is_available?(klass_name)
-      !!Util::Inflector.safe_constantize(klass_name)
-    end
+      def is_available?(klass_name)
+        !!Skylight::Core::Util::Inflector.safe_constantize(klass_name)
+      end
 
-    def self.register(*args)
-      registration = ProbeRegistration.new(*args)
+      def register(name, *args)
+        registration = ProbeRegistration.new(name, *args)
 
-      if is_available?(registration.klass_name)
-        installed[registration.klass_name] ||= []
-        installed[registration.klass_name] << registration
-        registration.install
-      else
-        register_require_hook(registration)
+        if is_available?(registration.klass_name)
+          installed[registration.klass_name] = registration
+          registration.install
+        else
+          register_require_hook(registration)
+        end
       end
-    end
 
-    def self.require_hook(require_path)
-      registrations = lookup_by_require_path(require_path)
-      return unless registrations
+      def require_hook(require_path)
+        registration = lookup_by_require_path(require_path)
+        return unless registration
 
-      registrations.each do |registration|
         # Double check constant is available
         if is_available?(registration.klass_name)
-          installed[registration.klass_name] ||= []
-          installed[registration.klass_name] << registration
+          installed[registration.klass_name] = registration
           registration.install
 
           # Don't need this to be called again
           unregister_require_hook(registration)
         end
       end
-    end
 
-    def self.register_require_hook(registration)
-      registration.require_paths.each do |p|
-        require_hooks[p] ||= []
-        require_hooks[p] << registration
+      def register_require_hook(registration)
+        registration.require_paths.each do |p|
+          require_hooks[p] = registration
+        end
       end
-    end
 
-    def self.unregister_require_hook(registration)
-      registration.require_paths.each do |p|
-        require_hooks[p].delete(registration)
-        require_hooks.delete(p) if require_hook[p].empty?
+      def unregister_require_hook(registration)
+        registration.require_paths.each do |p|
+          require_hooks.delete(p)
+        end
       end
-    end
 
-    def self.lookup_by_require_path(require_path)
-      require_hooks[require_path]
+      def lookup_by_require_path(require_path)
+        require_hooks[require_path]
+      end
     end
+
+    add_path(File.expand_path("./probes", __dir__))
   end
 end
 
 # Allow hooking require
 # @api private
 module ::Kernel
+  private
+
   alias require_without_sk require
 
   def require(name)
@@ -117,13 +125,5 @@ module ::Kernel
     end
 
     ret
-  rescue LoadError
-    # Support pre-2.0 style requires
-    if name =~ %r{^skylight/probes/(.+)}
-      warn "[DEPRECATION] Requiring Skylight probes by path is deprecated. Use `Skylight.probe(:#{$1})` instead."
-      require "skylight/core/probes/#{$1}"
-    else
-      raise
-    end
   end
-end
+end

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

@@ -26,6 +26,6 @@ module Skylight::Core
       end
     end
 
-    register("ActionController::Instrumentation", "action_controller/metal/instrumentation", ActionController::Probe.new)
+    register(:action_controller, "ActionController::Instrumentation", "action_controller/metal/instrumentation", ActionController::Probe.new)
   end
 end

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

@@ -0,0 +1 @@
+Skylight::Core::Probes.probe('action_dispatch/request_id')

data/lib/skylight/core/probes/action_dispatch/request_id.rb

@@ -0,0 +1,31 @@
+module Skylight::Core
+  module Probes
+    module ActionDispatch
+      module RequestId
+        class Probe
+          def install
+            ::ActionDispatch::RequestId.class_eval do
+              alias call_without_sk call
+
+              def call(env)
+                @skylight_request_id = env["skylight.request_id"]
+                call_without_sk(env)
+              end
+
+              private
+
+                alias internal_request_id_without_sk internal_request_id
+
+                def internal_request_id
+                  @skylight_request_id || internal_request_id_without_sk
+                end
+
+            end
+          end
+        end
+      end
+    end
+
+    register(:action_dispatch, "ActionDispatch::RequestId", "action_dispatch/middleware/request_id", ActionDispatch::RequestId::Probe.new)
+  end
+end

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

@@ -30,6 +30,6 @@ module Skylight::Core
       end
     end
 
-    register("ActionView::TemplateRenderer", "action_view", ActionView::Probe.new)
+    register(:action_view, "ActionView::TemplateRenderer", "action_view", ActionView::Probe.new)
   end
 end

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

@@ -50,6 +50,6 @@ module Skylight::Core
       end
     end
 
-    register("ActiveModel::Serializer", "active_model/serializer", ActiveModelSerializers::Probe.new)
+    register(:active_model_serializers, "ActiveModel::Serializer", "active_model/serializer", ActiveModelSerializers::Probe.new)
   end
 end

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

@@ -32,6 +32,6 @@ module Skylight::Core
       end
     end
 
-    register("Elasticsearch", "elasticsearch", Elasticsearch::Probe.new)
+    register(:elasticsearch, "Elasticsearch", "elasticsearch", Elasticsearch::Probe.new)
   end
 end

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

@@ -21,6 +21,6 @@ module Skylight::Core
       end
     end
 
-    register("Excon", "excon", Excon::Probe.new)
+    register(:excon, "Excon", "excon", Excon::Probe.new)
   end
 end

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

@@ -17,6 +17,6 @@ module Skylight::Core
       end
     end
 
-    register("Faraday", "faraday", Faraday::Probe.new)
+    register(:faraday, "Faraday", "faraday", Faraday::Probe.new)
   end
 end

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

@@ -41,6 +41,6 @@ module Skylight::Core
       end # class Probe
     end # module Probes::HTTPClient
 
-    register("HTTPClient", "httpclient", HTTPClient::Probe.new)
+    register(:httpclient, "HTTPClient", "httpclient", HTTPClient::Probe.new)
   end
 end

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

@@ -2,10 +2,26 @@ module Skylight::Core
   module Probes
     module Middleware
       class Probe
+        DISABLED_KEY = :__skylight_middleware_disabled
+
+        def self.disable!
+          @disabled = true
+        end
+
+        def self.enable!
+          @disabled = false
+        end
+
+        def self.disabled?
+          !!@disabled
+        end
+
         def self.add_instrumentation(middleware, default_name: "Anonymous Middleware", category: "rack.middleware")
           middleware.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
             alias call_without_sk call
             def call(*args, &block)
+              return call_without_sk(*args, &block) if Skylight::Core::Probes::Middleware::Probe.disabled?
+
               traces = Skylight::Core::Fanout.registered.map do |r|
                 r.instrumenter ? r.instrumenter.current_trace : nil
               end.compact
@@ -33,7 +49,7 @@ module Skylight::Core
         end
 
         def install
-          ActionDispatch::MiddlewareStack.class_eval do
+          ::ActionDispatch::MiddlewareStack.class_eval do
             alias build_without_sk build
 
             if ::ActionPack.gem_version >= Gem::Version.new('5.x')
@@ -53,7 +69,7 @@ module Skylight::Core
             end
           end
 
-          ActionDispatch::MiddlewareStack::Middleware.class_eval do
+          ::ActionDispatch::MiddlewareStack::Middleware.class_eval do
             alias build_without_sk build
             def build(*args)
               sk_instrument_middleware(build_without_sk(*args))
@@ -77,6 +93,6 @@ module Skylight::Core
       end
     end
 
-    register("ActionDispatch::MiddlewareStack::Middleware", "actionpack/action_dispatch", Middleware::Probe.new)
+    register(:middleware, "ActionDispatch::MiddlewareStack::Middleware", "actionpack/action_dispatch", Middleware::Probe.new)
   end
 end

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

@@ -166,6 +166,6 @@ module Skylight::Core
       end
     end
 
-    register("Mongo", "mongo", Mongo::Probe.new)
+    register(:mongo, "Mongo", "mongo", Mongo::Probe.new)
   end
 end