skylight 3.1.5 → 4.0.0.alpha

data/lib/skylight/native.rb

@@ -1,22 +1,22 @@
-require 'skylight/core/util/platform'
+require "skylight/core/util/platform"
 
 module Skylight
   # @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["SKYLIGHT_LIB_PATH"] || File.expand_path("../native/#{Core::Util::Platform.tuple}", __FILE__)
   end
 
-  skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV['SKYLIGHT_REQUIRED'] !~ /^false$/i
+  skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
 
   begin
-    unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV['SKYLIGHT_DISABLE_AGENT'] !~ /^false$/i
+    unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV["SKYLIGHT_DISABLE_AGENT"] !~ /^false$/i
       lib = "#{libskylight_path}/libskylight.#{Core::Util::Platform.libext}"
 
       if File.exist?(lib)
@@ -27,7 +27,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,7 +35,7 @@ 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
 
@@ -43,7 +43,7 @@ module Skylight
     Skylight::Core::Util::Clock.use_native!
   else
     class Instrumenter
-      def self.native_new(*args)
+      def self.native_new(*_args)
         allocate
       end
     end
@@ -52,13 +52,13 @@ 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__)
+    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."
+        "[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
 

data/lib/skylight/native_ext_fetcher.rb

@@ -1,17 +1,17 @@
-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/core/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
 
@@ -21,18 +21,10 @@ module Skylight
 
     # 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 +35,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:, required: false, platform: nil, logger:)
       raise "source required" unless source
       raise "target required" unless target
       raise "checksum required" unless checksum
@@ -56,7 +48,7 @@ module Skylight
       @required = required
       @platform = platform
       @arch = arch
-      @log = log
+      @logger = logger
     end
 
     # Fetch the native extension, verify, inflate, and save (if applicable)
@@ -68,7 +60,7 @@ module Skylight
 
       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 +83,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 +95,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
@@ -132,7 +124,7 @@ module Skylight
       end
 
       log "exceeded max redirects"
-      return
+      nil
     end
 
     # Get with `Net::HTTP`
@@ -145,10 +137,11 @@ 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 = Core::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
 
