skylight-core 2.0.0.beta3 → 2.0.0

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

@@ -8,14 +8,14 @@ module Skylight::Core
           version = Gem::Version.new(::Mongoid::VERSION)
 
           if version < Gem::Version.new("5.0")
-            require 'skylight/core/probes/moped'
+            Skylight::Core::Probes.probe(:moped)
           else
-            require 'skylight/core/probes/mongo'
+            Skylight::Core::Probes.probe(:mongo)
           end
         end
       end
     end
 
-    register("Mongoid", "mongoid", Mongoid::Probe.new)
+    register(:mongoid, "Mongoid", "mongoid", Mongoid::Probe.new)
   end
 end

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

@@ -34,6 +34,6 @@ module Skylight::Core
       end
     end
 
-    register("Moped", "moped", Moped::Probe.new)
+    register(:moped, "Moped", "moped", Moped::Probe.new)
   end
 end

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

@@ -59,6 +59,6 @@ module Skylight::Core
       end
     end
 
-    register("Net::HTTP", "net/http", NetHTTP::Probe.new)
+    register(:net_http, "Net::HTTP", "net/http", NetHTTP::Probe.new)
   end
 end

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

@@ -66,6 +66,6 @@ module Skylight::Core
       end
     end
 
-    register("Redis", "redis", Redis::Probe.new)
+    register(:redis, "Redis", "redis", Redis::Probe.new)
   end
 end

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

@@ -28,6 +28,6 @@ module Skylight::Core
       end
     end
 
-    register("Sequel", "sequel", Sequel::Probe.new)
+    register(:sequel, "Sequel", "sequel", Sequel::Probe.new)
   end
 end

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

@@ -64,6 +64,6 @@ module Skylight::Core
       end
     end
 
