skylight 5.0.1 → 5.1.1

data/lib/skylight/probes/action_dispatch/request_id.rb

@@ -10,9 +10,9 @@ module Skylight
 
           private
 
-            def internal_request_id
-              @skylight_request_id || super
-            end
+          def internal_request_id
+            @skylight_request_id || super
+          end
         end
 
         class Probe
@@ -23,7 +23,11 @@ module Skylight
       end
     end
 
-    register(:action_dispatch, "ActionDispatch::RequestId", "action_dispatch/middleware/request_id",
-             ActionDispatch::RequestId::Probe.new)
+    register(
+      :action_dispatch,
+      "ActionDispatch::RequestId",
+      "action_dispatch/middleware/request_id",
+      ActionDispatch::RequestId::Probe.new
+    )
   end
 end

data/lib/skylight/probes/action_dispatch/routing/route_set.rb

@@ -7,9 +7,7 @@ module Skylight
         module RouteSet
           module Instrumentation
             def call(env)
-              ActiveSupport::Notifications.instrument("route_set.action_dispatch") do
-                super
-              end
+              ActiveSupport::Notifications.instrument("route_set.action_dispatch") { super }
             end
           end
 
@@ -22,7 +20,11 @@ module Skylight
       end
     end
 
-    register(:rails_router, "ActionDispatch::Routing::RouteSet", "action_dispatch/routing/route_set",
-             ActionDispatch::Routing::RouteSet::Probe.new)
+    register(
+      :rails_router,
+      "ActionDispatch::Routing::RouteSet",
+      "action_dispatch/routing/route_set",
+      ActionDispatch::Routing::RouteSet::Probe.new
+    )
   end
 end

data/lib/skylight/probes/action_view.rb

@@ -5,19 +5,18 @@ module Skylight
     module ActionView
       module Instrumentation
         def render_with_layout(*args) #:nodoc:
-          path, locals = case args.length
-                         when 2
-                           args
-                         when 4
-                           # Rails > 6.0.0.beta3 arguments are (view, template, path, locals)
-                           [args[2], args[3]]
-                         end
+          path, locals =
+            case args.length
+            when 2
+              args
+            when 4
+              # Rails > 6.0.0.beta3 arguments are (view, template, path, locals)
+              [args[2], args[3]]
+            end
 
           layout = nil
 
-          if path
-            layout = find_layout(path, locals.keys, [formats.first])
-          end
+          layout = find_layout(path, locals.keys, [formats.first]) if path
 
           if layout
             ActiveSupport::Notifications.instrument("render_template.action_view", identifier: layout.identifier) do

data/lib/skylight/probes/active_job_enqueue.rb

@@ -14,17 +14,11 @@ module Skylight
             name, job_class_name = Normalizers::ActiveJob::Perform.normalize_title(job)
             descriptors = ["adapter: '#{adapter_name}'", "queue: '#{job.queue_name}'"]
             descriptors << "job: '#{job_class_name}'" if job_class_name
-            desc = "{ #{descriptors.join(', ')} }"
-          rescue
+            desc = "{ #{descriptors.join(", ")} }"
+          rescue StandardError
             block.call
           else
-            Skylight.instrument(
-              title:       "Enqueue #{name}",
-              category:    CAT,
-              description: desc,
-              internal:    true,
-              &block
-            )
+            Skylight.instrument(title: "Enqueue #{name}", category: CAT, description: desc, internal: true, &block)
           end
 
           self.class.instance_eval do

data/lib/skylight/probes/active_model_serializers.rb

@@ -18,9 +18,7 @@ module Skylight
           rescue LoadError # rubocop:disable Lint/SuppressedException
           end
 
-          if Gem.loaded_specs["active_model_serializers"]
-            version = Gem.loaded_specs["active_model_serializers"].version
-          end
+          version = Gem.loaded_specs["active_model_serializers"].version if Gem.loaded_specs["active_model_serializers"]
 
           if !version || version < Gem::Version.new("0.5.0")
             Skylight.error "Instrumention is only available for ActiveModelSerializers version 0.5.0 and greater."
@@ -37,14 +35,16 @@ module Skylight
           # End users could override as_json without calling super, but it's likely safer
           # than overriding serializable_array/hash/object.
 
