ls-trace 0.1.1

data/lib/ddtrace/contrib/action_view/integration.rb

@@ -0,0 +1,43 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/action_view/configuration/settings'
+require 'ddtrace/contrib/action_view/patcher'
+
+module Datadog
+  module Contrib
+    module ActionView
+      # Describes the ActionView integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :action_view, auto_patch: false
+
+        def self.version
+          # ActionView is its own gem in Rails 4.1+
+          if Gem.loaded_specs['actionview']
+            Gem.loaded_specs['actionview'].version
+          # ActionView is embedded in ActionPack in versions < 4.1
+          elsif Gem.loaded_specs['actionpack']
+            action_pack_version = Gem.loaded_specs['actionpack'].version
+            action_pack_version unless action_pack_version >= Gem::Version.new('4.1')
+          end
+        end
+
+        def self.present?
+          super && defined?(::ActionView)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('3.0')
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          ActionView::Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_view/patcher.rb

@@ -0,0 +1,53 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/action_view/ext'
+require 'ddtrace/contrib/action_view/instrumentation/partial_renderer'
+require 'ddtrace/contrib/action_view/instrumentation/template_renderer'
+require 'ddtrace/contrib/action_view/utils'
+
+module Datadog
+  module Contrib
+    module ActionView
+      # Patcher enables patching of ActionView module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:action_view)
+        end
+
+        def patch
+          do_once(:action_view) do
+            begin
+              patch_renderer
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Action View integration: #{e} Location: #{e.backtrace.first}")
+            end
+          end
+        end
+
+        def patch_renderer
+          do_once(:patch_renderer) do
+            if defined?(::ActionView::TemplateRenderer) && defined?(::ActionView::PartialRenderer)
+              if Integration.version < Gem::Version.new('6.0.0')
+                ::ActionView::TemplateRenderer.send(:prepend, Instrumentation::TemplateRenderer::Rails31To5)
+                ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan6)
+              else
+                ::ActionView::TemplateRenderer.send(:prepend, Instrumentation::TemplateRenderer::Rails6Plus)
+                ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::Rails6Plus)
+              end
+            elsif defined?(::ActionView::Rendering) && defined?(::ActionView::Partials::PartialRenderer)
+              # NOTE: Rails < 3.1 compatibility: different classes are used
+              ::ActionView::Rendering.send(:prepend, Instrumentation::TemplateRenderer::Rails30)
+              ::ActionView::Partials::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan6)
+            else
+              Datadog::Tracer.log.debug('Expected Template/Partial classes not found; template rendering disabled')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_view/utils.rb

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  module Contrib
+    module ActionView
+      # common utilities for Rails
+      module Utils
+        module_function
+
+        # in Rails the template name includes the template full path
+        # and it's better to avoid storing such information. This method
+        # returns the relative path from `views/` or the template name
+        # if a `views/` folder is not in the template full path. A wrong
+        # usage ensures that this method will not crash the tracing system.
+        def normalize_template_name(name)
+          return if name.nil?
+
+          base_path = Datadog.configuration[:action_view][:template_base_path]
+          sections_view = name.split(base_path)
+
+          if sections_view.length == 1
+            name.split('/')[-1]
+          else
+            sections_view[-1]
+          end
+        rescue
+          return name.to_s
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/configuration/settings.rb

@@ -0,0 +1,25 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/active_model_serializers/ext'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      module Configuration
+        # Custom settings for the ActiveModelSerializers integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/event.rb

