skylight-core 3.1.5 → 4.0.0.alpha

data/lib/skylight/core/trace.rb

@@ -1,20 +1,21 @@
-require 'securerandom'
+require "securerandom"
 
 module Skylight::Core
   class Trace
-    GC_CAT = 'noise.gc'.freeze
+    GC_CAT = "noise.gc".freeze
 
     include Util::Logging
 
     attr_reader :instrumenter, :endpoint, :notifications, :meta
-    attr_accessor :uuid
+    attr_accessor :uuid, :segment
 
-    def self.new(instrumenter, endpoint, start, cat, title=nil, desc=nil, meta=nil)
+    def self.new(instrumenter, endpoint, start, cat, title = nil, desc = nil, meta = nil, segment: nil)
       uuid = SecureRandom.uuid
       inst = native_new(normalize_time(start), uuid, endpoint, meta)
       inst.uuid = uuid
       inst.send(:initialize, instrumenter, cat, title, desc, meta)
       inst.endpoint = endpoint
+      inst.segment = segment
       inst
     end
 
@@ -26,7 +27,7 @@ module Skylight::Core
     end
 
     def initialize(instrumenter, cat, title, desc, meta)
-      raise ArgumentError, 'instrumenter is required' unless instrumenter
+      raise ArgumentError, "instrumenter is required" unless instrumenter
 
       @instrumenter = instrumenter
       @submitted = false
@@ -52,7 +53,6 @@ module Skylight::Core
     def endpoint=(value)
       @endpoint = value
       native_set_endpoint(value)
-      value
     end
 
     def config
@@ -63,12 +63,12 @@ module Skylight::Core
       !!@broken
     end
 
-    def maybe_broken(e)
-      error "failed to instrument span; msg=%s; endpoint=%s", e.message, endpoint
+    def maybe_broken(err)
+      error "failed to instrument span; msg=%s; endpoint=%s", err.message, endpoint
       broken!
     end
 
-    def record(cat, title=nil, desc=nil)
+    def record(cat, title = nil, desc = nil)
       return if broken?
 
       title.freeze if title.is_a?(String)
@@ -86,7 +86,7 @@ module Skylight::Core
       nil
     end
 
-    def instrument(cat, title=nil, desc=nil, meta=nil)
+    def instrument(cat, title = nil, desc = nil, meta = nil)
       return if broken?
       t { "instrument: #{cat}, #{title}" }
 
@@ -115,7 +115,7 @@ module Skylight::Core
       native_span_get_correlation_header(span)
     end
 
-    def done(span, meta=nil)
+    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
@@ -187,89 +187,89 @@ module Skylight::Core
       t { e.backtrace.join("\n") }
     end
 
-  private
+    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)
+      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
-    end
 
-    def start(time, cat, title, desc, meta, opts={})
-      time = self.class.normalize_time(time) unless opts[:normalize] == false
+      def start(time, cat, title, desc, meta, opts = {})
+        time = self.class.normalize_time(time) unless opts[:normalize] == false
 
-      sp = native_start_span(time, cat.to_s)
-      native_span_set_title(sp, title.to_s) if title
-      native_span_set_description(sp, desc.to_s) if desc
-      native_span_set_meta(sp, meta) if meta
-      native_span_started(sp)
+        sp = native_start_span(time, cat.to_s)
+        native_span_set_title(sp, title.to_s) if title
+        native_span_set_description(sp, desc.to_s) if desc
+        native_span_set_meta(sp, meta) if meta
+        native_span_started(sp)
 
-      @spans << sp
-      t { "started span: #{sp} - #{cat}, #{title}" }
+        @spans << sp
+        t { "started span: #{sp} - #{cat}, #{title}" }
 
-      sp
-    end
+        sp
+      end
 
-    # Middleware spans that were interrupted by a throw/catch should be cached here.
-    # keys: span ids
-    # values: nsec timestamp at which the span was cached here.
-    def deferred_spans
-      @deferred_spans ||= {}
-    end
+      # Middleware spans that were interrupted by a throw/catch should be cached here.
+      # keys: span ids
+      # values: nsec timestamp at which the span was cached here.
+      def deferred_spans
+        @deferred_spans ||= {}
+      end
 
-    def stop(span, time)
-      t { "stopping span: #{span}" }
+      def stop(span, time)
+        t { "stopping span: #{span}" }
 
-      # If `stop` is called for a span that is not the last item in the stack,
-      # check to see if the last item has been marked as deferred. If so, close
-      # that span first, then try to close the original.
-      while deferred_spans[expected = @spans.pop]
-        normalized_stop(expected, deferred_spans.delete(expected))
-      end
+        # If `stop` is called for a span that is not the last item in the stack,
+        # check to see if the last item has been marked as deferred. If so, close
+        # that span first, then try to close the original.
+        while deferred_spans[expected = @spans.pop]
+          normalized_stop(expected, deferred_spans.delete(expected))
+        end
 
