skylight 5.0.1 → 5.1.1

data/lib/skylight/normalizers.rb

@@ -79,18 +79,18 @@ module Skylight
 
       private
 
-        def process_meta(trace, _name, payload, meta, cache_key: nil)
-          trace.instrumenter.extensions.process_normalizer_meta(
-            payload,
-            meta,
-            cache_key: cache_key,
-            **process_meta_options(payload)
-          )
-        end
+      def process_meta(trace, _name, payload, meta, cache_key: nil)
+        trace.instrumenter.extensions.process_normalizer_meta(
+          payload,
+          meta,
+          cache_key: cache_key,
+          **process_meta_options(payload)
+        )
+      end
 
-        def process_meta_options(_payload)
-          {}
-        end
+      def process_meta_options(_payload)
+        {}
+      end
     end
 
     require "skylight/normalizers/default"
@@ -105,6 +105,10 @@ module Skylight
         @normalizers.keys
       end
 
+      def each_key(&block)
+        @normalizers.each_key(&block)
+      end
+
       def normalize(trace, name, payload)
         normalizer_for(name).normalize_with_meta(trace, name, payload)
       end
@@ -121,33 +125,33 @@ module Skylight
       end
     end
 
-    %w[ action_controller/process_action
-        action_controller/send_file
-        action_dispatch/process_middleware
-        action_dispatch/route_set
-        action_view/render_collection
-        action_view/render_partial
-        action_view/render_template
-        action_view/render_layout
-        active_job/perform
-        active_model_serializers/render
-        active_record/instantiation
-        active_record/sql
-        active_storage
-        active_support/cache
-        coach/handler_finish
-        coach/middleware_finish
-        couch_potato/query
-        data_mapper/sql
-        elasticsearch/request
-        faraday/request
-        grape/endpoint
-        graphiti/resolve
-        graphiti/render
-        graphql/base
-        sequel/sql
-        shrine].each do |file|
-      require "skylight/normalizers/#{file}"
-    end
+    %w[
+      action_controller/process_action
+      action_controller/send_file
+      action_dispatch/process_middleware
+      action_dispatch/route_set
+      action_view/render_collection
+      action_view/render_partial
+      action_view/render_template
+      action_view/render_layout
+      active_job/perform
+      active_model_serializers/render
+      active_record/instantiation
+      active_record/sql
+      active_storage
+      active_support/cache
+      coach/handler_finish
+      coach/middleware_finish
+      couch_potato/query
+      data_mapper/sql
+      elasticsearch/request
+      faraday/request
+      grape/endpoint
+      graphiti/resolve
+      graphiti/render
+      graphql/base
+      sequel/sql
+      shrine
+    ].each { |file| require "skylight/normalizers/#{file}" }
   end
 end

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

@@ -32,37 +32,36 @@ module Skylight
 
         private
 
-          def controller_action(payload)
-            "#{payload[:controller]}##{payload[:action]}"
-          end
+        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 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]
+        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
+          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
+        def segment_from_status(status)
+          case status
+          when 304
+            "not modified"
+          when (300..399)
+            "redirect"
+          when (400..599)
+            "error"
           end
+        end
       end
     end
   end

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

@@ -32,17 +32,18 @@ module Skylight
 
           private
 
-            OCTET_STREAM = "application/octet-stream".freeze
-            ATTACHMENT = "attachment".freeze
+          OCTET_STREAM = "application/octet-stream".freeze
+          ATTACHMENT = "attachment".freeze
 
-            def initialize(*)
-              super
+          def initialize(*)
+            super
 
-              @mimes = Mime::SET.each_with_object({}) do |mime, hash|
+            @mimes =
+              Mime::SET.each_with_object({}) do |mime, hash|
                 hash[mime.symbol] = mime.to_s.dup.freeze
                 hash
               end
-            end
+          end
         end
       end
     end

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

@@ -13,14 +13,14 @@ module Skylight
 
         private
 
-          def router_class_name
-            "ActionDispatch::Routing::RouteSet"
-          end
+        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
+        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

data/lib/skylight/normalizers/active_job/perform.rb

@@ -8,12 +8,16 @@ module Skylight
         DELAYED_JOB_WRAPPER = "ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper".freeze
 
         def self.normalize_title(job_instance)
-          job_instance.class.name.to_s.tap do |str|
-            if str.match(DELIVERY_JOB)
-              mailer_class, mailer_method, * = job_instance.arguments
-              return ["#{mailer_class}##{mailer_method}", str]
+          job_instance
+            .class
+            .name
+            .to_s
+            .tap do |str|
+              if str.match(DELIVERY_JOB)
+                mailer_class, mailer_method, * = job_instance.arguments
+                return "#{mailer_class}##{mailer_method}", str
+              end
             end
-          end
         end
 
         CAT = "app.job.perform".freeze
@@ -36,50 +40,50 @@ module Skylight
 
         private
 
