skylight-core 2.0.0.beta3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 237d8a95eb9bd92d8ab981fda27862546cdccfccc4aa0ebb3f5c1bd32bc69494
-  data.tar.gz: 61cd69d8abe954e0033f1c9303a45cb11b7a58561f4c784d3b41c3e2c1896172
+  metadata.gz: 0d65618c6d6e9fcecd44bca37e8d7e3fbade73ce213712ab8af7ca71c6707e8c
+  data.tar.gz: '01867c672012d9400da14b148f856745d611695f4a85677eca624de60c9f87dc'
 SHA512:
-  metadata.gz: b2fecfbbf37b22227727a69d2cde96a585e75e06d3bdd2f272521bff757b6c507a2d144398558e956666b55d4bef0e7121c1f02beeac06142d2c303b08d21999
-  data.tar.gz: ff10cbe2195702b05506df19491ab229b6824daa58fae7cf56afe67d46abdcca1f16faf716ca871a5ab0c3bd0505d729f91b217fd9088f8245a760df55ec9f42
+  metadata.gz: e610c23d07e5e8c02f4be9ef602689e9d1a1abfdd2ee58a72dbdd643b7e6d6d9abef8eb256951563d5296bfd8f0c18d0de76af69be8d4e3f403a67293cd95423
+  data.tar.gz: 6dff8d6a3e452b7657f8c011c0dbf54205d01795effe34826ab38da5700bc778be3b99bff952684bfbaf5c312093f69c38907f35211f111dbb9c5bee4361d37d

data/lib/skylight/core.rb

@@ -1,4 +1,5 @@
 require 'skylight/core/version'
+require 'skylight/core/deprecation'
 
 module Skylight
   module Core

data/lib/skylight/core/config.rb

@@ -98,6 +98,8 @@ module Skylight::Core
       @values   = {}
       @priority = {}
       @regexp   = nil
+      @alert_logger = nil
+      @logger = nil
 
       p = attrs.delete(:priority)
 

data/lib/skylight/core/deprecation.rb

@@ -0,0 +1,15 @@
+require 'active_support/deprecation'
+
+module Skylight
+  SKYLIGHT_GEM_ROOT = File.expand_path("../../..", __FILE__) + "/"
+
+  class Deprecation < ActiveSupport::Deprecation
+    private
+
+      def ignored_callstack(path)
+        path.start_with?(SKYLIGHT_GEM_ROOT)
+      end
+  end
+
+  DEPRECATOR = Deprecation.new('3.0', 'skylight')
+end

data/lib/skylight/core/instrumentable.rb

@@ -33,6 +33,10 @@ module Skylight
           Skylight::Core::Probes.probe(*args)
         end
 
+        def enable_normalizer(*names)
+          Skylight::Core::Normalizers.enable(*names)
+        end
+
         # Start instrumenting
         def start!(config=nil)
           return @instrumenter if @instrumenter
@@ -63,7 +67,10 @@ module Skylight
 
         # Stop instrumenting
         def stop!
+          t { "stop!" }
+
           const_get(:LOCK).synchronize do
+            t { "stop! synchronized" }
             return unless @instrumenter
             # This is only really helpful for getting specs to pass.
             @instrumenter.current_trace = nil
@@ -75,6 +82,7 @@ module Skylight
 
         # Check tracing
         def tracing?
+          t { "checking tracing?; thread=#{Thread.current.object_id}"}
           instrumenter && instrumenter.current_trace
         end
 

data/lib/skylight/core/instrumenter.rb

@@ -1,5 +1,6 @@
 require 'thread'
 require 'strscan'
+require 'securerandom'
 
 module Skylight::Core
   # @api private
@@ -24,25 +25,27 @@ module Skylight::Core
       end
     end
 
-    attr_reader :config, :gc, :trace_info
+    attr_reader :uuid, :config, :gc, :trace_info
 
     def self.trace_class
       Trace
     end
 
-    def self.native_new
+    def self.native_new(_uuid, _config_env)
       raise "not implemented"
     end
 
     def self.new(config)
       config.validate!
 
-      inst = native_new(config.to_native_env)
-      inst.send(:initialize, config)
+      uuid = SecureRandom.uuid
+      inst = native_new(uuid, config.to_native_env)
+      inst.send(:initialize, uuid, config)
       inst
     end
 
-    def initialize(config)
+    def initialize(uuid, config)
+      @uuid = uuid
       @gc = config.gc
       @config = config
       @subscriber = Subscriber.new(config, self)
@@ -51,6 +54,10 @@ module Skylight::Core
       @trace_info = @config[:trace_info] || TraceInfo.new(key)
     end
 
+    def log_context
+      @log_context ||= { inst: uuid }
+    end
+
     def native_start
       raise "not implemented"
     end
@@ -59,11 +66,11 @@ module Skylight::Core
       raise "not implemented"
     end
 
-    def native_track_desc
+    def native_track_desc(_endpoint, _description)
       raise "not implemented"
     end
 
-    def native_submit_trace
+    def native_submit_trace(_trace)
       raise "not implemented"
     end
 
@@ -72,6 +79,7 @@ module Skylight::Core
     end
 
     def current_trace=(trace)
+      t { "setting current_trace=#{trace ? trace.uuid : "nil"}; thread=#{Thread.current.object_id}" }
       @trace_info.current = trace
     end
 
@@ -135,7 +143,7 @@ module Skylight::Core
 
       ensure
         @trace_info.current = nil
-        t { "instrumenter submitting trace" }
+        t { "instrumenter submitting trace; trace=#{trace.uuid}" }
         trace.submit
       end
     end
@@ -172,7 +180,7 @@ module Skylight::Core
       cat = cat.to_s
 
       unless match?(cat, Skylight::CATEGORY_REGEX)