-      handle_unexpected_stop(expected, span) unless span == expected
+        handle_unexpected_stop(expected, span) unless span == expected
 
-      normalized_stop(span, time)
-      nil
-    end
+        normalized_stop(span, time)
+        nil
+      end
 
-    def normalized_stop(span, time)
-      time = self.class.normalize_time(time)
-      native_stop_span(span, time)
-    end
+      def normalized_stop(span, time)
+        time = self.class.normalize_time(time)
+        native_stop_span(span, time)
+      end
 
-    # Originally extracted from `stop`.
-    # If we attempt to close spans out of order, and it appears to be a middleware issue,
-    # disable the middleware probe and mark trace as broken.
-    def handle_unexpected_stop(expected, span)
-      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" &&
-          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."
+      # Originally extracted from `stop`.
+      # If we attempt to close spans out of order, and it appears to be a middleware issue,
+      # disable the middleware probe and mark trace as broken.
+      def handle_unexpected_stop(expected, span)
+        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" &&
+           Probes.installed.key?("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
-      end
 
-      message << "\nThis request will not be tracked. Please contact #{config.class.support_email} for more information."
+        message << "\nThis request will not be tracked. Please contact #{config.class.support_email} for more information."
 
-      error message
+        error message
 
-      t { "expected=#{expected}, actual=#{span}" }
+        t { "expected=#{expected}, actual=#{span}" }
 
-      broken!
-    end
+        broken!
+      end
 
-    def gc_time
-      return 0 unless @gc
-      @gc.update
-      @gc.time
-    end
+      def gc_time
+        return 0 unless @gc
+        @gc.update
+        @gc.time
+      end
   end
 end

data/lib/skylight/core/user_config.rb

@@ -1,9 +1,8 @@
-require 'yaml'
-require 'skylight/core/errors'
+require "yaml"
+require "skylight/core/errors"
 
 module Skylight::Core
   class UserConfig
-
     attr_accessor :disable_dev_warning, :disable_env_warning
 
     def initialize(config)
@@ -17,7 +16,7 @@ module Skylight::Core
 
       config_path = @config[:user_config_path] || begin
         require "etc"
-        home_dir = ENV['HOME'] || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV['USER']}"))
+        home_dir = ENV["HOME"] || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV['USER']}"))
         if home_dir
           File.join(home_dir, ".skylight")
         else
@@ -29,7 +28,7 @@ module Skylight::Core
     end
 
     def disable_dev_warning?
-      disable_dev_warning || ENV['SKYLIGHT_DISABLE_DEV_WARNING'] =~ /^true$/i
+      disable_dev_warning || ENV["SKYLIGHT_DISABLE_DEV_WARNING"] =~ /^true$/i
     end
 
     def disable_env_warning?
@@ -40,23 +39,22 @@ module Skylight::Core
       config = File.exist?(file_path) ? YAML.load_file(file_path) : false
       return unless config
 
-      self.disable_dev_warning = !!config['disable_dev_warning']
-      self.disable_env_warning = !!config['disable_env_warning']
+      self.disable_dev_warning = !!config["disable_dev_warning"]
+      self.disable_env_warning = !!config["disable_env_warning"]
     end
 
     def save
       FileUtils.mkdir_p(File.dirname(file_path))
-      File.open(file_path, 'w') do |f|
+      File.open(file_path, "w") do |f|
         f.puts YAML.dump(to_hash)
       end
     end
 
     def to_hash
       {
-        'disable_dev_warning' => disable_dev_warning,
-        'disable_env_warning' => disable_env_warning
+        "disable_dev_warning" => disable_dev_warning,
+        "disable_env_warning" => disable_env_warning
       }
     end
-
   end
 end

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

@@ -2,7 +2,6 @@ module Skylight::Core
   module Util
     # Helpers to reduce memory allocation
     module AllocationFree
-
       # Find an item in an array without allocation.
       #
       # @param array [Array] the array to search

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

@@ -2,7 +2,6 @@ module Skylight::Core
   module Util
     # A more precise clock
     class Clock
-
       def self.use_native!
         class_eval do
           def tick
@@ -11,10 +10,12 @@ module Skylight::Core
         end
       end
 
+      # rubocop:disable Lint/DuplicateMethods
       def tick
         now = Time.now
         now.to_i * 1_000_000_000 + now.usec * 1_000
       end
+      # rubocop:enable Lint/DuplicateMethods
 
       # TODO: rename to secs
       def absolute_secs