-          [::ActiveModel::Serializer, ::ActiveModel::ArraySerializer].each do |klass|
-            klass.prepend(Instrumentation)
-          end
+          [::ActiveModel::Serializer, ::ActiveModel::ArraySerializer].each { |klass| klass.prepend(Instrumentation) }
         end
       end
     end
 
-    register(:active_model_serializers, "ActiveModel::Serializer", "active_model/serializer",
-             ActiveModelSerializers::Probe.new)
+    register(
+      :active_model_serializers,
+      "ActiveModel::Serializer",
+      "active_model/serializer",
+      ActiveModelSerializers::Probe.new
+    )
   end
 end

data/lib/skylight/probes/delayed_job.rb

@@ -10,13 +10,9 @@ module Skylight
 
         class Plugin < ::Delayed::Plugin
           callbacks do |lifecycle|
-            lifecycle.around(:perform) do |worker, job, &block|
-              sk_instrument(worker, job, &block)
-            end
+            lifecycle.around(:perform) { |worker, job, &block| sk_instrument(worker, job, &block) }
 
-            lifecycle.after(:error) do |_worker, _job|
-              Skylight.trace&.segment = "error"
-            end
+            lifecycle.after(:error) { |_worker, _job| Skylight.trace&.segment = "error" }
           end
 
           class << self
@@ -25,15 +21,19 @@ module Skylight
             def sk_instrument(_worker, job)
               endpoint = Skylight::Probes::DelayedJob.handler_name(job)
 
-              Skylight.trace(endpoint,
-                             "app.delayed_job.worker",
-                             "Delayed::Worker#run",
-                             component: :worker,
-                             segment:   job.queue,
-                             meta:      { source_location: "delayed_job" }) do
-                               t { "Delayed::Job beginning trace" }
-                               yield
-                             end
+              Skylight.trace(
+                endpoint,
+                "app.delayed_job.worker",
+                "Delayed::Worker#run",
+                component: :worker,
+                segment: job.queue,
+                meta: {
+                  source_location: "delayed_job"
+                }
+              ) do
+                t { "Delayed::Job beginning trace" }
+                yield
+              end
             end
           end
         end
@@ -44,11 +44,8 @@ module Skylight
       UNKNOWN = "<Delayed::Job Unknown>"
 
       def self.handler_name(job)
-        payload_object = if job.respond_to?(:payload_object_without_sk)
-                           job.payload_object_without_sk
-                         else
-                           job.payload_object
-                         end
+        payload_object =
+          job.respond_to?(:payload_object_without_sk) ? job.payload_object_without_sk : job.payload_object
 
         payload_object_name(payload_object)
       end
@@ -62,7 +59,7 @@ module Skylight
           # Use class name instead to avoid this.
           payload_object.class.name
         end
-      rescue
+      rescue StandardError
         UNKNOWN
       end
 
@@ -84,8 +81,10 @@ module Skylight
 
           opts = {
             category: "app.delayed_job.job",
-            title:    format_source(*source_meta),
-            meta:     { source_location_hint: source_meta },
+            title: format_source(*source_meta),
+            meta: {
+              source_location_hint: source_meta
+            },
             internal: true
           }
 
@@ -99,13 +98,9 @@ module Skylight
 
         private
 
-          def format_source(method_type, constant_name, method_name)
-            if method_type == :instance_method
-              "#{constant_name}##{method_name}"
-            else
-              "#{constant_name}.#{method_name}"
-            end
-          end
+        def format_source(method_type, constant_name, method_name)
+          method_type == :instance_method ? "#{constant_name}##{method_name}" : "#{constant_name}.#{method_name}"
+        end
       end
 
       class Probe
@@ -124,23 +119,23 @@ module Skylight
 
         private
 
-          def plugin_defined?
-            defined?(::Skylight::Probes::DelayedJob::Plugin)
-          end
+        def plugin_defined?
+          defined?(::Skylight::Probes::DelayedJob::Plugin)
+        end
 
-          def validate_version
-            spec = Gem.loaded_specs["delayed_job"]
-            version = spec&.version
+        def validate_version
+          spec = Gem.loaded_specs["delayed_job"]
+          version = spec&.version
 
