ddtrace 0.44.0 → 0.45.0

data/ddtrace.gemspec

@@ -56,6 +56,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '>= 3.10.0'
   spec.add_development_dependency 'builder'
   spec.add_development_dependency 'climate_control', '~> 0.2.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4.1'
 
   # locking transitive dependency of webmock
   spec.add_development_dependency 'addressable', '~> 2.4.0'

data/docs/GettingStarted.md

@@ -45,6 +45,7 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
      - [GraphQL](#graphql)
      - [gRPC](#grpc)
      - [http.rb](#http-rb)
+     - [httpclient](#httpclient)
      - [MongoDB](#mongodb)
      - [MySQL2](#mysql2)
      - [Net/HTTP](#net-http)
@@ -144,6 +145,21 @@ Install and configure the Datadog Agent to receive traces from your now instrume
 
 ### Quickstart for Rails applications
 
+#### Rails Auto Instrument all Integrations
+
+1. Add the `ddtrace` gem to your Gemfile:
+
+    ```ruby
+    source 'https://rubygems.org'
+    gem 'ddtrace', require: 'ddtrace/auto_instrument'
+    ```
+
+2. Install the gem with `bundle install`
+
+3. You can configure, override, or disable any specific integration settings by also adding a [Rails Manual Configuration](#rails-manual-configuration) file.
+
+#### Rails Manual Configuration
+
 1. Add the `ddtrace` gem to your Gemfile:
 
     ```ruby
@@ -165,6 +181,25 @@ Install and configure the Datadog Agent to receive traces from your now instrume
 
 ### Quickstart for Ruby applications
 
+#### Ruby Auto Instrument all Integrations
+
+1. Install the gem with `gem install ddtrace`
+2. Requiring any [supported libraries or frameworks](#integration-instrumentation) that should be instrumented. 
+3. Add `require 'ddtrace/auto_instrument'` to your application. _Note:_ This must be done _after_ requiring any supported libraries or frameworks.
+
+    ```ruby
+    # Example frameworks and libraries
+    require 'sinatra'
+    require 'faraday'
+    require 'redis'
+
+    require 'ddtrace/auto_instrument'
+    ```
+ 
+    You can configure, override, or disable any specific integration settings by also adding a [Ruby Manual Configuration Block](#ruby-manual-configuration).
+
+#### Ruby Manual Configuration
+
 1. Install the gem with `gem install ddtrace`
 2. Add a configuration block to your Ruby application:
 
@@ -362,6 +397,7 @@ For a list of available integrations, and their configuration options, please re
 | GraphQL                  | `graphql`                  | `>= 1.7.9`               | `>= 1.7.9`                | *[Link](#graphql)*                  | *[Link](https://github.com/rmosolgo/graphql-ruby)*                             |
 | gRPC                     | `grpc`                     | `>= 1.7`                 | *gem not available*       | *[Link](#grpc)*                     | *[Link](https://github.com/grpc/grpc/tree/master/src/rubyc)*                   |
 | http.rb                  | `httprb`                   | `>= 2.0`                 | `>= 2.0`                  | *[Link](#http-rb)*                  | *[Link](https://github.com/httprb/http)*                                       |
+| httpclient                | `httpclient`              | `>= 2.2`                 | `>= 2.2`                  | *[Link](#httpclient)*               | *[Link](https://github.com/nahi/httpclient)*                                     |
 | Kafka                    | `ruby-kafka`               | `>= 0.7.10`              | `>= 0.7.10`               | *[Link](#kafka)*                    | *[Link](https://github.com/zendesk/ruby-kafka)*                                |
 | MongoDB                  | `mongo`                    | `>= 2.1`                 | `>= 2.1`                  | *[Link](#mongodb)*                  | *[Link](https://github.com/mongodb/mongo-ruby-driver)*                         |
 | MySQL2                   | `mysql2`                   | `>= 0.3.21`              | *gem not available*       | *[Link](#mysql2)*                   | *[Link](https://github.com/brianmario/mysql2)*                                 |
@@ -1017,6 +1053,32 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `service_name` | Service name for `httprb` instrumentation. | `'httprb'` |
 | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
 
+### httpclient
+
+The httpclient integration will trace any HTTP call using the httpclient gem.
+
+```ruby
+require 'http'
+require 'ddtrace'
+Datadog.configure do |c|
+  c.use :httpclient, options
+  # optionally, specify a different service name for hostnames matching a regex
+  c.use :httpclient, describes: /user-[^.]+\.example\.com/ do |httpclient|
+    httpclient.service_name = 'user.example.com'
+    httpclient.split_by_domain = false # Only necessary if split_by_domain is true by default
+  end
+end
+```
+
+Where `options` is an optional `Hash` that accepts the following parameters:
+
+| Key | Description | Default |
+| --- | ----------- | ------- |
+| `analytics_enabled` | Enable analytics for spans produced by this integration. `true` for on, `nil` to defer to global setting, `false` for off. | `false` |
+| `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
+| `service_name` | Service name for `httpclient` instrumentation. | `'httpclient'` |
+| `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
+
 ### Kafka
 
 The Kafka integration provides tracing of the `ruby-kafka` gem:
@@ -2025,6 +2087,7 @@ For more details on how to activate distributed tracing for integrations, see th
 - [Rails](#rails)
 - [Sinatra](#sinatra)
 - [http.rb](#http-rb)
+- [httpclient](#httpclient)
 
 **Using the HTTP propagator**
 
@@ -2053,9 +2116,7 @@ end
 
 Traces that originate from HTTP requests can be configured to include the time spent in a frontend web server or load balancer queue before the request reaches the Ruby application.
 
-This functionality is **experimental** and deactivated by default.
-
-To activate this feature, you must add an `X-Request-Start` or `X-Queue-Start` header from your web server (i.e., Nginx). The following is an Nginx configuration example:
+This feature is disabled by default. To activate it, you must add an `X-Request-Start` or `X-Queue-Start` header from your web server (i.e., Nginx). The following is an Nginx configuration example:
 
 ```
 # /etc/nginx/conf.d/ruby_service.conf
@@ -2069,9 +2130,7 @@ server {
 }
 ```
 
-Then you must enable the request queuing feature in the integration handling the request.
-
-For Rack-based applications, see the [documentation](#rack) for details for enabling this feature.
+Then you must enable the request queuing feature, by setting `request_queuing: true`, in the integration handling the request. For Rack-based applications, see the [documentation](#rack) for details.
 
 ### Processing Pipeline
 

data/lib/ddtrace.rb

@@ -17,11 +17,13 @@ require 'ddtrace/configuration'
 require 'ddtrace/patcher'
 require 'ddtrace/augmentation'
 require 'ddtrace/metrics'
+require 'ddtrace/auto_instrument_base'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
 module Datadog
   extend Augmentation
   extend Configuration
+  extend AutoInstrumentBase
 
   # Load and extend Contrib by default
   require 'ddtrace/contrib/extensions'
@@ -31,6 +33,10 @@ module Datadog
   require 'ddtrace/opentelemetry/extensions'
   extend OpenTelemetry::Extensions
 
+  # Load and extend AutoInstrument
+  require 'ddtrace/contrib/auto_instrument'
+  extend Contrib::AutoInstrument
+
   # Add shutdown hook:
   # Ensures the tracer has an opportunity to flush traces
   # and cleanup before terminating the process.
@@ -56,6 +62,7 @@ require 'ddtrace/contrib/grape/integration'
 require 'ddtrace/contrib/graphql/integration'
 require 'ddtrace/contrib/grpc/integration'
 require 'ddtrace/contrib/http/integration'
+require 'ddtrace/contrib/httpclient/integration'
 require 'ddtrace/contrib/httprb/integration'
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/kafka/integration'

data/lib/ddtrace/auto_instrument.rb

@@ -0,0 +1,3 @@
+require 'ddtrace'
+
+Datadog.add_auto_instrument

data/lib/ddtrace/auto_instrument_base.rb

@@ -0,0 +1,6 @@
+module Datadog
+  # base methods stubbed for adding auto instrument extensions
+  module AutoInstrumentBase
+    def add_auto_instrument; end
+  end
+end

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_cable/configuration/settings'
 require 'ddtrace/contrib/action_cable/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +26,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_pack/configuration/settings'
 require 'ddtrace/contrib/action_pack/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +26,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_view/configuration/settings'
 require 'ddtrace/contrib/action_view/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -32,6 +33,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -5,6 +5,7 @@ require 'ddtrace/contrib/active_record/events'
 require 'ddtrace/contrib/active_record/configuration/resolver'
 require 'ddtrace/contrib/active_record/configuration/settings'
 require 'ddtrace/contrib/active_record/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -29,6 +30,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -1,3 +1,5 @@
+require 'ddtrace/ext/runtime'
+
 module Datadog
   module Contrib
     module ActiveRecord
@@ -21,42 +23,76 @@ module Datadog
           connection_config[:port]
         end
 
-        # In newer Rails versions, the `payload` contains both the `connection` and its `object_id` named `connection_id`.
-        #
-        # So, if rails is recent we'll have a direct access to the connection.
-        # Else, we'll find it thanks to the passed `connection_id`.
+        # Returns the connection configuration hash from the
+        # current connection
         #
-        # See this PR for more details: https://github.com/rails/rails/pull/34602
+        # Since Rails 6.0, we have direct access to the object,
+        # while older versions of Rails only provide us the
+        # connection id.
         #
+        # @see https://github.com/rails/rails/pull/34602
         def self.connection_config(connection = nil, connection_id = nil)
           return default_connection_config if connection.nil? && connection_id.nil?
 
           conn = if !connection.nil?
+                   # Since Rails 6.0, the connection object
+                   # is directly available.
                    connection
-                 # Rails 3.0 - 3.2
-                 elsif Gem.loaded_specs['activerecord'].version < Gem::Version.new('4.0')
-                   ::ActiveRecord::Base
-                     .connection_handler
-                     .connection_pools
-                     .values
-                     .flat_map(&:connections)
-                     .find { |c| c.object_id == connection_id }
-                 # Rails 4.2+
                  else
-                   ::ActiveRecord::Base
-                     .connection_handler
-                     .connection_pool_list
-                     .flat_map(&:connections)
-                     .find { |c| c.object_id == connection_id }
+                   # For Rails < 6.0, only the `connection_id`
+                   # is available. We have to find the connection
+                   # object from it.
+                   connection_from_id(connection_id)
                  end
 
-          if conn.instance_variable_defined?(:@config)
+          if conn && conn.instance_variable_defined?(:@config)
             conn.instance_variable_get(:@config)
           else
             EMPTY_CONFIG
           end
         end
 
+        # DEV: JRuby responds to {ObjectSpace._id2ref}, despite raising an error
+        # DEV: when invoked. Thus, we have to explicitly check for Ruby runtime.
+        if Datadog::Ext::Runtime::RUBY_ENGINE != 'jruby'
+          # CRuby has access to {ObjectSpace._id2ref}, which allows for
+          # direct look up of the connection object.
+          def self.connection_from_id(connection_id)
+            # `connection_id` is the `#object_id` of the
+            # connection. We can perform an ObjectSpace
+            # lookup to find it.
+            #
+            # This works not only for ActiveRecord, but for
+            # extensions that might have their own connection
+            # pool (e.g. https://rubygems.org/gems/makara).
+            ObjectSpace._id2ref(connection_id)
+          rescue => e
+            # Because `connection_id` references a live connection
+            # present in the current stack, it is very unlikely that
+            # `_id2ref` will fail, but we add this safeguard just
+            # in case.
+            Datadog.logger.debug(
+              "connection_id #{connection_id} does not represent a valid object. " \
+                      "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
+          end
+        else
+          # JRuby does not enable {ObjectSpace._id2ref} by default,
+          # as it has large performance impact:
+          # https://github.com/jruby/jruby/wiki/PerformanceTuning/cf155dd9#dont-enable-objectspace
+          #
+          # This fallback code does not support the makara gem,
+          # as its connections don't live in the ActiveRecord
+          # connection pool.
+          def self.connection_from_id(connection_id)
+            ::ActiveRecord::Base
+              .connection_handler
+              .connection_pool_list
+              .flat_map(&:connections)
+              .find { |c| c.object_id == connection_id }
+          end
+        end
+
         # @return [Hash]
         def self.default_connection_config
           return @default_connection_config if instance_variable_defined?(:@default_connection_config)

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

@@ -1,8 +1,8 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/active_support/configuration/settings'
 require 'ddtrace/contrib/active_support/patcher'
-
 require 'ddtrace/contrib/active_support/cache/redis'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -27,6 +27,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

data/lib/ddtrace/contrib/auto_instrument.rb

@@ -0,0 +1,48 @@
+require 'ddtrace'
+
+module Datadog
+  module Contrib
+    # Extensions for auto instrumentation added to the base library
+    # AutoInstrumentation enables all integration
+    module AutoInstrument
+      def self.extended(base)
+        base.send(:extend, Patch)
+      end
+
+      # Patch adds method for invoking auto_instrumentation
+      module Patch
+        def add_auto_instrument
+          super
+
+          if Datadog::Contrib::Rails::Utils.railtie_supported?
+            require 'ddtrace/contrib/rails/auto_instrument_railtie'
+          else
+            AutoInstrument.patch_all
+          end
+          AutoInstrument.patch_all
+        end
+      end
+
+      def self.patch_all
+        integrations = []
+
+        Datadog.registry.each do |integration|
+          # some instrumentations are automatically enabled when the `rails` instrumentation is enabled,
+          # patching them on their own automatically outside of the rails integration context would
+          # cause undesirable service naming, so we exclude them based their auto_instrument? setting.
+          # we also don't want to mix rspec/cucumber integration in as rspec is env we run tests in.
+          next unless integration.klass.auto_instrument?
+          integrations << integration.name
+        end
+
+        Datadog.configure do |c|
+          c.reduce_log_verbosity
+          # This will activate auto-instrumentation for Rails
+          integrations.each do |integration_name|
+            c.use integration_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -27,6 +27,11 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # test environments should not auto instrument test libraries
+        def auto_instrument?
+          false
+        end
+
         def default_configuration
           Configuration::Settings.new
         end