@@ -31,26 +32,25 @@ module Skylight::Core
         nanos / 1_000_000_000
       end
 
-      def self.absolute_secs
-        default.absolute_secs
-      end
+      class << self
+        def absolute_secs
+          default.absolute_secs
+        end
 
-      def self.nanos
-        default.nanos
-      end
+        def nanos
+          default.nanos
+        end
 
-      def self.secs
-        default.secs
-      end
+        def secs
+          default.secs
+        end
 
-      def self.default
-        @clock ||= Clock.new
-      end
+        def default
+          @default ||= Clock.new
+        end
 
-      def self.default=(clock)
-        @clock = clock
+        attr_writer :default
       end
-
     end
   end
 end

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

@@ -1,10 +1,9 @@
-require 'zlib'
+require "zlib"
 
 module Skylight::Core
   module Util
     # Provides Gzip compressing support
     module Gzip
-
       # Compress a string with Gzip
       #
       # @param str [String] uncompressed string

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

@@ -1,6 +1,7 @@
+# rubocop:disable all
+
 module Skylight::Core
   module Util
-
     # String Inflector methods
     #
     # From https://github.com/rails/rails/blob/f8e5022c73679f41db9bb6743179bab4571fb28e/activesupport/lib/active_support/inflector/methods.rb
@@ -26,7 +27,7 @@ module Skylight::Core
       # NameError is raised when the name is not in CamelCase or the constant is
       # unknown.
       def constantize(camel_cased_word)
-        names = camel_cased_word.split('::')
+        names = camel_cased_word.split("::")
 
         # Trigger a builtin NameError exception including the ill-formed constant in the message.
         Object.const_get(camel_cased_word) if names.empty?
@@ -105,8 +106,8 @@ module Skylight::Core
           part.empty? ? acc : "#{part}(::#{acc})?"
         end
 
-        "(" + ([regexp] + parts[1..-1]).join('|') + ")"
+        "(" + ([regexp] + parts[1..-1]).join("|") + ")"
       end
     end
   end
-end
+end

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

@@ -1,4 +1,4 @@
-require 'logger'
+require "logger"
 
 module Skylight::Core
   module Util
@@ -19,18 +19,16 @@ module Skylight::Core
         end
       end
 
-      def close
-      end
+      def close; end
     end
 
     module Logging
-
       def log_context
         {}
       end
 
       def log_env_prefix
-        if c = config_for_logging
+        if (c = config_for_logging)
           c.class.env_prefix
         else
           "SKYLIGHT_"
@@ -88,7 +86,7 @@ module Skylight::Core
       # @param args (see #log)
       def error(msg, *args)
         log :error, msg, *args
-        raise sprintf(msg, *args) if raise_on_error?
+        raise format(msg, *args) if raise_on_error?
       end
 
       alias log_trace trace
@@ -106,7 +104,7 @@ module Skylight::Core
       def config_for_logging
         if respond_to?(:config)
           config
-        elsif self.is_a?(Config)
+        elsif is_a?(Config)
           self
         end
       end
@@ -118,12 +116,12 @@ module Skylight::Core
         c = config_for_logging
         logger = c ? c.logger : nil
 
-        msg = log_context.map{|(k,v)| "#{k}=#{v}; " }.join << msg
+        msg = log_context.map { |(k, v)| "#{k}=#{v}; " }.join << msg
 
         if logger
           if logger.respond_to?(level)
-            if args.length > 0
-              logger.send level, sprintf(msg, *args)
+            if !args.empty?
+              logger.send level, format(msg, *args)
             else
               logger.send level, msg
             end
@@ -134,18 +132,17 @@ module Skylight::Core
         end
 
         # Fallback
-        if module_name = self.is_a?(Module) ? name : self.class.name
-          root_name = module_name.split('::').first.upcase
+        if (module_name = is_a?(Module) ? name : self.class.name)
+          root_name = module_name.split("::").first.upcase
           msg.prepend("[#{root_name}] ")
         end
-        puts sprintf(msg, *args)
+        puts format(msg, *args)
       rescue Exception => e
         if trace?
           puts "[ERROR] #{e.message}"
           puts e.backtrace
         end
       end
-
     end
   end
 end

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

@@ -1,4 +1,4 @@
-require 'rbconfig'
+require "rbconfig"
 
 # Used from extconf and to load libskylight
 module Skylight
@@ -6,59 +6,62 @@ module Skylight
     module Util
       module Platform
         # Normalize the platform OS