-            if !version || version < Gem::Version.new("4.0.0")
-              Skylight.error "The installed version of DelayedJob is not supported on Skylight. " \
+          if !version || version < Gem::Version.new("4.0.0")
+            Skylight.error "The installed version of DelayedJob is not supported on Skylight. " \
                              "Your jobs will not be tracked."
 
-              return false
-            end
-
-            true
+            return false
           end
+
+          true
+        end
       end
     end
 

data/lib/skylight/probes/elasticsearch.rb

@@ -9,16 +9,14 @@ module Skylight
             def perform_request(method, path, *args, &block)
               ActiveSupport::Notifications.instrument(
                 "request.elasticsearch",
-                name:   "Request",
+                name: "Request",
                 method: method,
-                path:   path
+                path: path
               ) do
                 # Prevent HTTP-related probes from firing
                 Skylight::Normalizers::Faraday::Request.disable do
                   disable_skylight_probe(:NetHTTP) do
-                    disable_skylight_probe(:HTTPClient) do
-                      perform_request_without_sk(method, path, *args, &block)
-                    end
+                    disable_skylight_probe(:HTTPClient) { perform_request_without_sk(method, path, *args, &block) }
                   end
                 end
               end

data/lib/skylight/probes/excon.rb

@@ -14,7 +14,7 @@ module Skylight
             ::Excon.defaults[:middlewares].insert(idx, Probes::Excon::Middleware)
           else
             Skylight.error "The installed version of Excon doesn't support Middlewares. " \
-                           "The Excon probe will be disabled."
+                             "The Excon probe will be disabled."
           end
         end
       end

data/lib/skylight/probes/excon/middleware.rb

@@ -33,33 +33,32 @@ module Skylight
 
         private
 
-          def begin_instrumentation(datum)
-            method = datum[:method].to_s
-            scheme = datum[:scheme]
-            host   = datum[:host]
-            # TODO: Maybe don't show other default ports like 443
-            port   = datum[:port] == 80 ? nil : datum[:port]
-            path   = datum[:path]
-            query  = datum[:query]
+        def begin_instrumentation(datum)
+          method = datum[:method].to_s
+          scheme = datum[:scheme]
+          host = datum[:host]
 
-            opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
+          # TODO: Maybe don't show other default ports like 443
+          port = datum[:port] == 80 ? nil : datum[:port]
+          path = datum[:path]
+          query = datum[:query]
 
-            @requests[datum] = Skylight.instrument(opts)
-          rescue Exception => e
-            Skylight.error "failed to begin instrumentation for Excon; msg=%s", e.message
-          end
+          opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
+
+          @requests[datum] = Skylight.instrument(opts)
+        rescue Exception => e
+          Skylight.error "failed to begin instrumentation for Excon; msg=%s", e.message
+        end
 
-          def end_instrumentation(datum)
-            if (request = @requests.delete(datum))
-              meta = {}
-              if datum[:error].is_a?(Exception)
-                meta[:exception_object] = datum[:error]
-              end
-              Skylight.done(request, meta)
-            end
-          rescue Exception => e
-            Skylight.error "failed to end instrumentation for Excon; msg=%s", e.message
+        def end_instrumentation(datum)
+          if (request = @requests.delete(datum))
+            meta = {}
+            meta[:exception_object] = datum[:error] if datum[:error].is_a?(Exception)
+            Skylight.done(request, meta)
           end
+        rescue Exception => e
+          Skylight.error "failed to end instrumentation for Excon; msg=%s", e.message
+        end
       end
     end
   end

data/lib/skylight/probes/graphql.rb

@@ -20,16 +20,11 @@ module Skylight
       class Probe
         def install
           tracing_klass_name = "::GraphQL::Tracing::ActiveSupportNotificationsTracing"
-          klasses_to_probe = %w[
-            ::GraphQL::Execution::Multiplex
-            ::GraphQL::Query
-          ]
+          klasses_to_probe = %w[::GraphQL::Execution::Multiplex ::GraphQL::Query]
 
           return unless ([tracing_klass_name] + klasses_to_probe).all?(&method(:safe_constantize))
 
-          klasses_to_probe.each do |klass_name|
-            safe_constantize(klass_name).prepend(Instrumentation)
-          end
+          klasses_to_probe.each { |klass_name| safe_constantize(klass_name).prepend(Instrumentation) }
         end
 
         def safe_constantize(klass_name)

