skylight 3.1.4 → 5.3.4

data/lib/skylight/native.rb

@@ -1,23 +1,72 @@
-require 'skylight/core/util/platform'
+require "skylight/util/platform"
 
 module Skylight
+  # Some methods exepected to be defined by the native code (OUTDATED)
+  #
+  #   * Skylight::Util::Clock#native_hrtime
+  #       - returns current time in nanoseconds
+  #   * Skylight::Trace#native_new(start, uuid, endpoint)
+  #       - start is milliseconds
+  #       - uuid is currently unused
+  #       - endpoint is the endpoint name
+  #       - returns an instance of Trace
+  #   * Skylight::Trace#native_get_started_at
+  #       - returns the start time
+  #   * Skylight::Trace#native_get_endpoint
+  #       - returns the endpoint name
+  #   * Skylight::Trace#native_set_endpoint(endpoint)
+  #       - returns nil
+  #   * Skylight::Trace#native_get_uuid
+  #       - returns the uuid
+  #   * Skylight::Trace#native_start_span(time, category)
+  #       - time is milliseconds
+  #       - category is a string
+  #       - returns a numeric span id
+  #   * Skylight::Trace#native_stop_span(span, time)
+  #       - span is the span id
+  #       - time is milliseconds
+  #       - returns nil
+  #   * Skylight::Trace#native_span_set_title(span, title)
+  #       - span is the span id
+  #       - title is a string
+  #       - returns nil
+  #   * Skylight::Trace#native_span_set_description(span, desc)
+  #       - span is the span id
+  #       - desc is a string
+  #       - returns nil
+  #   * Skylight::Instrumenter#native_new(env)
+  #       - env is the config converted to a flattened array of ENV style values
+  #             e.g. `["SKYLIGHT_AUTHENTICATION", "abc123", ...]
+  #       - returns a new Instrumenter instance
+  #   * Skylight::Instrumenter#native_start()
+  #       - returns a truthy value if successful
+  #   * Skylight::Instrumenter#native_stop()
+  #       - returns nil
+  #   * Skylight::Instrumenter#native_submit_trace(trace)
+  #       - trace is a Trace instance
+  #       - returns nil
+  #   * Skylight::Instrumenter#native_track_desc(endpoint, description)
+  #       - endpoint is a string
+  #       - description is a string
+  #       - returns truthy unless uniqueness cap exceeded
+
   # @api private
   # Whether or not the native extension is present
-  @@has_native_ext = false
+  @has_native_ext = false
 
   def self.native?
-    @@has_native_ext
+    @has_native_ext
   end
 
   def self.libskylight_path
-    ENV['SKYLIGHT_LIB_PATH'] || File.expand_path("../native/#{Core::Util::Platform.tuple}", __FILE__)
+    ENV.fetch("SKYLIGHT_LIB_PATH") { File.expand_path("../native/#{Util::Platform.tuple}", __FILE__) }
   end
 
-  skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV['SKYLIGHT_REQUIRED'] !~ /^false$/i
+  skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV.fetch("SKYLIGHT_REQUIRED", nil) !~ /^false$/i
 
   begin
-    unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV['SKYLIGHT_DISABLE_AGENT'] !~ /^false$/i
-      lib = "#{libskylight_path}/libskylight.#{Core::Util::Platform.libext}"
+    unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV.fetch("SKYLIGHT_DISABLE_AGENT", nil) !~ /^false$/i
+      lib = "#{libskylight_path}/libskylight.#{Util::Platform.libext}"
 
       if File.exist?(lib)
         # First attempt to require the native extension
@@ -27,7 +76,7 @@ module Skylight
         load_libskylight(lib)
 
         # If nothing was thrown, then the native extension is present
-        @@has_native_ext = true
+        @has_native_ext = true
       elsif skylight_required
         raise LoadError, "Cannot find native extensions in #{libskylight_path}"
       end
@@ -35,15 +84,16 @@ module Skylight
   rescue RuntimeError => e
     # Old versions of OS X can have dlerrors, just treat it like a missing native
     raise if skylight_required || e.message !~ /dlerror/
-  rescue LoadError => e
+  rescue LoadError
     raise if skylight_required
   end
 
   if Skylight.native?
-    Skylight::Core::Util::Clock.use_native!
+    require "skylight/util/clock"
+    Util::Clock.use_native!
   else
     class Instrumenter
-      def self.native_new(*args)
+      def self.native_new(*_args)
         allocate
       end
     end
@@ -51,24 +101,22 @@ module Skylight
 
   # @api private
   def self.check_install_errors(config)