-          def process_meta_options(payload)
-            # provide hints to override default source_location behavior
-            super.merge(source_location_hint: [:instance_method, payload[:job].class.to_s, "perform"])
-          end
-
-          def normalize_adapter_name(adapter)
-            adapter_string = adapter.is_a?(Class) ? adapter.to_s : adapter.class.to_s
-            adapter_string[/ActiveJob::QueueAdapters::(\w+)Adapter/, 1].underscore
-          rescue
-            "active_job"
-          end
+        def process_meta_options(payload)
+          # provide hints to override default source_location behavior
+          super.merge(source_location_hint: [:instance_method, payload[:job].class.to_s, "perform"])
+        end
 
-          def maybe_set_endpoint(trace, payload)
-            if assign_endpoint?(trace, payload)
-              trace.endpoint = normalize_title(payload[:job])
-            end
-          end
+        def normalize_adapter_name(adapter)
+          adapter_string = adapter.is_a?(Class) ? adapter.to_s : adapter.class.to_s
+          adapter_string[/ActiveJob::QueueAdapters::(\w+)Adapter/, 1].underscore
+        rescue StandardError
+          "active_job"
+        end
 
-          def assign_endpoint?(trace, payload)
-            # Always assign the endpoint if it has not yet been assigned by the ActiveJob probe.
-            return true unless trace.endpoint
-            return true if defined?(Skylight::Probes::ActiveJob::TITLE) &&
-                           trace.endpoint == Skylight::Probes::ActiveJob::TITLE
-            return true if defined?(SKylight::Probes::DelayedJob::Probe::UNKNOWN) &&
-                           trace.endpoint == Skylight::Probes::DelayedJob::Probe::UNKNOWN
+        def maybe_set_endpoint(trace, payload)
+          trace.endpoint = normalize_title(payload[:job]) if assign_endpoint?(trace, payload)
+        end
 
-            # If a job is called using #perform_now inside a controller action
-            # or within another job's #perform method, we do not want this to
-            # overwrite the existing endpoint name (unless it is the default from ActiveJob).
-            #
-            # If the current endpoint name matches this payload, return true to allow the
-            # segment to be assigned by normalize_after.
-            trace.endpoint == DELIVERY_JOB ||
-              trace.endpoint == normalize_title(payload[:job]) ||
-              # This adapter wrapper needs to be handled specifically due to interactions with the
-              # standalone Delayed::Job probe, as there is no consistent way to get the wrapped
-              # job name among all Delayed::Job backends.
-              trace.endpoint == DELAYED_JOB_WRAPPER
+        def assign_endpoint?(trace, payload)
+          # Always assign the endpoint if it has not yet been assigned by the ActiveJob probe.
+          return true unless trace.endpoint
+          if defined?(Skylight::Probes::ActiveJob::TITLE) && trace.endpoint == Skylight::Probes::ActiveJob::TITLE
+            return true
           end
-
-          def normalize_title(job_instance)
-            title, * = self.class.normalize_title(job_instance)
-            title
+          if defined?(SKylight::Probes::DelayedJob::Probe::UNKNOWN) &&
+               trace.endpoint == Skylight::Probes::DelayedJob::Probe::UNKNOWN
+            return true
           end
+
+          # If a job is called using #perform_now inside a controller action
+          # or within another job's #perform method, we do not want this to
+          # overwrite the existing endpoint name (unless it is the default from ActiveJob).
+          #
+          # If the current endpoint name matches this payload, return true to allow the
+          # segment to be assigned by normalize_after.
+          trace.endpoint == DELIVERY_JOB || trace.endpoint == normalize_title(payload[:job]) ||
+            # This adapter wrapper needs to be handled specifically due to interactions with the
+            # standalone Delayed::Job probe, as there is no consistent way to get the wrapped
+            # job name among all Delayed::Job backends.
+            trace.endpoint == DELAYED_JOB_WRAPPER
+        end
+
+        def normalize_title(job_instance)
+          title, * = self.class.normalize_title(job_instance)
+          title
+        end
       end
     end
   end

data/lib/skylight/normalizers/active_model_serializers/render.rb

@@ -14,9 +14,13 @@ module Skylight
           title = title.sub(/^ActiveModel::(Serializer::)?/, "")
 
           if (adapter_instance = payload[:adapter])
-            adapter_name = adapter_instance.class.name.to_s.
-                           sub(/^ActiveModel::Serializer::Adapter::/, "").
-                           sub(/^ActiveModelSerializers::Adapter::/, "")
+            adapter_name =
+              adapter_instance
+                .class
+                .name
+                .to_s
+                .sub(/^ActiveModel::Serializer::Adapter::/, "")
+                .sub(/^ActiveModelSerializers::Adapter::/, "")
             desc = "Adapter: #{adapter_name}"
           end
 

data/lib/skylight/normalizers/active_storage.rb