data/lib/skylight/probes/middleware.rb

@@ -16,7 +16,7 @@ module Skylight
               elsif middleware.respond_to?(:call)
                 middleware.method(:call).source_location
               end
-            rescue
+            rescue StandardError
               nil
             end
         end
@@ -72,8 +72,13 @@ module Skylight
 
               source_file, source_line = method(__method__).super_method.source_location
 
-              spans = Skylight.instrument(title: name, category: __sk_category,
-                                          source_file: source_file, source_line: source_line)
+              spans =
+                Skylight.instrument(
+                  title: name,
+                  category: __sk_category,
+                  source_file: source_file,
+                  source_line: source_line
+                )
 
               proxied_response =
                 Skylight::Middleware.with_after_close(super(*args), debug_identifier: "Middleware: #{name}") do
@@ -120,7 +125,11 @@ module Skylight
       end
     end
 
-    register(:middleware, "ActionDispatch::MiddlewareStack::Middleware", "actionpack/action_dispatch",
-             Middleware::Probe.new)
+    register(
+      :middleware,
+      "ActionDispatch::MiddlewareStack::Middleware",
+      "actionpack/action_dispatch",
+      Middleware::Probe.new
+    )
   end
 end

data/lib/skylight/probes/mongo.rb

@@ -14,9 +14,7 @@ module Skylight
 
         COMMANDS = %i[insert find count distinct update findandmodify findAndModify delete aggregate].freeze
 
-        COMMAND_NAMES = {
-          findandmodify: "findAndModify".freeze
-        }.freeze
+        COMMAND_NAMES = { findandmodify: "findAndModify".freeze }.freeze
 
         def initialize
           @events = {}
@@ -41,121 +39,115 @@ module Skylight
 
         private
 
-          def begin_instrumentation(event)
-            return unless COMMANDS.include?(event.command_name.to_sym)
+        def begin_instrumentation(event)
+          return unless COMMANDS.include?(event.command_name.to_sym)
 
-            command_name = COMMAND_NAMES[event.command_name] || event.command_name.to_s
+          command_name = COMMAND_NAMES[event.command_name] || event.command_name.to_s
 
-            title = "#{event.database_name}.#{command_name}"
+          title = "#{event.database_name}.#{command_name}"
 
-            command = event.command
+          command = event.command
 
-            # Not sure if this will always exist
-            # Delete so the description will be less redundant
-            if (target = command[event.command_name])
-              title << " #{target}"
-            end
-
-            payload = {}
-
-            # Ruby Hashes are ordered based on insertion so do the most important ones first
+          # Not sure if this will always exist
+          # Delete so the description will be less redundant
+          if (target = command[event.command_name])
+            title << " #{target}"
+          end
 
-            add_value("key".freeze, command, payload)
-            add_bound("query".freeze, command, payload)
-            add_bound("filter".freeze, command, payload)
-            add_value("sort".freeze, command, payload)
+          payload = {}
 
-            if command_name == "findAndModify".freeze
-              add_bound("update".freeze, command, payload)
-            end
+          # Ruby Hashes are ordered based on insertion so do the most important ones first
 
-            add_value("remove".freeze, command, payload)
-            add_value("new".freeze, command, payload)
+          add_value("key".freeze, command, payload)
+          add_bound("query".freeze, command, payload)
+          add_bound("filter".freeze, command, payload)
+          add_value("sort".freeze, command, payload)
 
-            if (updates = command["updates".freeze])
-              # AFAICT the gem generally just sends one item in the updates array
-              update = updates[0]
-              update_payload = {}
-              add_bound("q".freeze, update, update_payload)
-              add_bound("u".freeze, update, update_payload)
-              add_value("multi".freeze, update, update_payload)
-              add_value("upsert".freeze, update, update_payload)
+          add_bound("update".freeze, command, payload) if command_name == "findAndModify".freeze
 
-              payload["updates".freeze] = [update_payload]
+          add_value("remove".freeze, command, payload)
+          add_value("new".freeze, command, payload)
 
-              if updates.length > 1
-                payload["updates".freeze] << "..."
-              end
-            end
+          if (updates = command["updates".freeze])
+            # AFAICT the gem generally just sends one item in the updates array
+            update = updates[0]
+            update_payload = {}
+            add_bound("q".freeze, update, update_payload)
+            add_bound("u".freeze, update, update_payload)
+            add_value("multi".freeze, update, update_payload)
+            add_value("upsert".freeze, update, update_payload)
 