-    register("Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
+    register(:sinatra, "Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
   end
 end

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

@@ -22,6 +22,6 @@ module Skylight::Core
       end
     end
 
-    register("Tilt::Template", "tilt/template", Tilt::Probe.new)
+    register(:tilt, "Tilt::Template", "tilt/template", Tilt::Probe.new)
   end
 end

data/lib/skylight/core/test.rb

@@ -7,94 +7,107 @@ module Skylight
           config_opts[:mock_submission] ||= callback || proc {}
           config = config_class.load(config_opts)
 
-          mock_instrumenter_klass = Class.new(instrumenter_class) do
-            def self.trace_class
-              @trace_class ||= Class.new(super) do
-                def self.native_new(start, _uuid, endpoint, meta)
-                  inst = allocate
-                  inst.instance_variable_set(:@start, start)
-                  inst.instance_variable_set(:@endpoint, endpoint)
-                  inst.instance_variable_set(:@starting_endpoint, endpoint)
-                  inst.instance_variable_set(:@meta, meta)
-                  inst
-                end
-
-                attr_reader :endpoint, :starting_endpoint, :meta
-
-                def mock_spans
-                  @mock_spans ||= []
-                end
-
-                def native_get_started_at
-                  @start
-                end
-
-                def native_set_endpoint(endpoint)
-                  @endpoint = endpoint
-                end
-
-                def native_start_span(time, cat)
-                  span = {
-                    start: time,
-                    cat: cat
-                  }
-                  mock_spans << span
-                  # Return integer like the native method does
-                  mock_spans.index(span)
-                end
-
-                def native_span_set_title(sp, title)
-                  mock_spans[sp][:title] = title
-
-                end
-
-                def native_span_set_description(sp, desc)
-                  mock_spans[sp][:desc] = desc
-                end
-
-                def native_span_set_meta(sp, meta)
-                  mock_spans[sp][:meta] = meta
-                end
-
-                def native_span_started(sp)
-                end
-
-                def native_span_set_exception(sp, exception_object, exception)
-                  mock_spans[sp][:exception_object] = exception_object
-                  mock_spans[sp][:exception] = exception
-                end
-
-                def native_stop_span(span, time)
-                  span = mock_spans[span]
-                  span[:duration] = time - span[:start]
-                  nil
+          unless respond_to?(:__original_instrumenter_class)
+            class_eval do
+              class << self
+                alias __original_instrumenter_class instrumenter_class
+
+                def instrumenter_class
+                  @instrumenter_class ||= Class.new(__original_instrumenter_class) do
+                    def self.name
+                      "Mocked Instrumenter"
+                    end
+
+                    def self.native_new(*)
+                      allocate
+                    end
+
+                    def self.trace_class
+                      @trace_class ||= Class.new(super) do
+                        def self.native_new(start, _uuid, endpoint, meta)
+                          inst = allocate
+                          inst.instance_variable_set(:@start, start)
+                          inst.instance_variable_set(:@endpoint, endpoint)
+                          inst.instance_variable_set(:@starting_endpoint, endpoint)
+                          inst.instance_variable_set(:@meta, meta)
+                          inst
+                        end
+
+                        attr_reader :endpoint, :starting_endpoint, :meta
+
+                        def mock_spans
+                          @mock_spans ||= []
+                        end
+
+                        def native_get_started_at
+                          @start
+                        end
+
+                        def native_set_endpoint(endpoint)
+                          @endpoint = endpoint
+                        end
+
+                        def native_start_span(time, cat)
+                          span = {
+                            start: time,
+                            cat: cat
+                          }
+                          mock_spans << span
+                          # Return integer like the native method does
+                          mock_spans.index(span)
+                        end
+
+                        def native_span_set_title(sp, title)
+                          mock_spans[sp][:title] = title
+
+                        end
+
+                        def native_span_set_description(sp, desc)
+                          mock_spans[sp][:desc] = desc
+                        end
+
+                        def native_span_set_meta(sp, meta)
+                          mock_spans[sp][:meta] = meta
+                        end
+
+                        def native_span_started(sp)
+                        end
+
+                        def native_span_set_exception(sp, exception_object, exception)
+                          mock_spans[sp][:exception_object] = exception_object
+                          mock_spans[sp][:exception] = exception
+                        end
+
+                        def native_stop_span(span, time)
+                          span = mock_spans[span]
+                          span[:duration] = time - span[:start]
+                          nil
+                        end
+                      end
+                    end
+
+                    def native_start
+                      true
+                    end
+
+                    def native_submit_trace(trace)
+                      config[:mock_submission].call(trace)
+                    end
+
+                    def native_stop
+                    end
+
+                    def limited_description(description)
+                      description
+                    end
+                  end
                 end
               end
             end
-
-            def self.native_new(*)
-              allocate
-            end
-
-            def native_start
-              true
-            end
-
-            def native_submit_trace(trace)
-              config[:mock_submission].call(trace)
-            end
-
-            def native_stop
-            end
-
-            def limited_description(description)
-              description
-            end
           end
 
-          @instrumenter = mock_instrumenter_klass.new(config).start!
+          start!(config)
         end
-
       end
     end
   end

data/lib/skylight/core/trace.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Skylight::Core
   class Trace
     GC_CAT = 'noise.gc'.freeze
@@ -5,10 +7,13 @@ module Skylight::Core
     include Util::Logging
 
     attr_reader :instrumenter, :endpoint, :notifications, :meta
+    attr_accessor :uuid
 
     def self.new(instrumenter, endpoint, start, cat, title=nil, desc=nil, meta=nil)
-      inst = native_new(normalize_time(start), "TODO", endpoint, meta)
+      uuid = SecureRandom.uuid
+      inst = native_new(normalize_time(start), uuid, endpoint, meta)
       inst.send(:initialize, instrumenter, cat, title, desc, meta)
+      inst.uuid = uuid
       inst.endpoint = endpoint
       inst
     end
@@ -40,6 +45,10 @@ module Skylight::Core
       @gc = config.gc.track unless ENV.key?("SKYLIGHT_DISABLE_GC_TRACKING")
     end
 
+    def log_context
+      @log_context ||= { trace: uuid }
+    end
+
     def endpoint=(value)
       @endpoint = value
       native_set_endpoint(value)
@@ -54,6 +63,11 @@ module Skylight::Core
       !!@broken
     end
 
+    def maybe_broken(e)
+      error "failed to instrument span; msg=%s; endpoint=%s", e.message, endpoint
+      broken!
+    end
+
     def record(cat, title=nil, desc=nil)
       return if broken?
 
@@ -68,8 +82,7 @@ module Skylight::Core
 
       nil
     rescue => e
-      error "failed to record span; msg=%s", e.message
-      broken!
+      maybe_broken(e)
       nil
     end
 
@@ -93,8 +106,7 @@ module Skylight::Core
 
       start(now - gc_time, cat, title, desc, meta)
     rescue => e
-      error "failed to instrument span; msg=%s", e.message
-      broken!
+      maybe_broken(e)
       nil
     end
 
@@ -104,7 +116,10 @@ module Skylight::Core
     end
 
     def done(span, meta=nil)
+      # `span` will be `nil` if we failed to start instrumenting, such as in
+      # the case of too many spans in a request.
       return unless span
+
       return if broken?
 
       if meta && (meta[:exception_object] || meta[:exception])
@@ -113,12 +128,13 @@ module Skylight::Core
 
       stop(span, Util::Clock.nanos - gc_time)
     rescue => e
-      error "failed to close span; msg=%s", e.message
+      error "failed to close span; msg=%s; endpoint=%s", e.message, endpoint
       broken!
       nil
     end
 
     def release
+      t { "release; is_current=#{@instrumenter.current_trace == self}" }
       return unless @instrumenter.current_trace == self
       @instrumenter.current_trace = nil
     end
@@ -129,28 +145,28 @@ module Skylight::Core
     end
 
     def traced
-      time = gc_time
+      gc = gc_time
       now = Util::Clock.nanos
-
-      if time > 0
-        t { fmt "tracking GC time; duration=%d", time }
-        stop(start(now - time, GC_CAT, nil, nil, nil), now)
-      end
-
+      track_gc(gc, now)
       stop(@root, now)
     end
 
     def submit
-      t { "submitting trace; broken=#{broken?}" }
+      t { "submitting trace" }
 
-      return if broken?
+      # This must always be called to clean up properly
+      release
+
+      if broken?
+        t { "broken, not submitting" }
+        return
+      end
 
       if @submitted
         t { "already submitted" }
         return
       end
 
-      release
       @submitted = true
 
       traced
@@ -163,6 +179,13 @@ module Skylight::Core
 
   private
 
+    def track_gc(time, now)
+      if time > 0
+        t { fmt "tracking GC time; duration=%d", time }
+        stop(start(now - time, GC_CAT, nil, nil, nil), now)
+      end
+    end
+
     def start(time, cat, title, desc, meta, opts={})
       time = self.class.normalize_time(time) unless opts[:normalize] == false
 
@@ -186,9 +209,15 @@ module Skylight::Core
         message = "[E0001] Spans were closed out of order. Expected to see '#{native_span_get_title(expected)}', " \
                     "but got '#{native_span_get_title(span)}' instead."
 
-        if native_span_get_category(span) == "rack.middleware"
-          message << "\n#{native_span_get_title(span)} may be a Middleware that doesn't fully conform " \
-                      "to the Rack SPEC."
+        if native_span_get_category(span) == "rack.middleware" &&
+            Probes.installed.keys.include?("ActionDispatch::MiddlewareStack::Middleware")
+          if Probes::Middleware::Probe.disabled?
+            message << "\nWe disabled the Middleware probe but unfortunately, this didn't solve the issue."
+          else
+            Probes::Middleware::Probe.disable!
+            message << "\n#{native_span_get_title(span)} may be a Middleware that doesn't fully conform " \
+                        "to the Rack SPEC. We've disabled the Middleware probe to see if that resolves the issue."
+          end
         end
 
         message << "\nThis request will not be tracked. Please contact support@skylight.io for more information."

data/lib/skylight/core/user_config.rb

@@ -8,6 +8,7 @@ module Skylight::Core
 
     def initialize(config)
       @config = config
+      @file_path = nil
       reload
     end
 

data/lib/skylight/core/util.rb

@@ -4,7 +4,6 @@ module Skylight::Core
     # Used from the main lib
     require 'skylight/core/util/allocation_free'
     require 'skylight/core/util/clock'
-    require 'skylight/core/util/deploy'
     require 'skylight/core/util/logging'
 
     # Used from the CLI

data/lib/skylight/core/util/logging.rb

@@ -9,7 +9,7 @@ module Skylight::Core
       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)
@@ -25,6 +25,10 @@ module Skylight::Core
 
     module Logging
 
+      def log_context
+        {}
+      end
+
       def log_env_prefix
         if c = config_for_logging
           c.class.env_prefix
@@ -114,6 +118,8 @@ module Skylight::Core
         c = config_for_logging
         logger = c ? c.logger : nil
 
+        msg = log_context.map{|(k,v)| "#{k}=#{v}; " }.join << msg
+
         if logger
           if logger.respond_to?(level)
             if args.length > 0
@@ -128,9 +134,11 @@ module Skylight::Core
         end
 
         # Fallback
-        module_name = self.is_a?(Module) ? name : self.class.name
-        root_name = module_name.split('::').first.upcase
-        puts sprintf("[#{root_name}] #{msg}", *args)
+        if module_name = self.is_a?(Module) ? name : self.class.name
+          root_name = module_name.split('::').first.upcase
+          msg.prepend("[#{root_name}] ")
+        end
+        puts sprintf(msg, *args)
       rescue Exception => e
         if trace?
           puts "[ERROR] #{e.message}"