ddtrace 0.20.0 → 0.21.0

data/lib/ddtrace/contrib/grpc/datadog_interceptor/server.rb

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/http'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/grpc/ext'
 
 module Datadog
@@ -44,6 +45,9 @@ module Datadog
               next if reserved_headers.include?(header)
               span.set_tag(header, value)
             end
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
           rescue StandardError => e
             Datadog::Tracer.log.debug("GRPC client trace failed: #{e}")
           end

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

@@ -4,8 +4,9 @@ module Datadog
       # gRPC integration constants
       module Ext
         APP = 'grpc'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_GRPC_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_GRPC_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'grpc'.freeze
-
         SPAN_CLIENT = 'grpc.client'.freeze
         SPAN_SERVICE = 'grpc.service'.freeze
       end

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the HTTP 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 :distributed_tracing, default: true
           option :service_name, default: Ext::SERVICE_NAME
         end

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

@@ -4,8 +4,9 @@ module Datadog
       # HTTP integration constants
       module Ext
         APP = 'net/http'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_HTTP_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'net/http'.freeze
-
         SPAN_REQUEST = 'http.request'.freeze
       end
     end

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

@@ -4,6 +4,7 @@ require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
+require 'ddtrace/contrib/analytics'
 
 module Datadog
   module Contrib
@@ -22,6 +23,17 @@ module Datadog
           end
         end
 
+        # Span hook invoked after request is completed.
+        def self.after_request(&block)
+          if block_given?
+            # Set hook
+            @after_request = block
+          else
+            # Get hook
+            @after_request ||= nil
+          end
+        end
+
         # Compatibility shim for Rubies not supporting `.prepend`
         module InstanceMethodsCompatibility
           def self.included(base)
@@ -38,7 +50,6 @@ module Datadog
 
         # InstanceMethods - implementing instrumentation
         module InstanceMethods
-          # rubocop:disable Metrics/MethodLength
           def request(req, body = nil, &block) # :yield: +response+
             pin = datadog_pin
             return super(req, body, &block) unless pin && pin.tracer
@@ -53,12 +64,7 @@ module Datadog
               begin
                 span.service = pin.service
                 span.span_type = Datadog::Ext::HTTP::TYPE
-
                 span.resource = req.method
-                # Using the method as a resource, as URL/path can trigger
-                # a possibly infinite number of resources.
-                span.set_tag(Datadog::Ext::HTTP::URL, req.path)
-                span.set_tag(Datadog::Ext::HTTP::METHOD, req.method)
 
                 if pin.tracer.enabled && !Datadog::Contrib::HTTP.should_skip_distributed_tracing?(pin)
                   req.add_field(Datadog::Ext::DistributedTracing::HTTP_HEADER_TRACE_ID, span.trace_id)
@@ -75,26 +81,41 @@ module Datadog
               ensure
                 response = super(req, body, &block)
               end
-              span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
-              if req.respond_to?(:uri) && req.uri
-                span.set_tag(Datadog::Ext::NET::TARGET_HOST, req.uri.host)
-                span.set_tag(Datadog::Ext::NET::TARGET_PORT, req.uri.port.to_s)
-              else
-                span.set_tag(Datadog::Ext::NET::TARGET_HOST, @address)
-                span.set_tag(Datadog::Ext::NET::TARGET_PORT, @port.to_s)
-              end
 
-              case response.code.to_i / 100
-              when 4
-                span.set_error(response)
-              when 5
-                span.set_error(response)
+              # Add additional tags to the span.
+              annotate_span!(span, req, response)
+
+              # Invoke hook, if set.
+              unless Contrib::HTTP::Instrumentation.after_request.nil?
+                Contrib::HTTP::Instrumentation.after_request.call(span, self, req, response)
               end
 
               response
             end
           end
 
+          def annotate_span!(span, request, response)
+            span.set_tag(Datadog::Ext::HTTP::URL, request.path)
+            span.set_tag(Datadog::Ext::HTTP::METHOD, request.method)
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
+
+            if request.respond_to?(:uri) && request.uri
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, request.uri.host)
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, request.uri.port.to_s)
+            else
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, @address)
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, @port.to_s)
+            end
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            case response.code.to_i
+            when 400...599
+              span.set_error(response)
+            end
+          end
+
           def datadog_pin
             @datadog_pin ||= begin
               service = Datadog.configuration[:http][:service_name]
