ddtrace 0.39.0 → 0.40.0

data/ddtrace.gemspec

@@ -67,5 +67,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'redcarpet', '~> 3.4' if RUBY_PLATFORM != 'java'
   spec.add_development_dependency 'pry', '~> 0.10.4'
   spec.add_development_dependency 'pry-stack_explorer', '~> 0.4.9.2'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'warning', '~> 1' if RUBY_VERSION >= '2.5.0'
 end

data/docs/DevelopmentGuide.md

@@ -98,6 +98,22 @@ $ bundle exec appraisal contrib rake spec:redis'[--seed,1234]'
 
 This can be useful for replicating conditions from CI or isolating certain tests.
 
+**Checking test coverage**
+
+You can check test code coverage by creating a report _after_ running a test suite:
+```
+# Run the desired test suite
+$ bundle exec appraisal contrib rake spec:redis
+# Generate report for the suite executed
+$ bundle exec rake coverage:report
+```
+
+A webpage will be generated at `coverage/report/index.html` with the resulting report.
+
+Because you are likely not running all tests locally, your report will contain partial coverage results.
+You *must* check the CI step `coverage` for the complete test coverage report, ensuring coverage is not
+decreased.
+
 ### Checking code quality
 
 **Linting**

data/docs/GettingStarted.md