-            if (deletes = command["deletes".freeze])
-              # AFAICT the gem generally just sends one item in the updates array
-              delete = deletes[0]
-              delete_payload = {}
-              add_bound("q".freeze, delete, delete_payload)
-              add_value("limit".freeze, delete, delete_payload)
+            payload["updates".freeze] = [update_payload]
 
-              payload["deletes".freeze] = [delete_payload]
+            payload["updates".freeze] << "..." if updates.length > 1
+          end
 
-              if deletes.length > 1
-                payload["deletes".freeze] << "..."
-              end
-            end
+          if (deletes = command["deletes".freeze])
+            # AFAICT the gem generally just sends one item in the updates array
+            delete = deletes[0]
+            delete_payload = {}
+            add_bound("q".freeze, delete, delete_payload)
+            add_value("limit".freeze, delete, delete_payload)
 
-            if (pipeline = command["pipeline".freeze])
-              payload["pipeline".freeze] = pipeline.map { |segment| extract_binds(segment) }
-            end
+            payload["deletes".freeze] = [delete_payload]
 
-            # We're ignoring documents from insert because they could have completely inconsistent
-            # format which would make it hard to merge.
-
-            opts = {
-              category:    CAT,
-              title:       title,
-              description: payload.empty? ? nil : payload.to_json,
-              meta:        { database: event.database_name },
-              internal:    true
-            }
+            payload["deletes".freeze] << "..." if deletes.length > 1
+          end
 
-            @events[event.operation_id] = Skylight.instrument(opts)
-          rescue Exception => e
-            error "failed to begin instrumentation for Mongo; msg=%s", e.message
+          if (pipeline = command["pipeline".freeze])
+            payload["pipeline".freeze] = pipeline.map { |segment| extract_binds(segment) }
           end
 
-          def end_instrumentation(event)
-            if (original_event = @events.delete(event.operation_id))
-              meta = {}
-              if event.is_a?(::Mongo::Monitoring::Event::CommandFailed)
-                meta[:exception] = ["CommandFailed", event.message]
-              end
-              Skylight.done(original_event, meta)
+          # We're ignoring documents from insert because they could have completely inconsistent
+          # format which would make it hard to merge.
+
+          opts = {
+            category: CAT,
+            title: title,
+            description: payload.empty? ? nil : payload.to_json,
+            meta: {
+              database: event.database_name
+            },
+            internal: true
+          }
+
+          @events[event.operation_id] = Skylight.instrument(opts)
+        rescue Exception => e
+          error "failed to begin instrumentation for Mongo; msg=%s", e.message
+        end
+
+        def end_instrumentation(event)
+          if (original_event = @events.delete(event.operation_id))
+            meta = {}
+            if event.is_a?(::Mongo::Monitoring::Event::CommandFailed)
+              meta[:exception] = ["CommandFailed", event.message]
             end
-          rescue Exception => e
-            error "failed to end instrumentation for Mongo; msg=%s", e.message
+            Skylight.done(original_event, meta)
           end
+        rescue Exception => e
+          error "failed to end instrumentation for Mongo; msg=%s", e.message
+        end
 
-          def add_value(key, command, payload)
-            if command.key?(key)
-              value = command[key]
-              payload[key] = value
-            end
+        def add_value(key, command, payload)
+          if command.key?(key)
+            value = command[key]
+            payload[key] = value
           end
+        end
 
-          def add_bound(key, command, payload)
-            if (value = command[key])
-              payload[key] = extract_binds(value)
-            end
+        def add_bound(key, command, payload)
+          if (value = command[key])
+            payload[key] = extract_binds(value)
           end
+        end
 
-          def extract_binds(hash)
-            ret = {}
+        def extract_binds(hash)
+          ret = {}
 
-            hash.each do |k, v|
-              ret[k] = v.is_a?(Hash) ? extract_binds(v) : "?".freeze
-            end
+          hash.each { |k, v| ret[k] = v.is_a?(Hash) ? extract_binds(v) : "?".freeze }
 
-            ret
-          end
+          ret
+        end
       end
     end