skylight-core 3.1.5 → 4.0.0.alpha

data/lib/skylight/core/probes.rb

@@ -1,4 +1,4 @@
-require 'pathname'
+require "pathname"
 
 module Skylight::Core
   # @api private
@@ -19,7 +19,6 @@ module Skylight::Core
     end
 
     class << self
-
       def paths
         @paths ||= []
       end
@@ -27,7 +26,7 @@ module Skylight::Core
       def add_path(path)
         root = Pathname.new(path)
         Pathname.glob(root.join("./**/*.rb")).each do |f|
-          name = f.relative_path_from(root).sub_ext('').to_s
+          name = f.relative_path_from(root).sub_ext("").to_s
           if available.key?(name)
             raise "duplicate probe name: #{name}; original=#{available[name]}; new=#{f}"
           end
@@ -58,14 +57,14 @@ module Skylight::Core
         @installed ||= {}
       end
 
-      def is_available?(klass_name)
+      def available?(klass_name)
         !!Skylight::Core::Util::Inflector.safe_constantize(klass_name)
       end
 
       def register(name, *args)
         registration = ProbeRegistration.new(name, *args)
 
-        if is_available?(registration.klass_name)
+        if available?(registration.klass_name)
           installed[registration.klass_name] = registration
           registration.install
         else
@@ -78,7 +77,7 @@ module Skylight::Core
         return unless registration
 
         # Double check constant is available
-        if is_available?(registration.klass_name)
+        if available?(registration.klass_name)
           installed[registration.klass_name] = registration
           registration.install
 
@@ -113,17 +112,17 @@ end
 module ::Kernel
   private
 
-  alias require_without_sk require
+    alias require_without_sk require
 
-  def require(name)
-    ret = require_without_sk(name)
+    def require(name)
+      ret = require_without_sk(name)
 
-    begin
-      Skylight::Core::Probes.require_hook(name)
-    rescue Exception
-      # FIXME: Log these errors
-    end
+      begin
+        Skylight::Core::Probes.require_hook(name)
+      rescue Exception
+        # FIXME: Log these errors
+      end
 
-    ret
-  end
-end
+      ret
+    end
+end

data/lib/skylight/core/railtie.rb

@@ -1,5 +1,5 @@
-require 'skylight/core'
-require 'rails'
+require "skylight/core"
+require "rails"
 
 module Skylight::Core
   # @api private
@@ -7,160 +7,161 @@ module Skylight::Core
     extend ActiveSupport::Concern
 
     included do
+      # rubocop:disable Style/SingleLineMethods, Layout/EmptyLineBetweenDefs
       def self.root_key; :skylight end
       def self.config_class; Config end
       def self.middleware_class; Middleware end
-      def self.gem_name; 'Skylight' end
-      def self.log_file_name; 'skylight' end
+      def self.gem_name; "Skylight" end
+      def self.log_file_name; "skylight" end
       def self.namespace; Skylight end
       def self.version; Skylight::Core::VERSION end
+      # rubocop:enable Style/SingleLineMethods, Layout/EmptyLineBetweenDefs
     end
 
-  private
+    private
 
-    def log_prefix
-      "[#{self.class.gem_name.upcase}] [#{self.class.version}]"
-    end
-
-    def development_warning
-      "#{log_prefix} Running #{self.class.gem_name} in development mode. No data will be reported until you deploy your app."
-    end
-
-    def run_initializer(app)
-      # Load probes even when agent is inactive to catch probe related bugs sooner
-      load_probes
+      def log_prefix
+        "[#{self.class.gem_name.upcase}] [#{self.class.version}]"
+      end
 
-      config = load_skylight_config(app)
+      def development_warning
+        "#{log_prefix} Running #{self.class.gem_name} in development mode. No data will be reported until you deploy your app."
+      end
 
-      if activate?
-        if config
-          begin
-            if self.class.namespace.start!(config)
-              set_middleware_position(app, config)
-              Rails.logger.info "#{log_prefix} #{self.class.gem_name} agent enabled"
-            else
-              Rails.logger.info "#{log_prefix} Unable to start, see the #{self.class.gem_name} logs for more details"
+      def run_initializer(app)
+        # Load probes even when agent is inactive to catch probe related bugs sooner
+        load_probes
+
+        config = load_skylight_config(app)
+
+        if activate?(config)
+          if config
+            begin
+              if self.class.namespace.start!(config)
+                set_middleware_position(app, config)
+                Rails.logger.info "#{log_prefix} #{self.class.gem_name} agent enabled"
+              else
+                Rails.logger.info "#{log_prefix} Unable to start, see the #{self.class.gem_name} logs for more details"
+              end
+            rescue ConfigError => e
+              Rails.logger.error "#{log_prefix} #{e.message}; disabling #{self.class.gem_name} agent"
             end