@@ -43,11 +43,12 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
      - [Grape](#grape)
      - [GraphQL](#graphql)
      - [gRPC](#grpc)
-     - [http.rb](#http.rb)
+     - [http.rb](#http-rb)
      - [MongoDB](#mongodb)
      - [MySQL2](#mysql2)
      - [Net/HTTP](#net-http)
      - [Presto](#presto)
+     - [Que](#que)
      - [Racecar](#racecar)
      - [Rack](#rack)
      - [Rails](#rails)
@@ -92,8 +93,8 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
 |       |                            | 2.2     | Full                                 | Latest              |
 |       |                            | 2.1     | Full                                 | Latest              |
 |       |                            | 2.0     | Full                                 | Latest              |
-|       |                            | 1.9.3   | Maintenance (until August 6th, 2020) | < 0.27.0            |
-|       |                            | 1.9.1   | Maintenance (until August 6th, 2020) | < 0.27.0            |
+|       |                            | 1.9.3   | EOL since August 6th, 2020           | < 0.27.0            |
+|       |                            | 1.9.1   | EOL since August 6th, 2020           | < 0.27.0            |
 | JRuby | https://www.jruby.org      | 9.2     | Full                                 | Latest              |
 
 **Supported web servers**:
@@ -346,12 +347,13 @@ For a list of available integrations, and their configuration options, please re
 | Grape                    | `grape`                    | `>= 1.0`                 | `>= 1.0`                  | *[Link](#grape)*                    | *[Link](https://github.com/ruby-grape/grape)*                                  |
 | 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)*                                       |
+| http.rb                  | `httprb`                   | `>= 2.0`                 | `>= 2.0`                  | *[Link](#http-rb)*                  | *[Link](https://github.com/httprb/http)*                                       |
 | 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)*                                 |
 | Net/HTTP                 | `http`                     | *(Any supported Ruby)*   | *(Any supported Ruby)*    | *[Link](#nethttp)*                  | *[Link](https://ruby-doc.org/stdlib-2.4.0/libdoc/net/http/rdoc/Net/HTTP.html)* |
 | Presto                   | `presto`                   | `>= 0.5.14`              | `>= 0.5.14`               | *[Link](#presto)*                   | *[Link](https://github.com/treasure-data/presto-client-ruby)*                  |
+| Que                      | `que`                      | `>= 1.0.0.beta2`         | `>= 1.0.0.beta2`          | *[Link](#que)*                      | *[Link](https://github.com/que-rb/que)*                                        |
 | Racecar                  | `racecar`                  | `>= 0.3.5`               | `>= 0.3.5`                | *[Link](#racecar)*                  | *[Link](https://github.com/zendesk/racecar)*                                   |
 | Rack                     | `rack`                     | `>= 1.1`                 | `>= 1.1`                  | *[Link](#rack)*                     | *[Link](https://github.com/rack/rack)*                                         |
 | Rails                    | `rails`                    | `>= 3.0`                 | `>= 3.0`                  | *[Link](#rails)*                    | *[Link](https://github.com/rails/rails)*                                       |
@@ -1110,6 +1112,30 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `analytics_enabled` | Enable analytics for spans produced by this integration. `true` for on, `nil` to defer to global setting, `false` for off. | `false` |
 | `service_name` | Service name used for `presto` instrumentation | `'presto'` |
 
+### Que
+
+The Que integration is a middleware which will trace job executions.
+
+You can enable it through `Datadog.configure`:
+
+```ruby
+require 'ddtrace'
+
+Datadog.configure do |c|
+  c.use :que, options
+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` |
+| `enabled` | Defines whether Que should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
+| `service_name` | Service name used for `que` instrumentation | `'que'` |
+| `tag_args` | Enable tagging of a job's args field. `true` for on, `false` for off. | `false` |
+| `tag_data` | Enable tagging of a job's data field. `true` for on, `false` for off. | `false` |
+
 ### Racecar
 
 The Racecar integration provides tracing for Racecar jobs.
@@ -1172,7 +1198,6 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `service_name` | Service name used for `rack` instrumentation | `'rack'` |
 | `web_service_name` | Service name for frontend server request queuing spans. (e.g. `'nginx'`) | `'web-server'` |
 
-
 **Configuring URL quantization behavior**
 
 ```ruby
@@ -1232,6 +1257,7 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `middleware_names` | Enables any short-circuited middleware requests to display the middleware name as a resource for the trace. | `false` |
 | `service_name` | Service name used when tracing application requests (on the `rack` level) | `'<app_name>'` (inferred from your Rails application namespace) |
 | `template_base_path` | Used when the template name is parsed. If you don't store your templates in the `views/` folder, you may need to change this value | `'views/'` |
+| `log_injection` | Automatically enables injection [Trace Correlation](#trace-correlation) information, such as `dd.trace_id`, into Rails logs. Supports the default logger (`ActiveSupport::TaggedLogging`) and `Lograge`. Details on the format of Trace Correlation information can be found in the [Trace Correlation](#trace-correlation) section.  | `false` |
 
 **Supported versions**
 
@@ -1721,6 +1747,7 @@ Other Environment Variables:
 - `DD_TRACE_<INTEGRATION>_ENABLED`: Enables or disables an **activated** integration. Defaults to `true`.. e.g. `DD_TRACE_RAILS_ENABLED=false`. This option has no effects on integrations that have not been explicitly activated (e.g. `Datadog.configure{ |c| c.use :integration }`).on code. This environment variable can only be used to disable an integration.
 - `DD_TRACE_<INTEGRATION>_ANALYTICS_ENABLED`: Enables or disable App Analytics for a specific integration. Valid values are: true or false (default). e.g. `DD_TRACE_ACTION_CABLE_ANALYTICS_ENABLED=true`.
 - `DD_TRACE_<INTEGRATION>_ANALYTICS_SAMPLE_RATE`: Sets the App Analytics sampling rate for a specific integration. A floating number between 0.0 and 1.0 (default). e.g. `DD_TRACE_ACTION_CABLE_ANALYTICS_SAMPLE_RATE=0.5`.
+- `DD_LOGS_INJECTION`: Automatically enables injection [Trace Correlation](#trace-correlation) information, such as `dd.trace_id`, into Rails logs. Supports the default logger (`ActiveSupport::TaggedLogging`) and `Lograge`. Details on the format of Trace Correlation information can be found in the [Trace Correlation](#trace-correlation) section. Valid values are: `true` or `false`(default). e.g. `DD_LOGS_INJECTION=true`.
 
 ### Sampling
 
@@ -1887,7 +1914,7 @@ For more details on how to activate distributed tracing for integrations, see th
 - [Rack](#rack)
 - [Rails](#rails)
 - [Sinatra](#sinatra)
-- [http.rb](#http.rb)
+- [http.rb](#http-rb)
 
 **Using the HTTP propagator**
 
@@ -2001,34 +2028,26 @@ Datadog::Pipeline.before_flush(
 
 ### Trace correlation
 
-In many cases, such as logging, it may be useful to correlate trace IDs to other events or data streams, for easier cross-referencing. The tracer can produce a correlation identifier for the currently active trace via `active_correlation`, which can be used to decorate these other data sources.
+In many cases, such as logging, it may be useful to correlate trace IDs to other events or data streams, for easier cross-referencing.
+
+#### For logging in Rails applications
+
+##### Automatic
+
+For Rails applications using the default logger (`ActiveSupport::TaggedLogging`) or `lograge`, you can automatically enable trace correlation injection by setting the `rails` instrumentation configuration option `log_injection` to `true` or by setting environment variable `DD_LOGS_INJECTION=true`:
 
 ```ruby
-# When a trace is active...
-Datadog.tracer.trace('correlation.example') do
-  # Returns #<Datadog::Correlation::Identifier>
-  correlation = Datadog.tracer.active_correlation
-  correlation.trace_id # => 5963550561812073440
-  correlation.span_id # => 2232727802607726424
-  correlation.env # => 'production' (derived from DD_ENV)
-  correlation.service # => 'billing-api' (derived from DD_SERVICE)
-  correlation.version # => '2.5.17' (derived from DD_VERSION)
-end
+# config/initializers/datadog.rb
+require 'ddtrace'
 
-# When a trace isn't active...
-correlation = Datadog.tracer.active_correlation
-# Returns #<Datadog::Correlation::Identifier>
-correlation = Datadog.tracer.active_correlation
-correlation.trace_id # => 0
-correlation.span_id # => 0
-correlation.env # => 'production' (derived from DD_ENV)
-correlation.service # => 'billing-api' (derived from DD_SERVICE)
-correlation.version # => '2.5.17' (derived from DD_VERSION)
+Datadog.configure do |c|
+  c.use :rails, log_injection: true
+end
 ```
 
-#### For logging in Rails applications using Lograge (recommended)
+##### Manual (Lograge)
 
-After [setting up Lograge in a Rails application](https://docs.datadoghq.com/logs/log_collection/ruby/), modify the `custom_options` block in your environment configuration file (e.g. `config/environments/production.rb`) to add the trace IDs:
+After [setting up Lograge in a Rails application](https://docs.datadoghq.com/logs/log_collection/ruby/), manually modify the `custom_options` block in your environment configuration file (e.g. `config/environments/production.rb`) to add the trace IDs. 
 
 ```ruby
 config.lograge.custom_options = lambda do |event|
@@ -2051,11 +2070,9 @@ config.lograge.custom_options = lambda do |event|
 end
 ```
 
-#### For logging in Rails applications
-
-Rails applications which are configured with an `ActiveSupport::TaggedLogging` logger can append correlation IDs as tags to log output. The default Rails logger implements this tagged logging, making it easier to add correlation tags.
+##### Manual (ActiveSupport::TaggedLogging)
 
-In your Rails environment configuration file, add the following:
+Rails applications which are configured with the default `ActiveSupport::TaggedLogging` logger can append correlation IDs as tags to log output. To enable Trace Correlation with `ActiveSupport::TaggedLogging`, in your Rails environment configuration file, add the following:
 
 ```ruby
 Rails.application.configure do

data/lib/ddtrace.rb

@@ -59,6 +59,7 @@ require 'ddtrace/contrib/httprb/integration'
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/kafka/integration'
 require 'ddtrace/contrib/presto/integration'
+require 'ddtrace/contrib/que/integration'
 require 'ddtrace/contrib/mysql2/integration'
 require 'ddtrace/contrib/mongodb/integration'
 require 'ddtrace/contrib/racecar/integration'

data/lib/ddtrace/configuration.rb

@@ -22,9 +22,9 @@ module Datadog
         # Build immutable components from settings
         @components ||= nil
         @components = if @components
-                        Components.replace!(@components, target)
+                        replace_components!(target, @components)
                       else
-                        Components.new(target)
+                        build_components(target)
                       end
 
         target
@@ -36,18 +36,49 @@ module Datadog
     def_delegators \
       :components,
       :health_metrics,
-      :logger,
       :runtime_metrics,
       :tracer
 
+    def logger
+      if instance_variable_defined?(:@components) && @components
+        @temp_logger = nil
+        components.logger
+      else
+        # Use default logger without initializing components.
+        # This prevents recursive loops while initializing.
+        # e.g. Get logger --> Build components --> Log message --> Repeat...
+        @temp_logger ||= begin
+          logger = configuration.logger.instance || Datadog::Logger.new(STDOUT)
+          logger.level = configuration.diagnostics.debug ? ::Logger::DEBUG : configuration.logger.level
+          logger
+        end
+      end
+    end
+
     def shutdown!
-      components.teardown! if @components
+      components.shutdown! if instance_variable_defined?(:@components) && @components
     end
 
     protected
 
     def components
-      @components ||= Components.new(configuration)
+      @components ||= build_components(configuration)
+    end
+
+    private
+
+    def build_components(settings)
+      components = Components.new(settings)
+      components.startup!(settings)
+      components
+    end
+
+    def replace_components!(settings, old)
+      components = Components.new(settings)
+
+      old.shutdown!(components)
+      components.startup!(settings)
+      components
     end
   end
 end

data/lib/ddtrace/configuration/components.rb

@@ -10,12 +10,6 @@ module Datadog
     # rubocop:disable Metrics/LineLength
     class Components
       class << self
-        def replace!(old, settings)
-          replacement = new(settings)
-          old.teardown!(replacement)
-          replacement
-        end
-
         def build_health_metrics(settings)
           settings = settings.diagnostics.health_metrics
           options = { enabled: settings.enabled }
@@ -118,10 +112,13 @@ module Datadog
         @health_metrics = self.class.build_health_metrics(settings)
       end
 
+      # Starts up components
+      def startup!(settings); end
+
       # Shuts down all the components in use.
       # If it has another instance to compare to, it will compare
       # and avoid tearing down parts still in use.
-      def teardown!(replacement = nil)
+      def shutdown!(replacement = nil)
         # Shutdown the old tracer, unless it's still being used.
         # (e.g. a custom tracer instance passed in.)
         tracer.shutdown! unless replacement && tracer == replacement.tracer

data/lib/ddtrace/contrib/action_pack/action_controller/instrumentation.rb

@@ -66,13 +66,6 @@ module Datadog
                 span.status = 1 if status.starts_with?('5')
               elsif Utils.exception_is_error?(exception)
                 span.set_error(exception)
-
-                # Some exception gets handled by Rails middleware before it can be set on Rack middleware
-                # The rack span is the root span of the request and should make sure it has the full exception
-                # set on it.
-                if env[:datadog_rack_request_span]
-                  env[:datadog_rack_request_span].set_error(exception)
-                end
               end
             ensure
               span.finish

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/configuration/settings'
+
+module Datadog
+  module Contrib
+    module Que
+      module Configuration
+        # Default settings for the Que integration
+        class Settings < Datadog::Contrib::Configuration::Settings
+          option :service_name, default: Ext::SERVICE_NAME
+          option :distributed_tracing, default: true
+
+          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 :tag_args do |o|
+            o.default { env_to_bool(Ext::ENV_TAG_ARGS_ENABLED, false) }
+            o.lazy
+          end
+
+          option :tag_data do |o|
+            o.default { env_to_bool(Ext::ENV_TAG_DATA_ENABLED, false) }
+            o.lazy
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Contrib
+    module Que
+      # Que integration constants
+      module Ext
+        APP = 'que'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_QUE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_QUE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'.freeze
+        ENV_TAG_ARGS_ENABLED = 'DD_TRACE_QUE_TAG_ARGS_ENABLED'.freeze
+        ENV_TAG_DATA_ENABLED = 'DD_TRACE_QUE_TAG_DATA_ENABLED'.freeze
+        SERVICE_NAME = 'que'.freeze
+        SPAN_JOB = 'que.job'.freeze
+        TAG_JOB_ARGS = 'que.job.args'.freeze
+        TAG_JOB_DATA = 'que.job.data'.freeze
+        TAG_JOB_ERROR_COUNT = 'que.job.error_count'.freeze
+        TAG_JOB_EXPIRED_AT = 'que.job.expired_at'.freeze
+        TAG_JOB_FINISHED_AT = 'que.job.finished_at'.freeze
+        TAG_JOB_ID = 'que.job.id'.freeze
+        TAG_JOB_PRIORITY = 'que.job.priority'.freeze
+        TAG_JOB_QUEUE = 'que.job.queue'.freeze
+        TAG_JOB_RUN_AT = 'que.job.run_at'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/que/ext'
+require 'ddtrace/contrib/que/configuration/settings'
+require 'ddtrace/contrib/que/patcher'
+
+module Datadog
+  module Contrib
+    module Que
+      # Description of Que integration
+      class Integration
+        include Datadog::Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('1.0.0.beta2')
+
+        register_as :que, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs[Datadog::Contrib::Que::Ext::APP] &&
+            Gem.loaded_specs[Datadog::Contrib::Que::Ext::APP].version
+        end
+
+        def self.loaded?
+          !defined?(::Que).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/que/patcher.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/que/tracer'
+
+module Datadog
+  module Contrib
+    module Que
+      # Patcher enables patching of 'que' module.
+      module Patcher
+        include Datadog::Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          ::Que.job_middleware.push(Que::Tracer.new)
+        end
+      end
+    end
+  end
+end