@@ -170,13 +163,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 +210,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`
@@ -238,7 +231,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 +239,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/probes/sinatra_add_middleware.rb

@@ -4,10 +4,10 @@ module Skylight
       class Probe
         def install
           class << ::Sinatra::Base
-            alias build_without_sk build
+            alias_method :build_without_sk, :build
 
             def build(*args, &block)
-              self.use Skylight::Middleware
+              use Skylight::Middleware
               build_without_sk(*args, &block)
             end
           end

data/lib/skylight/railtie.rb

@@ -1,16 +1,18 @@
-require 'skylight/core/railtie'
+require "skylight/core/railtie"
 
 module Skylight
   class Railtie < Rails::Railtie
     include Skylight::Core::Railtie
 
+    # rubocop:disable Style/SingleLineMethods, Layout/EmptyLineBetweenDefs
     def self.config_class; Skylight::Config end
     def self.middleware_class; Skylight::Middleware end
+    # rubocop:enable Style/SingleLineMethods, Layout/EmptyLineBetweenDefs
 
     config.skylight = ActiveSupport::OrderedOptions.new
 
     # The environments in which skylight should be enabled
-    config.skylight.environments = ['production']
+    config.skylight.environments = ["production"]
 
     # The path to the configuration file
     config.skylight.config_path = "config/skylight.yml"
@@ -19,29 +21,51 @@ module Skylight
     #   net_http, action_controller, action_dispatch, action_view, and middleware are on by default
     #   See https://www.skylight.io/support/getting-more-from-skylight#available-instrumentation-options
     #   for a full list.
-    config.skylight.probes = ['net_http', 'action_controller', 'action_dispatch', 'action_view', 'middleware', 'active_job_enqueue']
+    config.skylight.probes = %w[net_http action_controller action_dispatch action_view middleware active_job_enqueue]
 
     # The position in the middleware stack to place Skylight
     # Default is first, but can be `{ after: Middleware::Name }` or `{ before: Middleware::Name }`
     config.skylight.middleware_position = 0
 
-    initializer 'skylight.configure' do |app|
+    initializer "skylight.configure" do |app|
       run_initializer(app)
     end
 
     private
 
+      def activate?(sk_config)
+        return false unless super && sk_config
+        activate_for_worker?(sk_config) || activate_for_web?(sk_config)
+      end
+
+      # We must have an opt-in signal
+      def activate_for_worker?(sk_config)
+        return unless sk_config.worker_context?
+
+        reasons = []
+        reasons << "the 'active_job' probe is enabled" if sk_rails_config.probes.include?("active_job")
+        reasons << "SKYLIGHT_ENABLE_SIDEKIQ is set" if sk_config.enable_sidekiq?
+
+        return if reasons.empty?
+
+        sk_config.logger.warn("Activating Skylight for Background Jobs (alpha) because #{reasons.to_sentence}")
+        true
+      end
+
+      def activate_for_web?(sk_config)
+        sk_config.web_context?
+      end
+
       def development_warning
         super + "\n(To disable this message for all local apps, run `skylight disable_dev_warning`.)"
       end
 
       def load_skylight_config(app)
-        super.tap do |config|
-          if config[:report_rails_env]
-            config[:env] ||= Rails.env.to_s
+        super.tap do |sk_config|
+          if sk_config && sk_config[:report_rails_env]
+            sk_config[:env] ||= Rails.env.to_s
           end
         end
       end
-
   end
 end

data/lib/skylight/sinatra.rb

@@ -1,2 +1,2 @@
-require 'skylight'
+require "skylight"
 Skylight.probe(:sinatra_add_middleware, :sinatra, :tilt, :sequel)

data/lib/skylight/trace.rb

@@ -23,8 +23,8 @@ module Skylight
       !!@too_many_spans
     end
 
-    def maybe_broken(e)
-      if e.is_a?(Skylight::MaximumTraceSpansError) && config.get(:report_max_spans_exceeded)
+    def maybe_broken(error)
+      if error.is_a?(Skylight::MaximumTraceSpansError) && config.get(:report_max_spans_exceeded)
         too_many_spans!
       else
         super
@@ -33,8 +33,8 @@ module Skylight
 
     def traced
       if too_many_spans?
-          error("[E%04d] The request exceeded the maximum number of spans allowed. It will still " \
-                  "be tracked but with reduced information. endpoint=%s", Skylight::MaximumTraceSpansError.code, endpoint)
+        error("[E%04d] The request exceeded the maximum number of spans allowed. It will still " \
+              "be tracked but with reduced information. endpoint=%s", Skylight::MaximumTraceSpansError.code, endpoint)
       end
 
       super
@@ -51,6 +51,5 @@ module Skylight
       def use_pruning?
         config.get(:prune_large_traces)
       end
-
   end
 end

data/lib/skylight/util/component.rb

@@ -1,33 +1,98 @@
 module Skylight
   module Util
     class Component
-
       attr_accessor :environment, :name
 
       NAME_FORMAT = /\A[a-z0-9-]+\z/
-      DEFAULT_NAME = 'web'.freeze
-      DEFAULT_ENVIRONMENT = 'production'.freeze
+      DEFAULT_NAME = "web".freeze
+      WORKER_NAME = "worker".freeze
+      DEFAULT_ENVIRONMENT = "production".freeze
+
+      WORKER_PROGRAM_MATCHER = Regexp.union [
+        /sidekiq$/i,
+        /backburner$/i,
+        /delayed_job$/i,
+        /que$/i,
+        /sneakers$/i
+      ]
+
+      WORKER_RAKE_MATCHER = Regexp.union [
+        /\Aresque:/,
+        /\Abackburner:/,
+        /\Ajobs:/, # DelayedJob. can also be `rake jobs:workoff`
+        /\Aqu:/,
+        /\Aque:/,
+        /\Aqc:/,
+        /\Asneakers:/
+      ]
 
       def initialize(environment, name)
         @environment = environment || DEFAULT_ENVIRONMENT
-        @name        = name || DEFAULT_NAME
+        @name        = resolve_name(name)
 
         raise ArgumentError, "environment can't be blank" if @environment.empty?
-        validate_string!(@environment, 'environment')
-        validate_string!(@name, 'name')
+        validate_string!(@environment, "environment")
+        validate_string!(@name, "name")
       end
 
       def to_s
         "#{name}:#{environment}"
       end
 
-      private
+      def web?
+        name == DEFAULT_NAME
+      end
 
-      def validate_string!(string, kind)
-        return true if string =~ NAME_FORMAT
-        raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
+      def worker?
+        !web?
       end
+
+      # keys here should match those from the main config
+      def as_json(*)
+        {
+          component: name,
+          env: environment
+        }
+      end
+
+      private
+
+        def program_name
+          $PROGRAM_NAME
+        end
+
+        def argv
+          ARGV
+        end
+
+        def resolve_name(given_name)
+          return DEFAULT_NAME if known_web_context?
+          return given_name if given_name
+          return WORKER_NAME if known_worker_context?
+          DEFAULT_NAME
+        end
+
+        def validate_string!(string, kind)
+          return true if string =~ NAME_FORMAT
+          raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
+        end
+
+        def known_web_context?
+          rails_server? || rackup?
+        end
+
+        def known_worker_context?
+          return true if program_name =~ WORKER_PROGRAM_MATCHER
+          program_name[/rake$/] && argv.any? { |arg| arg =~ WORKER_RAKE_MATCHER }
+        end
+
+        def rails_server?
+          defined?(Rails::Server)
+        end
+
+        def rackup?
+          program_name[/rackup$/]
+        end
     end
   end
 end
-