-          rescue ConfigError => e
-            Rails.logger.error "#{log_prefix} #{e.message}; disabling #{self.class.gem_name} agent"
           end
-        end
-      elsif Rails.env.development?
-        # FIXME: The CLI isn't part of core so we should change this message
-        unless config.user_config.disable_dev_warning?
-          log_warning config, development_warning
-        end
-      elsif !Rails.env.test?
-        unless config.user_config.disable_env_warning?
-          log_warning config, "#{log_prefix} You are running in the #{Rails.env} environment but haven't added it to config.#{self.class.root_key}.environments, so no data will be sent to #{config.class.service_name} servers."
+        elsif Rails.env.development?
+          # FIXME: The CLI isn't part of core so we should change this message
+          unless config.user_config.disable_dev_warning?
+            log_warning config, development_warning
+          end
+        elsif !Rails.env.test?
+          unless config.user_config.disable_env_warning?
+            log_warning config, "#{log_prefix} You are running in the #{Rails.env} environment but haven't added it to config.#{self.class.root_key}.environments, so no data will be sent to #{config.class.service_name} servers."
+          end
         end
       end
-    end
 
-    def log_warning(config, msg)
-      if config
-        config.alert_logger.warn(msg)
-      else
-        Rails.logger.warn(msg)
+      def log_warning(config, msg)
+        if config
+          config.alert_logger.warn(msg)
+        else
+          Rails.logger.warn(msg)
+        end
       end
-    end
 
-    def existent_paths(paths)
-      paths.respond_to?(:existent) ? paths.existent : paths.select { |f| File.exists?(f) }
-    end
+      def existent_paths(paths)
+        paths.respond_to?(:existent) ? paths.existent : paths.select { |f| File.exist?(f) }
+      end
 
-    def load_skylight_config(app)
-      path = config_path(app)
-      path = nil unless File.exist?(path)
+      def load_skylight_config(app)
+        path = config_path(app)
+        path = nil unless File.exist?(path)
 
-      unless tmp = app.config.paths['tmp'].first
-        Rails.logger.error "#{log_prefix} tmp directory missing from rails configuration"
-        return nil
-      end
+        unless (tmp = app.config.paths["tmp"].first)
+          Rails.logger.error "#{log_prefix} tmp directory missing from rails configuration"
+          return nil
+        end
 
-      config = self.class.config_class.load(file: path, environment: Rails.env.to_s)
-      config[:root] = Rails.root
+        config = self.class.config_class.load(file: path, environment: Rails.env.to_s)
+        config[:root] = Rails.root
 
-      configure_logging(config, app)
+        configure_logging(config, app)
 
-      config[:'daemon.sockdir_path'] ||= tmp
-      config[:'normalizers.render.view_paths'] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
-      config
-    end
+        config[:'daemon.sockdir_path'] ||= tmp
+        config[:'normalizers.render.view_paths'] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
+        config
+      end
 
-    def configure_logging(config, app)
-      if logger = skylight_config(app).logger
-        config.logger = logger
-      else
-        # Configure the log file destination
-        if log_file = skylight_config(app).log_file
-          config['log_file'] = log_file
-        elsif !config.key?('log_file') && !config.on_heroku?
-          config['log_file'] = File.join(Rails.root, "log/#{self.class.log_file_name}.log")
-        end
+      def configure_logging(config, app)
+        if (logger = sk_rails_config(app).logger)
+          config.logger = logger
+        else
+          # Configure the log file destination
+          if (log_file = sk_rails_config(app).log_file)
+            config["log_file"] = log_file
+          elsif !config.key?("log_file") && !config.on_heroku?
+            config["log_file"] = File.join(Rails.root, "log/#{self.class.log_file_name}.log")
+          end
 
-        # Configure the log level
-        if level = skylight_config(app).log_level
-          config['log_level'] = level
-        elsif !config.key?('log_level')
-          if level = app.config.log_level
-            config['log_level'] = level
+          # Configure the log level
+          if (level = sk_rails_config(app).log_level)
+            config["log_level"] = level
+          elsif !config.key?("log_level")
+            if (level = app.config.log_level)
+              config["log_level"] = level
+            end
           end
         end
       end
-    end
-
-    def config_path(app)
-      File.expand_path(skylight_config.config_path, app.root)
-    end
 
