ddtrace 0.13.0 → 0.47.0

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
+          name.to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+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 :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
+          option :analytics_enabled do |o|
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 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

@@ -1,4 +1,7 @@
+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
@@ -18,7 +21,7 @@ module Datadog
           end
 
           def tracer
-            configuration[:tracer]
+            -> { configuration[:tracer] }
           end
 
           def configuration
@@ -28,15 +31,23 @@ module Datadog
           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
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
             # Set the resource name and serializer name
             res = resource(payload[:serializer])
             span.resource = res
-            span.set_tag('active_model_serializers.serializer', res)
+            span.set_tag(Ext::TAG_SERIALIZER, res)
 
             span.span_type = Datadog::Ext::HTTP::TEMPLATE
 
             # Will be nil in 0.9
-            span.set_tag('active_model_serializers.adapter', payload[:adapter].class) unless payload[:adapter].nil?
+            span.set_tag(Ext::TAG_ADAPTER, payload[:adapter].class) unless payload[:adapter].nil?
           end
 
           private

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

@@ -1,3 +1,4 @@
+require 'ddtrace/contrib/active_model_serializers/ext'
 require 'ddtrace/contrib/active_model_serializers/event'
 
 module Datadog
@@ -9,7 +10,6 @@ module Datadog
           include ActiveModelSerializers::Event
 
           EVENT_NAME = 'render.active_model_serializers'.freeze
-          SPAN_NAME = 'active_model_serializers.render'.freeze
 
           module_function
 
@@ -23,7 +23,7 @@ module Datadog
           end
 
           def span_name
-            self::SPAN_NAME
+            Ext::SPAN_RENDER
           end
         end
       end

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

@@ -1,3 +1,4 @@
+require 'ddtrace/contrib/active_model_serializers/ext'
 require 'ddtrace/contrib/active_model_serializers/event'
 
 module Datadog
@@ -9,7 +10,6 @@ module Datadog
           include ActiveModelSerializers::Event
 
           EVENT_NAME = '!serialize.active_model_serializers'.freeze
-          SPAN_NAME = 'active_model_serializers.serialize'.freeze
 
           module_function
 
@@ -26,7 +26,7 @@ module Datadog
           end
 
           def span_name
-            self::SPAN_NAME
+            Ext::SPAN_SERIALIZE
           end
         end
       end

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

@@ -0,0 +1,20 @@
+module Datadog
+  module Contrib
+    module ActiveModelSerializers
+      # ActiveModelSerializers integration constants
+      module Ext
+        APP = 'active_model_serializers'.freeze
+        ENV_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = '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,40 @@
+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
+
+        MINIMUM_VERSION = Gem::Version.new('0.9.0')
+
+        register_as :active_model_serializers
+
+        def self.version
+          Gem.loaded_specs['active_model_serializers'] \
+            && Gem.loaded_specs['active_model_serializers'].version
+        end
+
+        def self.loaded?
+          !defined?(::ActiveModel::Serializer).nil? \
+            && !defined?(::ActiveSupport::Notifications).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        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

@@ -1,60 +1,27 @@
+require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
-require 'ddtrace/ext/http'
+require 'ddtrace/contrib/active_model_serializers/ext'
 require 'ddtrace/contrib/active_model_serializers/events'
 
 module Datadog
   module Contrib
     module ActiveModelSerializers
-      # Provides instrumentation for ActiveModelSerializers through ActiveSupport instrumentation signals
+      # Patcher enables patching of 'active_model_serializers' module.
       module Patcher
-        include Base
+        include Contrib::Patcher
 
-        VERSION_REQUIRED = Gem::Version.new('0.9.0')
+        module_function
 
-        register_as :active_model_serializers
-
-        option :service_name, default: 'active_model_serializers'
-        option :tracer, default: Datadog.tracer do |value|
-          (value || Datadog.tracer).tap do |v|
-            # Make sure to update tracers of all subscriptions
-            Events.subscriptions.each do |subscription|
-              subscription.tracer = v
-            end
-          end
+        def target_version
+          Integration.version
         end
 