-    # Note: An unsupported arch doesn't count as an error.
-    install_log = File.expand_path("../../../ext/install.log", __FILE__)
+    # NOTE: An unsupported arch doesn't count as an error.
+    install_log = File.expand_path("../../ext/install.log", __dir__)
 
     if File.exist?(install_log) && File.read(install_log) =~ /ERROR/
-      config.alert_logger.error \
-          "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension failed to install. " \
-          "Please check #{install_log} and notify support@skylight.io. " \
-          "The missing extension will not affect the functioning of your application."
+      config.alert_logger.error "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension failed to install. " \
+                                  "Please check #{install_log} and notify support@skylight.io. " \
+                                  "The missing extension will not affect the functioning of your application."
     end
   end
 
   # @api private
   def self.warn_skylight_native_missing(config)
-    config.alert_logger.error \
-      "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension for " \
-      "your platform wasn't found. Supported operating systems are " \
-      "Linux 2.6.18+ and Mac OS X 10.8+. The missing extension will not " \
-      "affect the functioning of your application. If you are on a " \
-      "supported platform, please contact support at support@skylight.io."
+    config.alert_logger.error "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension for " \
+                                "your platform wasn't found. Supported operating systems are " \
+                                "Linux 2.6.18+ and Mac OS X 10.8+. The missing extension will not " \
+                                "affect the functioning of your application. If you are on a " \
+                                "supported platform, please contact support at support@skylight.io."
   end
 end

data/lib/skylight/native_ext_fetcher.rb

@@ -1,38 +1,31 @@
-require 'uri'
-require 'logger'
-require 'net/http'
-require 'fileutils'
-require 'digest/sha2'
-require 'open3'
-require 'skylight/util/ssl'
-require 'skylight/core/util/proxy'
+require "uri"
+require "logger"
+require "net/http"
+require "fileutils"
+require "digest/sha2"
+require "open3"
+require "skylight/util/ssl"
+require "skylight/util/proxy"
 
 # Used from extconf.rb
 module Skylight
   # Utility class for fetching the native extension from a URL
   class NativeExtFetcher
-    BASE_URL = "https://s3.amazonaws.com/skylight-agent-packages/skylight-native"
+    BASE_URL = "https://s3.amazonaws.com/skylight-agent-packages/skylight-native".freeze
     MAX_REDIRECTS = 5
     MAX_RETRIES = 3
 
     include FileUtils
 
-    class FetchError < StandardError; end
+    class FetchError < StandardError
+    end
 
     # Creates a new fetcher and fetches
     # @param opts [Hash]
-    def self.fetch(opts = {})
-      fetcher = new(
-        opts[:source] || BASE_URL,
-        opts[:target],
-        opts[:version],
-        opts[:checksum],
-        opts[:arch],
-        opts[:required],
-        opts[:platform],
-        opts[:logger] || Logger.new(STDOUT))
-
-      fetcher.fetch
+    def self.fetch(**args)
+      args[:source] ||= BASE_URL
+      args[:logger] ||= Logger.new($stdout)
+      new(**args).fetch
     end
 
     # @param source [String] the base url to download from
@@ -43,7 +36,7 @@ module Skylight
     # @param required [Boolean] whether the download is required to be successful
     # @param platform
     # @param log [Logger]
-    def initialize(source, target, version, checksum, arch, required, platform, log)
+    def initialize(source:, target:, version:, checksum:, arch:, logger:, required: false, platform: nil)
       raise "source required" unless source
       raise "target required" unless target
       raise "checksum required" unless checksum
@@ -56,7 +49,7 @@ module Skylight
       @required = required
       @platform = platform
       @arch = arch
-      @log = log
+      @logger = logger
     end
 
     # Fetch the native extension, verify, inflate, and save (if applicable)
@@ -64,11 +57,11 @@ module Skylight
     # @return [String] the inflated archive
     def fetch
       log "fetching native ext; curr-platform=#{@platform}; " \
-        "requested-arch=#{@arch}; version=#{@version}"
+            "requested-arch=#{@arch}; version=#{@version}"
 
       tar_gz = "#{@target}/#{basename}"
 
-      unless sha2 = fetch_native_ext(source_uri, tar_gz, MAX_RETRIES, MAX_REDIRECTS)
+      unless (sha2 = fetch_native_ext(source_uri, tar_gz, MAX_RETRIES, MAX_REDIRECTS))
         maybe_raise "could not fetch native extension"
         return
       end
@@ -91,7 +84,7 @@ module Skylight
     end
 
     def fetch_native_ext(uri, out, attempts, redirects)
-      redirects.times do |i|
+      redirects.times do
         # Ensure the location is available
         mkdir_p File.dirname(out)
         rm_f out
@@ -103,7 +96,7 @@ module Skylight
         begin
           host, port, use_ssl, path = deconstruct_uri(uri)
 