@@ -103,6 +124,20 @@ module Datadog
               Datadog::Pin.new(service, app: Ext::APP, app_type: Datadog::Ext::AppTypes::WEB, tracer: tracer)
             end
           end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:http]
+          end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
         end
       end
     end

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

@@ -9,6 +9,14 @@ module Datadog
         class Settings < Contrib::Configuration::Settings
           DEFAULT_QUANTIZE = { show: [:collection, :database, :operation] }.freeze
 
+          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 :quantize, default: DEFAULT_QUANTIZE
           option :service_name, default: Ext::SERVICE_NAME
         end

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

@@ -4,11 +4,11 @@ module Datadog
       # MongoDB integration constants
       module Ext
         APP = 'mongodb'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_MONGO_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_MONGO_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'mongodb'.freeze
-
         SPAN_COMMAND = 'mongo.cmd'.freeze
         SPAN_TYPE_COMMAND = 'mongodb'.freeze
-
         TAG_COLLECTION = 'mongodb.collection'.freeze
         TAG_DB = 'mongodb.db'.freeze
         TAG_OPERATION = 'mongodb.operation'.freeze

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

@@ -1,3 +1,4 @@
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/mongodb/ext'
 require 'ddtrace/contrib/mongodb/parsers'
 
@@ -23,6 +24,11 @@ module Datadog
           query = MongoDB.query_builder(event.command_name, event.database_name, event.command)
           serialized_query = query.to_s
 
+          # Set analytics sample rate
+          if analytics_enabled?
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+          end
+
           # add operation tags; the full query is stored and used as a resource,
           # since it has been quantized and reduced
           span.set_tag(Ext::TAG_DB, query['database'])
@@ -84,6 +90,18 @@ module Datadog
           return if Thread.current[:datadog_mongo_span].nil?
           Thread.current[:datadog_mongo_span].delete(event.request_id)
         end
+
+        def analytics_enabled?
+          Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+        end
+
+        def analytics_sample_rate
+          datadog_configuration[:analytics_sample_rate]
+        end
+
+        def datadog_configuration
+          Datadog.configuration[:mongo]
+        end
       end
     end
   end

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the Mysql2 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

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

@@ -4,10 +4,10 @@ module Datadog
       # Mysql2 integration constants
       module Ext
         APP = 'mysql2'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_MYSQL2_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_MYSQL2_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'mysql2'.freeze
-
         SPAN_QUERY = 'mysql2.query'.freeze
-
         TAG_DB_NAME = 'mysql2.db.name'.freeze
       end
     end

data/lib/ddtrace/contrib/mysql2/{client.rb → instrumentation.rb}

@@ -1,20 +1,19 @@
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/sql'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/mysql2/ext'
 
 module Datadog
   module Contrib
     module Mysql2
       # Mysql2::Client patch module
-      module Client
-        module_function
-
-        def included(base)
+      module Instrumentation
+        def self.included(base)
           if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
             base.class_eval do
-              alias_method :aliased_query, :query
-              remove_method :query
+              # Instance methods
+              include InstanceMethodsCompatibility
               include InstanceMethods
             end
           else
@@ -24,22 +23,29 @@ module Datadog
 
         # Mysql2::Client patch 1.9.3 instance methods
         module InstanceMethodsCompatibility
-          def query(*args)
-            aliased_query(*args)
+          def self.included(base)
+            base.class_eval do
+              alias_method :query_without_datadog, :query
+              remove_method :query
+            end
+          end
+
+          def query(*args, &block)
+            query_without_datadog(*args, &block)
           end
         end
 
         # Mysql2::Client patch instance methods
         module InstanceMethods
-          if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
-            include InstanceMethodsCompatibility
-          end
-
           def query(sql, options = {})
             datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
               span.resource = sql
               span.service = datadog_pin.service
               span.span_type = Datadog::Ext::SQL::TYPE
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
               span.set_tag(Ext::TAG_DB_NAME, query_options[:database])
               span.set_tag(Datadog::Ext::NET::TARGET_HOST, query_options[:host])
               span.set_tag(Datadog::Ext::NET::TARGET_PORT, query_options[:port])