-        warn "invalid skylight instrumentation category; value=%s", cat
+        warn "invalid skylight instrumentation category; trace=%s; value=%s", trace.uuid, cat
         return yield if block_given?
         return
       end
@@ -225,10 +233,10 @@ module Skylight::Core
     end
 
     def process(trace)
-      t { fmt "processing trace" }
+      t { fmt "processing trace=#{trace.uuid}" }
 
       if ignore?(trace)
-        t { fmt "ignoring trace" }
+        t { fmt "ignoring trace=#{trace.uuid}" }
         return false
       end
 
@@ -236,7 +244,7 @@ module Skylight::Core
         native_submit_trace(trace)
         true
       rescue => e
-        warn "failed to submit trace to worker; err=%s", e
+        warn "failed to submit trace to worker; trace=%s, err=%s", trace.uuid, e
         t { "BACKTRACE:\n#{e.backtrace.join("\n")}" }
         false
       end

data/lib/skylight/core/middleware.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Skylight::Core
   # @api private
   class Middleware
@@ -62,22 +64,11 @@ module Skylight::Core
       @config = opts[:config]
     end
 
-    def instrumentable
-      Skylight
-    end
-
-    # Allow for overwriting
-    def endpoint_name(_env)
-      "Rack"
-    end
-
-    def endpoint_meta(_env)
-      nil
-    end
-
     def call(env)
+      set_request_id(env)
+
       if instrumentable.tracing?
-        error "Already instrumenting. Make sure the Middleware hasn't been added more than once."
+        error "Already instrumenting. Make sure the Skylight Rack Middleware hasn't been added more than once."
       end
 
       if env["REQUEST_METHOD"] == "HEAD"
@@ -87,6 +78,8 @@ module Skylight::Core
         begin
           t { "middleware beginning trace" }
           trace = instrumentable.trace(endpoint_name(env), 'app.rack.request', nil, endpoint_meta(env))
+          t { "middleware began trace=#{trace.uuid}" }
+
           resp = @app.call(env)
 
           if trace
@@ -101,5 +94,44 @@ module Skylight::Core
         end
       end
     end
+
+    private
+
+      def log_context
+        # Don't cache this, it will change
+        inst_id = instrumentable.instrumenter ? instrumentable.instrumenter.uuid : nil
+        { request_id: @current_request_id, inst: inst_id }
+      end
+
+      def instrumentable
+        Skylight
+      end
+
+      # Allow for overwriting
+      def endpoint_name(_env)
+        "Rack"
+      end
+
+      def endpoint_meta(_env)
+        nil
+      end
+
+      # 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'];
+        @current_request_id = env["skylight.request_id"] = make_request_id(existing_request_id)
+      end
+
+      def make_request_id(request_id)
+        if request_id && !request_id.empty?
+          request_id.gsub(/[^\w\-]/, "".freeze).first(255)
+        else
+          internal_request_id
+        end
+      end
+
+      def internal_request_id
+        SecureRandom.uuid
+      end
   end
 end

data/lib/skylight/core/normalizers.rb

@@ -7,29 +7,51 @@ module Skylight::Core
 
     DEFAULT = Default.new
 
-    def self.register(name, klass)
-      (@registry ||= {})[name] = klass
-      klass
+    def self.registry
+      @registry ||= {}
+    end
+
+    def self.register(name, klass, opts={})
+      enabled = opts[:enabled] != false
+      registry[name] = [klass, enabled]
+    end
+
+    def self.unregister(name)
+      @registry.delete(name)
+    end
+
+    def self.enable(*names, enabled: true)
+      names.each do |name|
+        matches = registry.select{|n,_| n =~ /(^|\.)#{name}$/ }
+        raise ArgumentError, "no normalizers match #{name}" if matches.empty?
+        matches.values.each{|v| v[1] = enabled }
+      end
+    end
+
+    def self.disable(*names)
+      enable(*names, enabled: false)
     end
 
     def self.build(config)
       normalizers = {}
 
-      (@registry || {}).each do |k, klass|
+      registry.each do |key, (klass, enabled)|
+        next if !enabled
+
         unless klass.method_defined?(:normalize)
           # TODO: Warn
           next
         end
 
-        normalizers[k] = klass.new(config)
+        normalizers[key] = klass.new(config)
       end
 
       Container.new(normalizers)
     end
 
     class Normalizer
-      def self.register(name)
-        Normalizers.register(name, self)
+      def self.register(name, opts={})
+        Normalizers.register(name, self, opts)
       end
 
       attr_reader :config
@@ -47,80 +69,6 @@ module Skylight::Core
       end
     end
 
-    # 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
-
     class Container
       def initialize(normalizers)
         @normalizers = normalizers
@@ -139,7 +87,10 @@ module Skylight::Core
       end
 
       def normalizer_for(name)
-        @normalizers[name] || DEFAULT
+        # We never expect to hit the default case since we only register listeners
+        # for items that we know have normalizers. For now, though, we'll play it
+        # safe and provide a fallback.
+        @normalizers.fetch(name, DEFAULT)
       end
     end
 
@@ -148,13 +99,13 @@ module Skylight::Core
         action_view/render_collection
         action_view/render_partial
         action_view/render_template
+        active_job/enqueue_at
         active_model_serializers/render
         active_record/instantiation
         active_record/sql
         active_support/cache
         coach/handler_finish
         coach/middleware_finish
-        couch_potato/query
         data_mapper/sql
         elasticsearch/request
         faraday/request
@@ -163,8 +114,5 @@ module Skylight::Core
         sequel/sql).each do |file|
       require "skylight/core/normalizers/#{file}"
     end
-
-    # The following are not required by default as they are of dubious usefulness:
-    # - active_job/enqueue_at
   end
 end

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

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