skylight 4.3.1 → 5.0.0.beta

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

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

@@ -0,0 +1,81 @@
+module Skylight
+  module Normalizers
+    module ActiveJob
+      class Perform < Normalizer
+        register "perform.active_job"
+
+        DELIVERY_JOB = /\AActionMailer::(Mail)?DeliveryJob\Z/.freeze
+        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]
+            end
+          end
+        end
+
+        CAT = "app.job.perform".freeze
+
+        def normalize(trace, _name, payload)
+          title = payload[:job].class.to_s
+          adapter_name = normalize_adapter_name(payload[:adapter])
+          desc = "{ adapter: '#{adapter_name}', queue: '#{payload[:job].queue_name}' }"
+
+          maybe_set_endpoint(trace, payload)
+
+          [CAT, title, desc]
+        end
+
+        def normalize_after(trace, _span, _name, payload)
+          return unless config.enable_segments? && assign_endpoint?(trace, payload)
+
+          trace.segment = payload[:job].queue_name
+        end
+
+        private
+
+          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 maybe_set_endpoint(trace, payload)
+            if assign_endpoint?(trace, payload)
+              trace.endpoint = normalize_title(payload[:job])
+            end
+          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
+
+            # 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
+end

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

@@ -0,0 +1,28 @@
+module Skylight
+  module Normalizers
+    module ActiveModelSerializers
+      class Render < Normalizer
+        register "render.active_model_serializers"
+
+        CAT = "view.render.active_model_serializers".freeze
+        ANONYMOUS = "<Anonymous Serializer>".freeze
+
+        def normalize(_trace, _name, payload)
+          serializer_class = payload[:serializer]
+
+          title = serializer_class.name || ANONYMOUS
+          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::/, "")
+            desc = "Adapter: #{adapter_name}"
+          end
+
+          [CAT, title, desc]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/active_record/instantiation.rb

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveRecord
+      class Instantiation < Normalizer
+        register "instantiation.active_record"
+
+        CAT = "db.active_record.instantiation".freeze
+
+        def normalize(_trace, _name, payload)
+          # Payload also includes `:record_count` but this will be variable
+          [CAT, "#{payload[:class_name]} Instantiation", nil]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/active_record/sql.rb

@@ -0,0 +1,12 @@
+require "skylight/normalizers/sql"
+
+module Skylight
+  module Normalizers
+    module ActiveRecord
+      # Normalizer for SQL requests
+      class SQL < Skylight::Normalizers::SQL
+        register "sql.active_record"
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/active_storage.rb

@@ -0,0 +1,30 @@
+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",
+        "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"
+      }.freeze
+
+      TITLES.each_key do |key|
+        register key
+      end
+
+      def normalize(_trace, name, _payload)
+        title = ["ActiveStorage", TITLES[name]].join(" ")
+
+        cat = "app.#{name.split('.').reverse.join('.')}"
+
+        [cat, title, nil]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+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|
+          require "skylight/normalizers/active_support/cache_#{type}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheClear < Cache
+        register "cache_clear.active_support"
+
+        CAT = "app.cache.clear".freeze
+        TITLE = "cache clear".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheDecrement < Cache
+        register "cache_decrement.active_support"
+
+        CAT = "app.cache.decrement".freeze
+        TITLE = "cache decrement".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheDelete < Cache
+        register "cache_delete.active_support"
+
+        CAT = "app.cache.delete".freeze
+        TITLE = "cache delete".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheExist < Cache
+        register "cache_exist?.active_support"
+
+        CAT = "app.cache.exist".freeze
+        TITLE = "cache exist?".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheFetchHit < Cache
+        register "cache_fetch_hit.active_support"
+
+        CAT = "app.cache.fetch_hit".freeze
+        TITLE = "cache fetch hit".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheGenerate < Cache
+        register "cache_generate.active_support"
+
+        CAT = "app.cache.generate".freeze
+        TITLE = "cache generate".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheIncrement < Cache
+        register "cache_increment.active_support"
+
+        CAT = "app.cache.increment".freeze
+        TITLE = "cache increment".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheRead < Cache
+        register "cache_read.active_support"
+
+        CAT = "app.cache.read".freeze
+        TITLE = "cache read".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheReadMulti < Cache
+        register "cache_read_multi.active_support"
+
+        CAT = "app.cache.read_multi".freeze
+        TITLE = "cache read multi".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Skylight
+  module Normalizers
+    module ActiveSupport
+      class CacheWrite < Cache
+        register "cache_write.active_support"
+
+        CAT = "app.cache.write".freeze
+        TITLE = "cache write".freeze
+
+        def normalize(_trace, _name, _payload)
+          [CAT, TITLE, nil]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Skylight
+  module Normalizers
+    module Coach
+      class HandlerFinish < Normalizer
+        begin
+          require "coach/version"
+          version = Gem::Version.new(::Coach::VERSION)
+        rescue LoadError # rubocop:disable Lint/SuppressedException
+        end
+
+        if version && version < Gem::Version.new("1.0")
+          register "coach.handler.finish"
+        else
+          register "finish_handler.coach"
+        end
+
+        CAT = "app.coach.handler".freeze
+
+        # See information on the events Coach emits here:
+        # https://github.com/gocardless/coach#instrumentation
+
+        # Run when the handler first starts, we need to set the trace endpoint to be the
+        # handler name.
+        #
+        # We can expect the payload to have the :middleware key.
+        def normalize(trace, _name, payload)
+          trace.endpoint = payload[:middleware]
+          [CAT, payload[:middleware], nil]
+        end
+
+        def normalize_after(trace, _span, _name, payload)
+          return unless config.enable_segments?
+
+          segments = []
+
+          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
+        end
+      end
+    end
+  end
+end