ddtrace 0.32.0 → 0.33.0

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

@@ -19,8 +19,8 @@ module Datadog
           Gem.loaded_specs['activerecord'] && Gem.loaded_specs['activerecord'].version
         end
 
-        def self.present?
-          super && defined?(::ActiveRecord)
+        def self.loaded?
+          defined?(::ActiveRecord)
         end
 
         def self.compatible?

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

@@ -17,8 +17,8 @@ module Datadog
           Gem.loaded_specs['activesupport'] && Gem.loaded_specs['activesupport'].version
         end
 
-        def self.present?
-          super && defined?(::ActiveSupport)
+        def self.loaded?
+          defined?(::ActiveSupport)
         end
 
         def self.compatible?

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

@@ -19,8 +19,12 @@ module Datadog
           end
         end
 
-        def self.present?
-          super && defined?(::Seahorse::Client::Base)
+        def self.loaded?
+          defined?(::Seahorse::Client::Base)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('2.0')
         end
 
         def default_configuration

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

@@ -28,9 +28,15 @@ module Datadog
         end
 
         def loaded_constants
-          SERVICES.each_with_object([]) do |service, constants|
+          # Cross-check services against loaded AWS constants
+          # Module#const_get can return a constant from ancestors when there's a miss.
+          # If this conincidentally matches another constant, it will attempt to patch
+          # the wrong constant, resulting in patch failure.
+          available_services = ::Aws.constants & SERVICES.map(&:to_sym)
+
+          available_services.each_with_object([]) do |service, constants|
             next if ::Aws.autoload?(service)
-            constants << ::Aws.const_get(service).const_get(:Client) rescue next
+            constants << ::Aws.const_get(service, false).const_get(:Client, false) rescue next
           end
         end
 

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

@@ -15,8 +15,12 @@ module Datadog
           Gem.loaded_specs['concurrent-ruby'] && Gem.loaded_specs['concurrent-ruby'].version
         end
 
-        def self.present?
-          super && defined?(::Concurrent::Future)
+        def self.loaded?
+          defined?(::Concurrent::Future)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('0.9')
         end
 
         def default_configuration

data/lib/ddtrace/contrib/configurable.rb

@@ -20,35 +20,52 @@ module Datadog
           @resolver = nil
         end
 
+        # Get matching configuration for key.
+        # If no match, returns default configuration.
         def configuration(key = :default)
-          configurations[resolve_configuration_key(key)]
+          configurations[configuration_key(key)]
+        end
+
+        # If the key has matching configuration explicitly defined for it,
+        # then return true. Otherwise return false.
+        def configuration_for?(key)
+          key = resolver.resolve(key) unless key == :default
+          configurations.key?(key)
         end
 
         def configurations
-          @configurations ||= Hash.new { default_configuration }.tap do |configs|
-            configs[:default] = default_configuration
-          end
+          @configurations ||= {
+            default: default_configuration
+          }
         end
 
+        # Create or update configuration with provided settings.
         def configure(key, options = {}, &block)
-          key = resolver.resolve(key || :default)
+          key ||= :default
 
-          configurations[key].tap do |settings|
-            settings.configure(options, &block)
-            configurations[key] = settings
-          end
+          # Get or add the configuration
+          config = configuration_for?(key) ? configuration(key) : add_configuration(key)
+
+          # Apply the settings
+          config.configure(options, &block)
+          config
         end
 
         protected
 
-        attr_writer :resolver
-
         def resolver
           @resolver ||= Configuration::Resolver.new
         end
 
-        def resolve_configuration_key(key = :default)
-          key = :default if key.nil?
+        def add_configuration(key)
+          resolver.add(key)
+          config_key = resolver.resolve(key)
+          configurations[config_key] = default_configuration
+        end
+
+        def configuration_key(key)
+          return :default if key.nil? || key == :default
+
           key = resolver.resolve(key)
           key = :default unless configurations.key?(key)
           key

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

@@ -1,10 +1,14 @@
 module Datadog
   module Contrib
     module Configuration
-      # Resolves a value to a configuration key
+      # Resolves a configuration key to a Datadog::Contrib::Configuration:Settings object
       class Resolver
-        def resolve(name)
-          name
+        def resolve(key)
+          key
+        end
+
+        def add(key)
+          key
         end
       end
     end

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

@@ -15,8 +15,8 @@ module Datadog
           Gem.loaded_specs['dalli'] && Gem.loaded_specs['dalli'].version
         end
 
-        def self.present?
-          super && defined?(::Dalli)
+        def self.loaded?
+          defined?(::Dalli)
         end
 
         def self.compatible?

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

@@ -15,8 +15,12 @@ module Datadog
           Gem.loaded_specs['delayed_job'] && Gem.loaded_specs['delayed_job'].version
         end
 