@@ -2,26 +2,24 @@ module Skylight
   module Normalizers
     class ActiveStorage < Normalizer
       TITLES = {
-        "preview.active_storage"                    => "Preview",
-        "transform.active_storage"                  => "Transform",
-        "service_download.active_storage"           => "Download",
-        "service_upload.active_storage"             => "Upload",
+        "preview.active_storage" => "Preview",
+        "transform.active_storage" => "Transform",
+        "service_download.active_storage" => "Download",
+        "service_upload.active_storage" => "Upload",
         "service_streaming_download.active_storage" => "Streaming Download",
-        "service_download_chunk.active_storage"     => "Download Chunk",
-        "service_delete.active_storage"             => "Delete",
-        "service_delete_prefixed.active_storage"    => "Delete Prefixed",
-        "service_exist.active_storage"              => "Exist",
-        "service_url.active_storage"                => "Url"
+        "service_download_chunk.active_storage" => "Download Chunk",
+        "service_delete.active_storage" => "Delete",
+        "service_delete_prefixed.active_storage" => "Delete Prefixed",
+        "service_exist.active_storage" => "Exist",
+        "service_url.active_storage" => "Url"
       }.freeze
 
-      TITLES.each_key do |key|
-        register key
-      end
+      TITLES.each_key { |key| register key }
 
       def normalize(_trace, name, _payload)
         title = ["ActiveStorage", TITLES[name]].join(" ")
 
-        cat = "app.#{name.split('.').reverse.join('.')}"
+        cat = "app.#{name.split(".").reverse.join(".")}"
 
         [cat, title, nil]
       end

data/lib/skylight/normalizers/active_support/cache.rb

@@ -2,18 +2,7 @@ module Skylight
   module Normalizers
     module ActiveSupport
       class Cache < Normalizer
-        %w[
-          clear
-          decrement
-          delete
-          exist
-          fetch_hit
-          generate
-          increment
-          read
-          read_multi
-          write
-        ].each do |type|
+        %w[clear decrement delete exist fetch_hit generate increment read read_multi write].each do |type|
           require "skylight/normalizers/active_support/cache_#{type}"
         end
       end

data/lib/skylight/normalizers/coach/handler_finish.rb

@@ -36,9 +36,7 @@ module Skylight
           response_status = payload.fetch(:response, {}).fetch(:status, "").to_s
           segments << "error" if response_status.start_with?("4", "5")
 
-          if segments.any?
-            trace.segment = segments.join("+")
-          end
+          trace.segment = segments.join("+") if segments.any?
         end
       end
     end

data/lib/skylight/normalizers/default.rb

@@ -17,15 +17,7 @@ module Skylight
       # @option payload [String] :description
       # @return [Array, :skip] the normalized array or `:skip` if `name` is not part of a known {Skylight::TIERS tier}
       def normalize(_trace, name, payload)
-        if name =~ Skylight::TIER_REGEX
-          [
-            name,
-            payload[:title],
-            payload[:description]
-          ]
-        else
-          :skip
-        end
+        name =~ Skylight::TIER_REGEX ? [name, payload[:title], payload[:description]] : :skip
       end
     end
   end

data/lib/skylight/normalizers/faraday/request.rb

@@ -23,9 +23,7 @@ module Skylight
         def normalize(_trace, _name, payload)
           uri = payload[:url]
 
-          if disabled?
-            return :skip
-          end
+          return :skip if disabled?
 
           opts = Formatters::HTTP.build_opts(payload[:method], uri.scheme, uri.host, uri.port, uri.path, uri.query)
           description = opts[:title]

data/lib/skylight/normalizers/grape/endpoint.rb

@@ -2,32 +2,26 @@ module Skylight
   module Normalizers
     module Grape
       class Endpoint < Normalizer
-        %w[
-          run
-          render
-          run_filters
-        ].each do |type|
-          require "skylight/normalizers/grape/endpoint_#{type}"
-        end
+        %w[run render run_filters].each { |type| require "skylight/normalizers/grape/endpoint_#{type}" }
 
         require "skylight/normalizers/grape/format_response"
 
         private
 
-          def get_method(endpoint)
-            method = endpoint.options[:method].first
-            method = "#{method}..." if endpoint.options[:method].length > 1
-            method
-          end
+        def get_method(endpoint)
+          method = endpoint.options[:method].first
+          method = "#{method}..." if endpoint.options[:method].length > 1
+          method
+        end
 
-          def get_path(endpoint)
-            endpoint.options[:path].join("/")
-          end
+        def get_path(endpoint)
+          endpoint.options[:path].join("/")
+        end
 
-          def get_namespace(endpoint)
-            # slice off preceding slash for data continuity
-            ::Grape::Namespace.joined_space_path(endpoint.namespace_stackable(:namespace)).to_s[1..-1]
-          end
+        def get_namespace(endpoint)
+          # slice off preceding slash for data continuity
+          ::Grape::Namespace.joined_space_path(endpoint.namespace_stackable(:namespace)).to_s[1..-1]
+        end
       end
     end
   end