-        class << self
-          def patch
-            return patched? if patched? || !compatible?
-
-            # Subscribe to ActiveModelSerializers events
-            Events.subscribe!
-
-            # Set service info
-            configuration[:tracer].set_service_info(
-              configuration[:service_name],
-              'active_model_serializers',
-              Ext::AppTypes::WEB
-            )
-
-            @patched = true
-          end
-
-          def patched?
-            return @patched if defined?(@patched)
-            @patched = false
-          end
-
-          private
-
-          def configuration
-            Datadog.configuration[:active_model_serializers]
-          end
+        def patch
+          Events.subscribe!
+        end
 
-          def compatible?
-            Gem.loaded_specs['active_model_serializers'] && Gem.loaded_specs['activesupport'] \
-              && Gem.loaded_specs['active_model_serializers'].version >= VERSION_REQUIRED
-          end
+        def get_option(option)
+          Datadog.configuration[:active_model_serializers].get_option(option)
         end
       end
     end

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

@@ -0,0 +1,128 @@
+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.
+        #
+        # When matching using a Hash, these are the valid fields:
+        # ```
+        # {
+        #   adapter: ...,
+        #   host: ...,
+        #   port: ...,
+        #   database: ...,
+        #   username: ...,
+        #   role: ...,
+        # }
+        # ```
+        #
+        # Partial matching is supported: not including certain fields or setting them to `nil`
+        # will cause them to matching all values for that field. For example: `database: nil`
+        # will match any database, given the remaining fields match.
+        #
+        # Any fields not listed above are discarded.
+        #
+        # When more than one configuration could be matched, the last one to match is selected,
+        # based on addition order (`#add`).
+        class Resolver < Contrib::Configuration::Resolver
+          def initialize(active_record_configuration = nil)
+            super()
+
+            @active_record_configuration = active_record_configuration
+          end
+
+          def active_record_configuration
+            @active_record_configuration || ::ActiveRecord::Base.configurations
+          end
+
+          def add(matcher, value)
+            parsed = parse_matcher(matcher)
+
+            # In case of error parsing, don't store `nil` key
+            # as it wouldn't be useful for matching configuration
+            # hashes in `#resolve`.
+            super(parsed, value) if parsed
+          end
+
+          def resolve(db_config)
+            active_record_config = resolve_connection_key(db_config).symbolize_keys
+
+            hash = normalize(active_record_config)
+
+            # Hashes in Ruby maintain insertion order
+            _, config = @configurations.reverse_each.find do |matcher, _|
+              matcher.none? do |key, value|
+                value != hash[key]
+              end
+            end
+
+            config
+          rescue => e
+            Datadog.logger.error(
+              "Failed to resolve ActiveRecord configuration key #{db_config.inspect}. " \
+              "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
+
+            nil
+          end
+
+          protected
+
+          def parse_matcher(matcher)
+            resolved_pattern = resolve_connection_key(matcher).symbolize_keys
+            normalized = normalize(resolved_pattern)
+
+            # Remove empty fields to allow for partial matching
+            normalized.reject! { |_, v| v.nil? }
+
+            normalized
+          rescue => e
+            Datadog.logger.error(
+              "Failed to resolve ActiveRecord configuration key #{matcher.inspect}. " \
+              "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
+          end
+
+          def connection_resolver
+            @resolver ||= if defined?(::ActiveRecord::Base.configurations.resolve)
+                            ::ActiveRecord::DatabaseConfigurations.new(active_record_configuration)
+                          elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+                            ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                              active_record_configuration
+                            )
+                          else
+                            ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                              active_record_configuration
+                            )
+                          end
+          end
+
+          def resolve_connection_key(key)
+            result = connection_resolver.resolve(key)
+
+            if result.respond_to?(:configuration_hash) # Rails >= 6.1
+              result.configuration_hash
+            else # Rails < 6.1
+              result
+            end
+          end
+
+          # Extract only fields we'd like to match
+          # from the ActiveRecord configuration.
+          def normalize(active_record_config)
+            {
+              adapter: active_record_config[:adapter],
+              host: active_record_config[:host],
+              port: active_record_config[:port],
+              database: active_record_config[:database],
+              username: active_record_config[:username]
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/active_record/ext'
+require 'ddtrace/contrib/active_record/utils'
+
+module Datadog
+  module Contrib
+    module ActiveRecord
+      module Configuration
+        # Custom settings for the ActiveRecord integration
+        class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
+          option :analytics_enabled do |o|
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
+            o.lazy
+          end
+
+          option :orm_service_name
+          option :service_name do |o|
+            o.default { Utils.adapter_name }
+            o.lazy
+          end
+        end
+      end
+    end
+  end
+end