-    def environments
-      Array(skylight_config.environments).map { |e| e && e.to_s }.compact
-    end
+      def config_path(app)
+        File.expand_path(sk_rails_config.config_path, app.root)
+      end
 
-    def activate?
-      key = "#{self.class.config_class.env_prefix}ENABLED"
-      if ENV.key?(key)
-        ENV[key] !~ /^false$/i
-      else
-        environments.include?(Rails.env.to_s)
+      def environments
+        Array(sk_rails_config.environments).map { |e| e && e.to_s }.compact
       end
-    end
 
-    def load_probes
-      probes = skylight_config.probes || []
-      Probes.probe(*probes)
-    end
+      def activate?(_sk_config)
+        key = "#{self.class.config_class.env_prefix}ENABLED"
+        if ENV.key?(key)
+          ENV[key] !~ /^false$/i
+        else
+          environments.include?(Rails.env.to_s)
+        end
+      end
 
-    def middleware_position
-      skylight_config.middleware_position.is_a?(Hash) ? skylight_config.middleware_position.symbolize_keys : skylight_config.middleware_position
-    end
+      def load_probes
+        probes = sk_rails_config.probes || []
+        Probes.probe(*probes)
+      end
 
-    def insert_middleware(app, config)
-      if middleware_position.has_key?(:after)
-        app.middleware.insert_after(middleware_position[:after], self.class.middleware_class, config: config)
-      elsif middleware_position.has_key?(:before)
-        app.middleware.insert_before(middleware_position[:before], self.class.middleware_class, config: config)
-      else
-        raise "The middleware position you have set is invalid. Please be sure `config.#{self.class.root_key}.middleware_position` is set up correctly."
+      def middleware_position
+        sk_rails_config.middleware_position.is_a?(Hash) ? sk_rails_config.middleware_position.symbolize_keys : sk_rails_config.middleware_position
       end
-    end
 
-    def set_middleware_position(app, config)
-      if middleware_position.is_a?(Integer)
-        app.middleware.insert middleware_position, self.class.middleware_class, config: config
-      elsif middleware_position.is_a?(Hash) && middleware_position.keys.count == 1
-        insert_middleware(app, config)
-      elsif middleware_position.nil?
-        app.middleware.insert 0, self.class.middleware_class, config: config
-      else
-        raise "The middleware position you have set is invalid. Please be sure `config.#{self.class.root_key}.middleware_position` is set up correctly."
+      def insert_middleware(app, config)
+        if middleware_position.key?(:after)
+          app.middleware.insert_after(middleware_position[:after], self.class.middleware_class, config: config)
+        elsif middleware_position.key?(:before)
+          app.middleware.insert_before(middleware_position[:before], self.class.middleware_class, config: config)
+        else
+          raise "The middleware position you have set is invalid. Please be sure `config.#{self.class.root_key}.middleware_position` is set up correctly."
+        end
       end
-    end
 
-    def skylight_config(target=self)
-      target.config.send(self.class.root_key)
-    end
+      def set_middleware_position(app, config)
+        if middleware_position.is_a?(Integer)
+          app.middleware.insert middleware_position, self.class.middleware_class, config: config
+        elsif middleware_position.is_a?(Hash) && middleware_position.keys.count == 1
+          insert_middleware(app, config)
+        elsif middleware_position.nil?
+          app.middleware.insert 0, self.class.middleware_class, config: config
+        else
+          raise "The middleware position you have set is invalid. Please be sure `config.#{self.class.root_key}.middleware_position` is set up correctly."
+        end
+      end
 
+      def sk_rails_config(target = self)
+        target.config.send(self.class.root_key)
+      end
   end
 end

data/lib/skylight/core/sidekiq.rb

@@ -21,10 +21,14 @@ module Skylight
 
         def call(_worker, job, queue)
           t { "Sidekiq middleware beginning trace" }
-          title = job['wrapped'] || job['class']
-          segment = "<sk-segment>#{queue}</sk-segment>"
-          @instrumentable.trace("#{title}#{segment}", 'app.sidekiq.worker', title) do
-            yield
+          title = job["wrapped"] || job["class"]
+          @instrumentable.trace(title, "app.sidekiq.worker", title, segment: queue) do |trace|
+            begin
+              yield
+            rescue Exception # includes Sidekiq::Shutdown
+              trace.segment = "error" if trace
+              raise
+            end
           end
         end
       end

data/lib/skylight/core/subscriber.rb

@@ -20,9 +20,7 @@ module Skylight::Core
     end
 
     def unregister!