-        def self.present?
-          super && defined?(::Delayed)
+        def self.loaded?
+          defined?(::Delayed)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('4.1')
         end
 
         def default_configuration

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

@@ -16,8 +16,8 @@ module Datadog
             && Gem.loaded_specs['elasticsearch-transport'].version
         end
 
-        def self.present?
-          super && defined?(::Elasticsearch::Transport)
+        def self.loaded?
+          defined?(::Elasticsearch::Transport)
         end
 
         def self.compatible?

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

@@ -14,8 +14,12 @@ module Datadog
           Gem.loaded_specs['ethon'] && Gem.loaded_specs['ethon'].version
         end
 
-        def self.present?
-          super && defined?(::Ethon::Easy)
+        def self.loaded?
+          defined?(::Ethon::Easy)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('0.11.0')
         end
 
         def default_configuration

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

@@ -15,8 +15,12 @@ module Datadog
           Gem.loaded_specs['excon'] && Gem.loaded_specs['excon'].version
         end
 
-        def self.present?
-          super && defined?(::Excon)
+        def self.loaded?
+          defined?(::Excon)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('0.62')
         end
 
         def default_configuration

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

@@ -15,8 +15,8 @@ module Datadog
           Gem.loaded_specs['faraday'] && Gem.loaded_specs['faraday'].version
         end
 
-        def self.present?
-          super && defined?(::Faraday)
+        def self.loaded?
+          defined?(::Faraday)
         end
 
         def self.compatible?

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

@@ -15,12 +15,12 @@ module Datadog
           Gem.loaded_specs['grape'] && Gem.loaded_specs['grape'].version
         end
 
-        def self.present?
-          super && defined?(::Grape)
+        def self.loaded?
+          defined?(::Grape) && defined?(::ActiveSupport::Notifications)
         end
 
         def self.compatible?
-          super && defined?(::ActiveSupport::Notifications)
+          super && version >= Gem::Version.new('1.0')
         end
 
         def default_configuration

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

@@ -15,14 +15,12 @@ module Datadog
           Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version
         end
 
-        def self.present?
-          super && defined?(::GraphQL)
+        def self.loaded?
+          defined?(::GraphQL) && defined?(::GraphQL::Tracing::DataDogTracing)
         end
 
         def self.compatible?
-          super \
-            && defined?(::GraphQL::Tracing::DataDogTracing) \
-            && version >= Gem::Version.new('1.7.9')
+          super && version >= Gem::Version.new('1.7.9')
         end
 
         def default_configuration

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

@@ -15,8 +15,8 @@ module Datadog
           Gem.loaded_specs['grpc'] && Gem.loaded_specs['grpc'].version
         end
 
-        def self.present?
-          super && defined?(::GRPC)
+        def self.loaded?
+          defined?(::GRPC)
         end
 
         def self.compatible?

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

@@ -19,6 +19,10 @@ module Datadog
           Gem::Version.new(RUBY_VERSION)
         end
 
+        def self.loaded?
+          defined?(::Net::HTTP)
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -15,8 +15,8 @@ module Datadog
           Gem.loaded_specs['mongo'] && Gem.loaded_specs['mongo'].version
         end
 
-        def self.present?
-          super && defined?(::Mongo::Monitoring::Global)
+        def self.loaded?
+          defined?(::Mongo::Monitoring::Global)
         end
 
         def self.compatible?

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

@@ -15,8 +15,12 @@ module Datadog
           Gem.loaded_specs['mysql2'] && Gem.loaded_specs['mysql2'].version
         end
 
-        def self.present?
-          super && defined?(::Mysql2)
+        def self.loaded?
+          defined?(::Mysql2)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('0.3.21')
         end
 
         def default_configuration

data/lib/ddtrace/contrib/patchable.rb

@@ -13,12 +13,24 @@ module Datadog
           nil
         end
 
-        def present?
+        # Is the target available? (e.g. gem installed?)
+        def available?
           !version.nil?
         end
 
+        # Is the target loaded into the application? (e.g. constants defined?)
+        def loaded?
+          true
+        end
+
+        # Is the loaded code compatible with this integration? (e.g. minimum version met?)
         def compatible?
-          Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(VERSION::MINIMUM_RUBY_VERSION) && present?
+          Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(VERSION::MINIMUM_RUBY_VERSION)
+        end
+
+        # Can the patch for this integration be applied?
+        def patchable?
+          available? && loaded? && compatible?
         end
       end
 
@@ -29,8 +41,13 @@ module Datadog
         end
 
         def patch