@@ -55,6 +61,20 @@ module Datadog
               tracer: Datadog.configuration[:mysql2][:tracer]
             )
           end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:mysql2]
+          end
+
+          def analytics_enabled?
+            datadog_configuration[:analytics_enabled]
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
         end
       end
     end

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

@@ -1,5 +1,5 @@
 require 'ddtrace/contrib/patcher'
-require 'ddtrace/contrib/mysql2/client'
+require 'ddtrace/contrib/mysql2/instrumentation'
 
 module Datadog
   module Contrib
@@ -25,7 +25,7 @@ module Datadog
         end
 
         def patch_mysql2_client
-          ::Mysql2::Client.send(:include, Client)
+          ::Mysql2::Client.send(:include, Instrumentation)
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Datadog
         # Custom settings for the Racecar integration
         class Settings < Contrib::Configuration::Settings
           option  :analytics_enabled,
-                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENALBED, nil) },
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
                   lazy: true
 
           option  :analytics_sample_rate,

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

@@ -4,7 +4,7 @@ module Datadog
       # Racecar integration constants
       module Ext
         APP = 'racecar'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_RACECAR_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RACECAR_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'racecar'.freeze
         SPAN_BATCH = 'racecar.batch'.freeze

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

@@ -15,7 +15,7 @@ module Datadog
           }.freeze
 
           option  :analytics_enabled,
-                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENALBED, nil) },
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) },
                   lazy: true
 
           option  :analytics_sample_rate,

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

@@ -4,7 +4,7 @@ module Datadog
       # Rack integration constants
       module Ext
         APP = 'rack'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_RACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RACK_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_RACK_ANALYTICS_SAMPLE_RATE'.freeze
         RACK_ENV_REQUEST_SPAN = 'datadog.rack_request_span'.freeze
         SERVICE_NAME = 'rack'.freeze

data/lib/ddtrace/contrib/rails/action_controller.rb

@@ -50,6 +50,9 @@ module Datadog
               rack_request_span.resource = span.resource if rack_request_span
             end
 
+            # Set analytics sample rate
+            Utils.set_analytics_sample_rate(span)
+
             span.set_tag(Ext::TAG_ROUTE_ACTION, payload.fetch(:action))
             span.set_tag(Ext::TAG_ROUTE_CONTROLLER, payload.fetch(:controller))
 

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

@@ -53,6 +53,7 @@ module Datadog
             normalized_key = ::ActiveSupport::Cache.expand_cache_key(payload.fetch(:key))
             cache_key = Datadog::Utils.truncate(normalized_key, Ext::QUANTIZE_CACHE_MAX_KEY_SIZE)
             span.set_tag(Ext::TAG_CACHE_KEY, cache_key)
+
             span.set_error(payload[:exception]) if payload[:exception]
           ensure
             span.finish

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

@@ -6,6 +6,14 @@ module Datadog
       module Configuration
         # Custom settings for the Rails integration
         class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           option :cache_service
           option :controller_service
           option :database_service, depends_on: [:service_name] do |value|

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

@@ -4,20 +4,17 @@ module Datadog
       # Rails integration constants
       module Ext
         APP = 'rails'.freeze
-
+        ENV_ANALYTICS_ENABLED = 'DD_RAILS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RAILS_ANALYTICS_SAMPLE_RATE'.freeze
         QUANTIZE_CACHE_MAX_KEY_SIZE = 300
-
         RESOURCE_CACHE_DELETE = 'DELETE'.freeze
         RESOURCE_CACHE_GET = 'GET'.freeze
         RESOURCE_CACHE_SET = 'SET'.freeze
-
         SPAN_ACTION_CONTROLLER = 'rails.action_controller'.freeze
         SPAN_CACHE = 'rails.cache'.freeze
         SPAN_RENDER_PARTIAL = 'rails.render_partial'.freeze
         SPAN_RENDER_TEMPLATE = 'rails.render_template'.freeze
-
         SPAN_TYPE_CACHE = 'cache'.freeze
-
         TAG_CACHE_BACKEND = 'rails.cache.backend'.freeze
         TAG_CACHE_KEY = 'rails.cache.key'.freeze
         TAG_LAYOUT = 'rails.layout'.freeze