-          File.open out, 'w' do |f|
+          File.open out, "w" do |f|
             res, extra = http_get(host, port, use_ssl, path, f)
 
             case res
@@ -117,10 +110,12 @@ module Skylight
               next
             end
           end
-        rescue => e
+        rescue StandardError => e
           remaining_attempts -= 1
 
-          error "failed to fetch native extension; uri=#{uri}; msg=#{e.message}; remaining-attempts=#{remaining_attempts}", e
+          error "failed to fetch native extension; uri=#{uri}; msg=#{e.message}; " \
+                  "remaining-attempts=#{remaining_attempts}",
+                e
 
           if remaining_attempts > 0
             sleep 2
@@ -132,7 +127,7 @@ module Skylight
       end
 
       log "exceeded max redirects"
-      return
+      nil
     end
 
     # Get with `Net::HTTP`
@@ -145,19 +140,18 @@ module Skylight
     #
     # If `ENV['HTTP_PROXY']` is set, it will be used as a proxy for this request.
     def http_get(host, port, use_ssl, path, out)
-      if http_proxy = Core::Util::Proxy.detect_url(ENV)
+      if (http_proxy = Util::Proxy.detect_url(ENV))
         log "connecting with proxy: #{http_proxy}"
         uri = URI.parse(http_proxy)
-        p_host, p_port = uri.host, uri.port
+        p_host = uri.host
+        p_port = uri.port
         p_user, p_pass = uri.userinfo.split(/:/) if uri.userinfo
       end
 
       opts = {}
       opts[:use_ssl] = use_ssl
 
-      if use_ssl
-        opts[:ca_file] = Util::SSL.ca_cert_file_or_default
-      end
+      opts[:ca_file] = Util::SSL.ca_cert_file_or_default if use_ssl
 
       Net::HTTP.start(host, port, p_host, p_port, p_user, p_pass, use_ssl: use_ssl) do |http|
         http.request_get path do |resp|
@@ -170,13 +164,13 @@ module Skylight
               out.write chunk
             end
 
-            return [ :success, digest.hexdigest ]
+            return :success, digest.hexdigest
           when Net::HTTPRedirection
-            unless location = resp['location']
+            unless (location = resp["location"])
               raise "received redirect but no location"
             end
 
-            return [ :redirect, location ]
+            return :redirect, location
           else
             raise "received HTTP status code #{resp.code}"
           end
@@ -217,7 +211,7 @@ module Skylight
     # @return [Array<String>] the host, port, scheme, and request_uri
     def deconstruct_uri(uri)
       uri = URI(uri)
-      [ uri.host, uri.port, uri.scheme == 'https', uri.request_uri ]
+      [uri.host, uri.port, uri.scheme == "https", uri.request_uri]
     end
 
     # Log an error and raise if `required` is `true`
@@ -227,9 +221,7 @@ module Skylight
     def maybe_raise(err)
       error err
 
-      if @required
-        raise err
-      end
+      raise err if @required
     end
 
     # Log an `info` to the `logger`
@@ -238,7 +230,7 @@ module Skylight
     # @return [void]
     def log(msg)
       msg = "[SKYLIGHT] #{msg}"
-      @log.info msg
+      @logger.info msg
     end
 
     # Log an `error` to the `logger`
@@ -246,10 +238,10 @@ module Skylight
     # @param msg [String]
     # @param e [Exception] the exception associated with the error
     # @return [void]
-    def error(msg, e=nil)
+    def error(msg, err = nil)
       msg = "[SKYLIGHT] #{msg}"
-      msg << "\n#{e.backtrace.join("\n")}" if e
-      @log.error msg
+      msg << "\n#{err.backtrace.join("\n")}" if err
+      @logger.error msg
     end
   end
 end

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