-          if !self.class.compatible? || patcher.nil?
-            Datadog::Logger.log.warn("Unable to patch #{self.class.name}")
+          if !self.class.patchable? || patcher.nil?
+            desc = "Available?: #{self.class.available?}"
+            desc += ", Loaded? #{self.class.loaded?}"
+            desc += ", Compatible? #{self.class.compatible?}"
+            desc += ", Patchable? #{self.class.patchable?}"
+
+            Datadog::Logger.log.warn("Unable to patch #{self.class.name} (#{desc})")
             return
           end
 

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

@@ -0,0 +1,23 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/presto/ext'
+
+module Datadog
+  module Contrib
+    module Presto
+      module Configuration
+        # Custom settings for the Presto integration
+        class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Datadog
+  module Contrib
+    module Presto
+      # Presto integration constants
+      module Ext
+        APP = 'presto'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_PRESTO_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_PRESTO_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'presto'.freeze
+        SPAN_QUERY = 'presto.query'.freeze
+        SPAN_RESUME = 'presto.resume_query'.freeze
+        SPAN_KILL = 'presto.kill_query'.freeze
+        TAG_SCHEMA_NAME = 'presto.schema'.freeze
+        TAG_CATALOG_NAME = 'presto.catalog'.freeze
+        TAG_USER_NAME = 'presto.user'.freeze
+        TAG_TIME_ZONE = 'presto.time_zone'.freeze
+        TAG_LANGUAGE = 'presto.language'.freeze
+        TAG_PROXY = 'presto.http_proxy'.freeze
+        TAG_MODEL_VERSION = 'presto.model_version'.freeze
+        TAG_QUERY_ID = 'presto.query.id'.freeze
+        TAG_QUERY_ASYNC = 'presto.query.async'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/presto/instrumentation.rb

@@ -0,0 +1,107 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/sql'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/presto/ext'
+
+module Datadog
+  module Contrib
+    module Presto
+      # Instrumentation for Presto integration
+      module Instrumentation
+        # Instrumentation for Presto::Client::Client
+        module Client
+          def self.included(base)
+            base.send(:prepend, InstanceMethods)
+          end
+
+          # Instance methods for Presto::Client
+          module InstanceMethods
+            def run(query)
+              tracer.trace(Ext::SPAN_QUERY, span_options) do |span|
+                begin
+                  decorate!(span)
+                  span.resource = query
+                  span.span_type = Datadog::Ext::SQL::TYPE
+                  span.set_tag(Ext::TAG_QUERY_ASYNC, false)
+                rescue StandardError => e
+                  Datadog::Logger.log.debug("error preparing span for presto: #{e}")
+                ensure
+                  super(query)
+                end
+              end
+            end
+
+            def query(query, &blk)
+              tracer.trace(Ext::SPAN_QUERY, span_options) do |span|
+                begin
+                  decorate!(span)
+                  span.resource = query
+                  span.span_type = Datadog::Ext::SQL::TYPE
+                  span.set_tag(Ext::TAG_QUERY_ASYNC, !blk.nil?)
+                rescue StandardError => e
+                  Datadog::Logger.log.debug("error preparing span for presto: #{e}")
+                ensure
+                  super(query, &blk)
+                end
+              end
+            end
+
+            def kill(query_id)
+              tracer.trace(Ext::SPAN_KILL, span_options) do |span|
+                begin
+                  decorate!(span)
+                  span.resource = Ext::SPAN_KILL
+                  span.span_type = Datadog::Ext::AppTypes::DB
+                  # ^ not an SQL type span, since there's no SQL query
+                  span.set_tag(Ext::TAG_QUERY_ID, query_id)
+                rescue StandardError => e
+                  Datadog::Logger.log.debug("error preparing span for presto: #{e}")
+                ensure
+                  super(query_id)
+                end
+              end
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration[:presto]
+            end
+
+            def span_options
+              {
+                service: datadog_configuration[:service_name],
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::DB
+              }
+            end
+
+            def tracer
+              datadog_configuration.tracer
+            end
+
+            def decorate!(span)
+              set_nilable_tag!(span, :server, Datadog::Ext::NET::TARGET_HOST)
+              set_nilable_tag!(span, :user, Ext::TAG_USER_NAME)
+              set_nilable_tag!(span, :schema, Ext::TAG_SCHEMA_NAME)
+              set_nilable_tag!(span, :catalog, Ext::TAG_CATALOG_NAME)
+              set_nilable_tag!(span, :time_zone, Ext::TAG_TIME_ZONE)
+              set_nilable_tag!(span, :language, Ext::TAG_LANGUAGE)
+              set_nilable_tag!(span, :http_proxy, Ext::TAG_PROXY)
+              set_nilable_tag!(span, :model_version, Ext::TAG_MODEL_VERSION)
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+            end
+
+            def set_nilable_tag!(span, key, tag_name)
+              @options[key].tap { |val| span.set_tag(tag_name, val) if val }
+            end
+          end
+        end
+      end
+    end
+  end
+end