@@ -0,0 +1,65 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/active_model_serializers/ext'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      # Defines basic behaviors for an ActiveModelSerializers event.
+      module Event
+        def self.included(base)
+          base.send(:include, ActiveSupport::Notifications::Event)
+          base.send(:extend, ClassMethods)
+        end
+
+        # Class methods for ActiveModelSerializers events.
+        # Note, they share the same process method and before_trace method.
+        module ClassMethods
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:active_model_serializers]
+          end
+
+          def process(span, event, _id, payload)
+            span.service = configuration[:service_name]
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            # Set the resource name and serializer name
+            res = resource(payload[:serializer])
+            span.resource = res
+            span.set_tag(Ext::TAG_SERIALIZER, res)
+
+            span.span_type = Datadog::Ext::HTTP::TEMPLATE
+
+            # Will be nil in 0.9
+            span.set_tag(Ext::TAG_ADAPTER, payload[:adapter].class) unless payload[:adapter].nil?
+          end
+
+          private
+
+          def resource(serializer)
+            # Depending on the version of ActiveModelSerializers
+            # serializer will be a string or an object.
+            if serializer.respond_to?(:name)
+              serializer.name
+            else
+              serializer
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/events.rb

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/active_model_serializers/events/render'
+require 'ddtrace/contrib/active_model_serializers/events/serialize'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      # Defines collection of instrumented ActiveModelSerializers events
+      module Events
+        ALL = [
+          Events::Render,
+          Events::Serialize
+        ].freeze
+
+        module_function
+
+        def all
+          self::ALL
+        end
+
+        def subscriptions
+          all.collect(&:subscriptions).collect(&:to_a).flatten
+        end
+
+        def subscribe!
+          all.each(&:subscribe!)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/events/render.rb

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/active_model_serializers/ext'
+require 'ddtrace/contrib/active_model_serializers/event'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      module Events
+        # Defines instrumentation for render.active_model_serializers event
+        module Render
+          include ActiveModelSerializers::Event
+
+          EVENT_NAME = 'render.active_model_serializers'.freeze
+
+          module_function
+
+          def supported?
+            Gem.loaded_specs['active_model_serializers'] \
+              && Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.10')
+          end
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_RENDER
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/events/serialize.rb

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/active_model_serializers/ext'
+require 'ddtrace/contrib/active_model_serializers/event'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      module Events
+        # Defines instrumentation for !serialize.active_model_serializers event
+        module Serialize
+          include ActiveModelSerializers::Event
+
+          EVENT_NAME = '!serialize.active_model_serializers'.freeze
+
+          module_function
+
+          def supported?
+            Gem.loaded_specs['active_model_serializers'] \
+              && ( \
+                Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.9') \
+                && Gem.loaded_specs['active_model_serializers'].version < Gem::Version.new('0.10') \
+              )
+          end
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_SERIALIZE
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/ext.rb

@@ -0,0 +1,17 @@
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      # ActiveModelSerializers integration constants
+      module Ext
+        APP = 'active_model_serializers'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'active_model_serializers'.freeze
+        SPAN_RENDER = 'active_model_serializers.render'.freeze
+        SPAN_SERIALIZE = 'active_model_serializers.serialize'.freeze
+        TAG_ADAPTER = 'active_model_serializers.adapter'.freeze
+        TAG_SERIALIZER = 'active_model_serializers.serializer'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/integration.rb

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/active_model_serializers/configuration/settings'
+require 'ddtrace/contrib/active_model_serializers/patcher'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      # Description of ActiveModelSerializers integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :active_model_serializers
+
+        def self.version
+          Gem.loaded_specs['active_model_serializers'] \
+            && Gem.loaded_specs['active_model_serializers'].version
+        end
+
+        def self.present?
+          super && defined?(::ActiveModel::Serializer)
+        end
+
+        def self.compatible?
+          super \
+            && defined?(::ActiveSupport::Notifications) \
+            && version >= Gem::Version.new('0.9.0')
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_model_serializers/patcher.rb

@@ -0,0 +1,36 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/active_model_serializers/ext'
+require 'ddtrace/contrib/active_model_serializers/events'
+
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      # Patcher enables patching of 'active_model_serializers' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:active_model_serializers)
+        end
+
+        def patch
+          do_once(:active_model_serializers) do
+            begin
+              # Subscribe to ActiveModelSerializers events
+              Events.subscribe!
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply ActiveModelSerializers integration: #{e}")
+            end
+          end
+        end
+
+        def get_option(option)
+          Datadog.configuration[:active_model_serializers].get_option(option)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_record/configuration/resolver.rb

@@ -0,0 +1,46 @@
+require 'ddtrace/contrib/configuration/resolver'
+require 'ddtrace/vendor/active_record/connection_specification'
+
+module Datadog
+  module Contrib
+    module ActiveRecord
+      module Configuration
+        # Converts Symbols, Strings, and Hashes to a normalized connection settings Hash.
+        class Resolver < Contrib::Configuration::Resolver
+          def initialize(configurations = nil)
+            @configurations = configurations
+          end
+
+          def configurations
+            @configurations || ::ActiveRecord::Base.configurations
+          end
+
+          def connection_resolver
+            @resolver ||= begin
+              if defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+                ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
+              else
+                ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
+              end
+            end
+          end
+
+          def resolve(spec)
+            return :default if spec == :default
+            normalize(connection_resolver.resolve(spec).symbolize_keys)
+          end
+
+          def normalize(hash)
+            {
+              adapter:  hash[:adapter],
+              host:     hash[:host],
+              port:     hash[:port],
+              database: hash[:database],
+              username: hash[:username]
+            }
+          end
+        end
+      end
+    end
+  end
+end