-      until @subscribers.empty?
-        ActiveSupport::Notifications.unsubscribe @subscribers.shift
-      end
+      ActiveSupport::Notifications.unsubscribe @subscribers.shift until @subscribers.empty?
     end
 
     #
@@ -35,13 +33,14 @@ module Skylight::Core
       attr_reader :name, :span
 
       def initialize(name, span)
-        @name, @span = name, span
+        @name = name
+        @span = span
       end
     end
 
-    def start(name, id, payload)
+    def start(name, _id, payload)
       return if @instrumenter.disabled?
-      return unless trace = @instrumenter.current_trace
+      return unless (trace = @instrumenter.current_trace)
 
       result = normalize(trace, name, payload)
 
@@ -67,24 +66,22 @@ module Skylight::Core
       nil
     end
 
-    def finish(name, id, payload)
+    def finish(name, _id, payload)
       return if @instrumenter.disabled?
-      return unless trace = @instrumenter.current_trace
-
-      while curr = trace.notifications.pop
-        if curr.name == name
-          begin
-            normalize_after(trace, curr.span, name, payload)
-          ensure
-            meta = { }
-            meta[:exception] = payload[:exception] if payload[:exception]
-            meta[:exception_object] = payload[:exception_object] if payload[:exception_object]
-            trace.done(curr.span, meta) if curr.span
-          end
-          return
+      return unless (trace = @instrumenter.current_trace)
+
+      while (curr = trace.notifications.pop)
+        next unless curr.name == name
+        begin
+          normalize_after(trace, curr.span, name, payload)
+        ensure
+          meta = {}
+          meta[:exception] = payload[:exception] if payload[:exception]
+          meta[:exception_object] = payload[:exception_object] if payload[:exception_object]
+          trace.done(curr.span, meta) if curr.span
         end
+        return
       end
-
     rescue Exception => e
       error "Subscriber#finish error; msg=%s", e.message
       debug "trace=%s", trace.inspect
@@ -98,15 +95,14 @@ module Skylight::Core
       # Ignored for now because nothing in rails uses it
     end
 
-  private
-
-    def normalize(*args)
-      @normalizers.normalize(*args)
-    end
+    private
 
-    def normalize_after(*args)
-      @normalizers.normalize_after(*args)
-    end
+      def normalize(*args)
+        @normalizers.normalize(*args)
+      end
 
+      def normalize_after(*args)
+        @normalizers.normalize_after(*args)
+      end
   end
 end

data/lib/skylight/core/test.rb

@@ -2,15 +2,14 @@ module Skylight
   module Core
     module Test
       module Mocking
-
-        def mock!(config_opts={}, &callback)
+        def mock!(config_opts = {}, &callback)
           config_opts[:mock_submission] ||= callback || proc {}
           config = config_class.load(config_opts)
 
           unless respond_to?(:__original_instrumenter_class)
             class_eval do
               class << self
-                alias __original_instrumenter_class instrumenter_class
+                alias_method :__original_instrumenter_class, :instrumenter_class
 
                 def instrumenter_class
                   @instrumenter_class ||= Class.new(__original_instrumenter_class) do
@@ -57,25 +56,23 @@ module Skylight
                           mock_spans.index(span)
                         end
 
-                        def native_span_set_title(sp, title)
-                          mock_spans[sp][:title] = title
-
+                        def native_span_set_title(span, title)
+                          mock_spans[span][:title] = title
                         end
 
-                        def native_span_set_description(sp, desc)
-                          mock_spans[sp][:desc] = desc
+                        def native_span_set_description(span, desc)
+                          mock_spans[span][:desc] = desc
                         end
 
-                        def native_span_set_meta(sp, meta)
-                          mock_spans[sp][:meta] = meta
+                        def native_span_set_meta(span, meta)
+                          mock_spans[span][:meta] = meta
                         end
 
-                        def native_span_started(sp)
-                        end
+                        def native_span_started(span); end
 
-                        def native_span_set_exception(sp, exception_object, exception)
-                          mock_spans[sp][:exception_object] = exception_object
-                          mock_spans[sp][:exception] = exception
+                        def native_span_set_exception(span, exception_object, exception)
+                          mock_spans[span][:exception_object] = exception_object
+                          mock_spans[span][:exception] = exception
                         end
 
                         def native_stop_span(span, time)
@@ -94,8 +91,7 @@ module Skylight
                       config[:mock_submission].call(trace)
                     end
 
-                    def native_stop
-                    end
+                    def native_stop; end
 
                     def limited_description(description)
                       description