-        OS = case os = RbConfig::CONFIG['host_os'].downcase
-        when /linux/
-          # The official ruby-alpine Docker containers pre-build Ruby. As a result,
-          #   Ruby doesn't know that it's on a musl-based platform. `ldd` is the
-          #   only reliable way to detect musl that we've found.
-          # See https://github.com/skylightio/skylight-ruby/issues/92
-          if ENV['SKYLIGHT_MUSL'] || `ldd --version 2>&1` =~ /musl/
-            "linux-musl"
+        OS =
+          case os = RbConfig::CONFIG["host_os"].downcase
+          when /linux/
+            # The official ruby-alpine Docker containers pre-build Ruby. As a result,
+            #   Ruby doesn't know that it's on a musl-based platform. `ldd` is the
+            #   only reliable way to detect musl that we've found.
+            # See https://github.com/skylightio/skylight-ruby/issues/92
+            if ENV["SKYLIGHT_MUSL"] || `ldd --version 2>&1` =~ /musl/
+              "linux-musl"
+            else
+              "linux"
+            end
+          when /darwin/
+            "darwin"
+          when /freebsd/
+            "freebsd"
+          when /netbsd/
+            "netbsd"
+          when /openbsd/
+            "openbsd"
+          when /sunos|solaris/
+            "solaris"
+          when /mingw|mswin/
+            "windows"
           else
-            "linux"
+            os
           end
-        when /darwin/
-          "darwin"
-        when /freebsd/
-          "freebsd"
-        when /netbsd/
-          "netbsd"
-        when /openbsd/
-          "openbsd"
-        when /sunos|solaris/
-          "solaris"
-        when /mingw|mswin/
-          "windows"
-        else
-          os
-        end
 
         # Normalize the platform CPU
-        ARCH = case cpu = RbConfig::CONFIG['host_cpu'].downcase
-        when /amd64|x86_64/
-          "x86_64"
-        when /i?86|x86|i86pc/
-          "x86"
-        when /ppc|powerpc/
-          "powerpc"
-        when /^arm/
-          "arm"
-        else
-          cpu
-        end
+        ARCH =
+          case cpu = RbConfig::CONFIG["host_cpu"].downcase
+          when /amd64|x86_64/
+            "x86_64"
+          when /i?86|x86|i86pc/
+            "x86"
+          when /ppc|powerpc/
+            "powerpc"
+          when /^arm/
+            "arm"
+          else
+            cpu
+          end
 
-        LIBEXT = case OS
-        when /darwin/
-          'dylib'
-        when /linux|bsd|solaris/
-          'so'
-        when /windows|cygwin/
-          'dll'
-        else
-          'so'
-        end
+        LIBEXT =
+          case OS
+          when /darwin/
+            "dylib"
+          when /linux|bsd|solaris/
+            "so"
+          when /windows|cygwin/
+            "dll"
+          else
+            "so"
+          end
 
-        TUPLE = "#{ARCH}-#{OS}"
+        TUPLE = "#{ARCH}-#{OS}".freeze
 
         def self.tuple
           TUPLE
@@ -69,7 +72,7 @@ module Skylight
         end
 
         def self.dlext
-          RbConfig::CONFIG['DLEXT']
+          RbConfig::CONFIG["DLEXT"]
         end
       end
     end

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

@@ -2,12 +2,12 @@ module Skylight::Core
   module Util
     module Proxy
       def self.detect_url(env)
-        u = env['HTTP_PROXY'] || env['http_proxy']
+        u = env["HTTP_PROXY"] || env["http_proxy"]
         if u && !u.empty?
-          u = "http://#{u}" unless u =~ %r[://]
+          u = "http://#{u}" unless u =~ %r{://}
           u
         end
       end
     end
   end
-end
+end

data/lib/skylight/core/util.rb

@@ -2,12 +2,12 @@ module Skylight::Core
   # @api private
   module Util
     # Used from the main lib
-    require 'skylight/core/util/allocation_free'
-    require 'skylight/core/util/clock'
-    require 'skylight/core/util/logging'
+    require "skylight/core/util/allocation_free"
+    require "skylight/core/util/clock"
+    require "skylight/core/util/logging"
 
     # Used from the CLI
-    autoload :Gzip,      'skylight/core/util/gzip'
-    autoload :Inflector, 'skylight/core/util/inflector'
+    autoload :Gzip,      "skylight/core/util/gzip"
+    autoload :Inflector, "skylight/core/util/inflector"
   end
 end

data/lib/skylight/core/version.rb

@@ -1,6 +1,5 @@
 module Skylight
   module Core
-    VERSION = '3.1.5'
+    VERSION = "4.0.0-alpha".freeze
   end
 end
-

data/lib/skylight/core/vm/gc.rb

@@ -1,4 +1,3 @@
-
 module Skylight::Core
   # @api private
   module VM
@@ -57,8 +56,7 @@ module Skylight::Core
     unless defined?(VM::GC)
 
       class GC
-        def enable
-        end
+        def enable; end
 
         def total_time
           0