@@ -0,0 +1,68 @@
+module Skylight
+  module Normalizers
+    module ActionController
+      # Normalizer for processing a Rails controller action
+      class ProcessAction < Normalizer
+        register "process_action.action_controller"
+
+        CAT = "app.controller.request".freeze
+
+        # Payload Keys: controller, action, params, format, method, path
+        #   Additional keys available in `normalize_after`: status, view_runtime
+        #     Along with ones added by probe: variant
+
+        # @param trace [Skylight::Messages::Trace::Builder]
+        # @param name [String] ignored, only present to match API
+        # @param payload [Hash]
+        # @option payload [String] :controller Controller name
+        # @option payload [String] :action Action name
+        # @return [Array]
+        def normalize(trace, _name, payload)
+          trace.endpoint = controller_action(payload)
+          [CAT, trace.endpoint, nil]
+        end
+
+        def normalize_after(trace, _span, _name, payload)
+          return unless config.enable_segments?
+
+          if (segment = segment_from_payload(payload))
+            trace.segment = segment
+          end
+        end
+
+        private
+
+        def controller_action(payload)
+          "#{payload[:controller]}##{payload[:action]}"
+        end
+
+        def process_meta_options(payload)
+          # provide hints to override default source_location behavior
+          super.merge(source_location_hint: [:instance_method, payload[:controller], payload[:action]])
+        end
+
+        def segment_from_payload(payload)
+          # Show 'error' if there's an unhandled exception or if the status is 4xx or 5xx
+          return "error" if payload[:exception] || payload[:exception_object]
+
+          segment_from_status(payload[:status]) || if payload[:sk_rendered_format]
+            # We only show the variant if we actually have a format
+            # We won't have a sk_rendered_format if it's a `head` outside of a `respond_to` block.
+            [payload[:sk_rendered_format], payload[:sk_variant]].compact.flatten.join("+")
+          end
+        end
+
+        def segment_from_status(status)
+          case status
+          when 304
+            "not modified"
+          when (300..399)
+            "redirect"
+          when (400..599)
+            "error"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Skylight
+  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)
+            title = TITLE
+
+            # depending on normalization, we probably want this to eventually
+            # include the full path, but we need to make sure we have a good
+            # deduping strategy first.
+            desc = nil
+
+            [CAT, title, desc]
+          end
+
+          private
+
+          OCTET_STREAM = "application/octet-stream".freeze
+          ATTACHMENT = "attachment".freeze
+
+          def initialize(*)
+            super
+
+            @mimes =
+              Mime::SET.each_with_object({}) do |mime, hash|
+                hash[mime.symbol] = mime.to_s.dup.freeze
+                hash
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/action_dispatch/process_middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Skylight
+  module Normalizers
+    module ActionDispatch
+      class ProcessMiddleware < Normalizer
+        register "process_middleware.action_dispatch"
+
+        CAT = "rack.middleware"
+        ANONYMOUS_MIDDLEWARE = "Anonymous Middleware"
+        ANONYMOUS = /\A#<(Class|Module|Proc):/.freeze
+
+        def normalize(trace, _name, payload)
+          name = payload[:middleware].to_s
+          name = ANONYMOUS_MIDDLEWARE if name[ANONYMOUS]
+          trace.endpoint = name
+          [CAT, name, nil]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/action_dispatch/route_set.rb

@@ -0,0 +1,27 @@
+module Skylight
+  module Normalizers
+    module ActionDispatch
+      class RouteSet < Normalizer
+        register "route_set.action_dispatch"
+
+        CAT = "rack.app".freeze
+
+        def normalize(trace, _name, _payload)
+          trace.endpoint = router_class_name
+          [CAT, trace.endpoint, nil]
+        end
+
+        private
+
+        def router_class_name
+          "ActionDispatch::Routing::RouteSet"
+        end
+
+        def process_meta_options(_payload)
+          # provide hints to override default source_location behavior
+          super.merge(source_location_hint: [:own_instance_method, router_class_name, "call"])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require "skylight/normalizers/render"
+
+module Skylight
+  module Normalizers
+    module ActionView
+      # Normalizer for Rails collection rendering
+      class RenderCollection < RenderNormalizer
+        register "render_collection.action_view"
+
+        CAT = "view.render.collection".freeze
+
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @option payload [Integer] :count
+        # @return (see RenderNormalizer#normalize_render)
+        def normalize(_trace, _name, payload)
+          normalize_render(CAT, payload)
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/action_view/render_layout.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "skylight/normalizers/render"
+
+module Skylight
+  module Normalizers
+    module ActionView
+      # Normalizer for Rails layout rendering
+      class RenderLayout < RenderNormalizer
+        register "render_layout.action_view"
+
+        CAT = "view.render.layout"
+
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @return (see RenderNormalizer#normalize_render)
+        def normalize(_trace, _name, payload)
+          normalize_render(CAT, payload)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require "skylight/normalizers/render"
+
+module Skylight
+  module Normalizers
+    module ActionView
+      # Normalizer for Rails partial rendering
+      class RenderPartial < RenderNormalizer
+        register "render_partial.action_view"
+
+        CAT = "view.render.template".freeze
+
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @return (see RenderNormalizer#normalize_render)
+        def normalize(_trace, _name, payload)
+          normalize_render(CAT, payload)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require "skylight/normalizers/render"
+
+module Skylight
+  module Normalizers
+    module ActionView
+      # Normalizer for Rails template rendering
+      class RenderTemplate < RenderNormalizer
+        register "render_template.action_view"
+
+        CAT = "view.render.template".freeze
+
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @return (see RenderNormalizer#normalize_render)
+        def normalize(_trace, _name, payload)
+          normalize_render(CAT, payload)
+        end
+      end
+    end
+  end
+end