ddtrace 0.13.2 → 0.14.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780f2b1b9ec649cb4e27b271edc2ce8649c73b06ce07e7554c5ef0813fef45c2
-  data.tar.gz: 3d96d572d0d7c6cf22009e7dd4f85e363fc1c7c0e931cb87e0e39023a3d3f6c8
+  metadata.gz: 92f58d3f94ff927d412151da041ce48c3c808c3aa8b4c7a2f320c2206daad363
+  data.tar.gz: f0f9308f6e1eaba46afc42f7237faea5587cd4d4071410547d798c79f8988602
 SHA512:
-  metadata.gz: 96d472beda982529903363014e586c2fcd7381044ffb1dae859d4f5f55cd1fdba59390a129bf936ab62b1090c3cf0074a0cff0e175d686566dc95d9f7852731d
-  data.tar.gz: fb3c01d6f49061c45f6f86d3e3fe5c2858775970a572d464f836ebfd25c13dfc437e1da1e9e9809f34da60c6db1e555cbd1759cc5a5aa09547029710378cf8bf
+  metadata.gz: 06d6974ee82c2e0f1c72edbb86b0ba03a6fefe4d383b704f93ff2d2f9416bab39b520a4a9cd8458c2977be878b32d69743ae77c4170583d1a2615d1aaca070a3
+  data.tar.gz: d54d30913137f1892adb625faaa39b4c1c49b4f70c7d1750a477df3e532a34559e4731a27a7faadfad7a50793584862bde3acf801e2ab059533bf2a6b17af468

data/.rubocop.yml

@@ -1,5 +1,15 @@
 AllCops:
   TargetRubyVersion: 2.1
+  Include:
+    - 'lib/**/*.rb'
+    - 'test/**/*.rb'
+    - 'spec/**/*.rb'
+    - 'Gemfile'
+    - 'Rakefile'
+  Exclude:
+    - 'Appraisals'
+    - '*.gemspec'
+    - 'lib/ddtrace/vendor/**/*.rb'
 
 # 80 characters is a nice goal, but not worth currently changing in existing
 # code for the sake of changing it to conform to a length set in 1928 (IBM).

data/Appraisals

@@ -68,6 +68,8 @@ elsif Gem::Version.new('1.9.3') <= Gem::Version.new(RUBY_VERSION) \
       gem 'activerecord-mysql-adapter', platform: :ruby
       gem 'aws-sdk', '~> 2.0'
       gem 'dalli'
+      gem 'delayed_job'
+      gem 'delayed_job_active_record'
       gem 'elasticsearch-transport'
       gem 'excon'
       gem 'hiredis'
@@ -148,6 +150,8 @@ elsif Gem::Version.new('2.0.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'activerecord-mysql-adapter', platform: :ruby
       gem 'aws-sdk', '~> 2.0'
       gem 'dalli'
+      gem 'delayed_job'
+      gem 'delayed_job_active_record'
       gem 'elasticsearch-transport'
       gem 'excon'
       gem 'hiredis'
@@ -248,6 +252,8 @@ elsif Gem::Version.new('2.1.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'activerecord-mysql-adapter', platform: :ruby
       gem 'aws-sdk', '~> 2.0'
       gem 'dalli'
+      gem 'delayed_job'
+      gem 'delayed_job_active_record'
       gem 'elasticsearch-transport'
       gem 'excon'
       gem 'hiredis'
@@ -379,6 +385,8 @@ elsif Gem::Version.new('2.2.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'activerecord', '< 5.1.5'
       gem 'aws-sdk'
       gem 'dalli'
+      gem 'delayed_job'
+      gem 'delayed_job_active_record'
       gem 'elasticsearch-transport'
       gem 'excon'
       gem 'grape'
@@ -513,6 +521,8 @@ elsif Gem::Version.new('2.3.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'activerecord', '< 5.1.5'
       gem 'aws-sdk'
       gem 'dalli'
+      gem 'delayed_job'
+      gem 'delayed_job_active_record'
       gem 'elasticsearch-transport'
       gem 'excon'
       gem 'grape'
@@ -541,6 +551,8 @@ elsif Gem::Version.new('2.4.0') <= Gem::Version.new(RUBY_VERSION)
       gem 'activerecord', '< 5.1.5'
       gem 'aws-sdk'
       gem 'dalli'
+      gem 'delayed_job'
+      gem 'delayed_job_active_record'
       gem 'elasticsearch-transport'
       gem 'excon'
       gem 'grape'

data/CHANGELOG.md

@@ -4,15 +4,27 @@
 
 ## [Unreleased (beta)]
 
-## [0.13.2] - 2018-08-07
+## [0.14.0.beta1] - 2018-07-24
 
-Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.13.2
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.14.0.beta1
 
-Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.13.1...v0.13.2
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.13.1...v0.14.0.beta1
+
+### Changed
+
+- Resque to flush traces when Job finishes instead of using SyncWriter (#474)
+- ActiveRecord to allow configuring multiple databases (#451)
+- Integrations configuration settings (#450, #452, #451)
 
 ### Fixed
 
- - Context propagation for distributed traces when context is full (#502)
+- Ruby warnings during tests (#499)
+- Tests failing intermittently on Ruby 1.9.3 (#497)
+
+### Added
+
+- DelayedJob integration (#393 #444)
+- Version information to integrations (#483)
 
 ## [0.13.1] - 2018-07-17
 
@@ -390,7 +402,6 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 
 [Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.13.0...master
 [Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.13.0...0.14-dev
-[0.13.2]: https://github.com/DataDog/dd-trace-rb/compare/v0.13.1...v0.13.2
 [0.13.1]: https://github.com/DataDog/dd-trace-rb/compare/v0.13.0...v0.13.1
 [0.13.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.12.1...v0.13.0
 [0.13.0.beta1]: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0...v0.13.0.beta1

data/Rakefile

@@ -39,9 +39,14 @@ namespace :spec do
     t.pattern = 'spec/ddtrace/contrib/rails/**/*disable_env*_spec.rb'
   end
 
+  RSpec::Core::RakeTask.new(:contrib) do |t|
+    t.pattern = 'spec/**/contrib/{configurable,integration,patchable,patcher,registerable,configuration/*}_spec.rb'
+  end
+
   [
     :active_model_serializers,
     :active_record,
+    :delayed_job,
     :active_support,
     :aws,
     :dalli,
@@ -144,7 +149,7 @@ end
 
 if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.1.0')
   RuboCop::RakeTask.new(:rubocop) do |t|
-    t.options << ['-D']
+    t.options << ['-D', '--force-exclusion']
     t.patterns = ['lib/**/*.rb', 'test/**/*.rb', 'spec/**/*.rb', 'Gemfile', 'Rakefile']
   end
 end
@@ -208,6 +213,7 @@ task :ci do
     # Main library
     sh 'bundle exec rake test:main'
     sh 'bundle exec rake spec:main'
+    sh 'bundle exec rake spec:contrib'
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
@@ -221,6 +227,7 @@ task :ci do
       # Contrib specs
       sh 'bundle exec appraisal contrib-old rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib-old rake spec:active_record'
+      sh 'bundle exec appraisal contrib-old rake spec:delayed_job'
       sh 'bundle exec appraisal contrib-old rake spec:active_support'
       sh 'bundle exec appraisal contrib-old rake spec:dalli'
       sh 'bundle exec appraisal contrib-old rake spec:elasticsearch'
@@ -250,6 +257,7 @@ task :ci do
     # Main library
     sh 'bundle exec rake test:main'
     sh 'bundle exec rake spec:main'
+    sh 'bundle exec rake spec:contrib'
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
@@ -263,6 +271,7 @@ task :ci do
       # Contrib specs
       sh 'bundle exec appraisal contrib-old rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib-old rake spec:active_record'
+      sh 'bundle exec appraisal contrib-old rake spec:delayed_job'
       sh 'bundle exec appraisal contrib-old rake spec:active_support'
       sh 'bundle exec appraisal contrib-old rake spec:dalli'
       sh 'bundle exec appraisal contrib-old rake spec:elasticsearch'
@@ -295,6 +304,7 @@ task :ci do
     # Main library
     sh 'bundle exec rake test:main'
     sh 'bundle exec rake spec:main'
+    sh 'bundle exec rake spec:contrib'
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
@@ -308,6 +318,7 @@ task :ci do
       # Contrib specs
       sh 'bundle exec appraisal contrib-old rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib-old rake spec:active_record'
+      sh 'bundle exec appraisal contrib-old rake spec:delayed_job'
       sh 'bundle exec appraisal contrib-old rake spec:active_support'
       sh 'bundle exec appraisal contrib-old rake spec:dalli'
       sh 'bundle exec appraisal contrib-old rake spec:elasticsearch'
@@ -346,6 +357,7 @@ task :ci do
     # Main library
     sh 'bundle exec rake test:main'
     sh 'bundle exec rake spec:main'
+    sh 'bundle exec rake spec:contrib'
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
@@ -359,6 +371,7 @@ task :ci do
       # Contrib specs
       sh 'bundle exec appraisal contrib rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib rake spec:active_record'
+      sh 'bundle exec appraisal contrib rake spec:delayed_job'
       sh 'bundle exec appraisal contrib rake spec:active_support'
       sh 'bundle exec appraisal contrib rake spec:dalli'
       sh 'bundle exec appraisal contrib rake spec:elasticsearch'
@@ -408,6 +421,7 @@ task :ci do
     # Main library
     sh 'bundle exec rake test:main'
     sh 'bundle exec rake spec:main'
+    sh 'bundle exec rake spec:contrib'
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
@@ -421,6 +435,7 @@ task :ci do
       # Contrib specs
       sh 'bundle exec appraisal contrib rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib rake spec:active_record'
+      sh 'bundle exec appraisal contrib rake spec:delayed_job'
       sh 'bundle exec appraisal contrib rake spec:active_support'
       sh 'bundle exec appraisal contrib rake spec:dalli'
       sh 'bundle exec appraisal contrib rake spec:excon'
@@ -469,6 +484,7 @@ task :ci do
     # Main library
     sh 'bundle exec rake test:main'
     sh 'bundle exec rake spec:main'
+    sh 'bundle exec rake spec:contrib'
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
@@ -482,6 +498,7 @@ task :ci do
       # Contrib specs
       sh 'bundle exec appraisal contrib rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib rake spec:active_record'
+      sh 'bundle exec appraisal contrib rake spec:delayed_job'
       sh 'bundle exec appraisal contrib rake spec:active_support'
       sh 'bundle exec appraisal contrib rake spec:dalli'
       sh 'bundle exec appraisal contrib rake spec:elasticsearch'

data/docs/GettingStarted.md

@@ -26,6 +26,7 @@ For descriptions of terminology used in APM, take a look at the [official docume
      - [Active Record](#active-record)
      - [AWS](#aws)
      - [Dalli](#dalli)
+     - [DelayedJob](#delayedjob)
      - [Elastic Search](#elastic-search)
      - [Excon](#excon)
      - [Faraday](#faraday)
@@ -163,6 +164,7 @@ And `options` is an optional `Hash` that accepts the following parameters:
 | ``child_of``    | `Datadog::Span` / `Datadog::Context` | Parent for this span. If not provided, will automatically become current active span. | `nil` |
 | ``start_time``  | `Integer` | When the span actually starts. Useful when tracing events that have already happened. | `Time.now.utc` |
 | ``tags``        | `Hash` | Extra tags which should be added to the span. | `{}` |
+| ``on_error``    | `Proc` | Handler invoked when a block is provided to trace, and it raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
 
 It's highly recommended you set both `service` and `resource` at a minimum. Spans without a `service` or `resource` as `nil` will be discarded by the Datadog agent.
 
@@ -258,6 +260,7 @@ For a list of available integrations, and their configuration options, please re
 | Active Record  | `active_record` | `>= 3.2, < 5.2`        | *[Link](#active-record)*  | *[Link](https://github.com/rails/rails/tree/master/activerecord)*              |
 | AWS            | `aws`           | `>= 2.0`               | *[Link](#aws)*            | *[Link](https://github.com/aws/aws-sdk-ruby)*                                  |
 | Dalli          | `dalli`         | `>= 2.7`               | *[Link](#dalli)*          | *[Link](https://github.com/petergoldstein/dalli)*                              |
+| DelayedJob     | `delayed_job`   | `>= 4.1`               | *[Link](#delayedjob)*     | *[Link](https://github.com/collectiveidea/delayed_job)*                        |
 | Elastic Search | `elasticsearch` | `>= 6.0`               | *[Link](#elastic-search)* | *[Link](https://github.com/elastic/elasticsearch-ruby)*                        |
 | Excon          | `excon`         | `>= 0.62`              | *[Link](#excon)*          | *[Link](https://github.com/excon/excon)*                                       |
 | Faraday        | `faraday`       | `>= 0.14`              | *[Link](#faraday)*        | *[Link](https://github.com/lostisland/faraday)*                                |
@@ -306,6 +309,44 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | ``service_name`` | Service name used for database portion of `active_record` instrumentation. | Name of database adapter (e.g. `mysql2`) |
 | ``orm_service_name`` | Service name used for the Ruby ORM portion of `active_record` instrumentation. Overrides service name for ORM spans if explicitly set, which otherwise inherit their service from their parent.  | ``active_record`` |
 
+**Configuring trace settings per database**
+
+You can provide the `databases` option to configure trace settings by database connection:
+
+```ruby
+# Provide a `:describes` option with a connection key.
+# Any of the following keys are acceptable, and equivalent to one another.
+# If a block is provided, it yields a Settings object that
+# accepts any of the configuration options listed above.
+
+Datadog.configure do |c|
+  # Symbol matching your database connection in config/database.yml
+  # Only available if you are using Rails with ActiveRecord.
+  c.use :active_record, describes: :secondary_database, service_name: 'secondary-db'
+
+  c.use :active_record, describes: :secondary_database do |second_db|
+    second_db.service_name = 'secondary-db'
+  end
+
+  # Connection string with the following connection settings:
+  # Adapter, user, host, port, database
+  c.use :active_record, describes: 'mysql2://root@127.0.0.1:3306/mysql', service_name: 'secondary-db'
+
+  # Hash with following connection settings
+  # Adapter, user, host, port, database
+  c.use :active_record, describes: {
+      adapter:  'mysql2',
+      host:     '127.0.0.1',
+      port:     '3306',
+      database: 'mysql',
+      username: 'root'
+    },
+    service_name: 'secondary-db'
+end
+```
+
+If ActiveRecord traces an event that uses a connection described within `databases`, it will use the trace settings assigned to that connection. If the connection does not match any in the `databases` option, it will use settings defined by `c.use :active_record` instead.
+
 ### AWS
 
 The AWS integration will trace every interaction (e.g. API calls) with AWS services (S3, ElastiCache etc.).
@@ -792,6 +833,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 resource for the trace. | `false` |
 | ``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/`` |
 | ``tracer`` | A ``Datadog::Tracer`` instance used to instrument the application. Usually you don't need to set that. | ``Datadog.tracer`` |
+| ``databases`` | Hash of tracer settings to use for each database connection. See [ActiveRecord](#activerecord) for more details. | ``{}`` |
 
 ### Rake
 
@@ -988,6 +1030,27 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | --- | --- | --- |
 | ``service_name`` | Service name used for `sidekiq` instrumentation | sidekiq |
 
+### DelayedJob
+
+The DelayedJob integration uses lifecycle hooks to trace the job executions.
+
+You can enable it through `Datadog.configure`:
+
+```ruby
+require 'ddtrace'
+
+Datadog.configure do |c|
+  c.use :delayed_job, options
+end
+```
+
+Where `options` is an optional `Hash` that accepts the following parameters:
+
+| Key | Description | Default |
+| --- | --- | --- |
+| ``service_name`` | Service name used for `DelayedJob` instrumentation | delayed_job |
+| ``tracer`` | A ``Datadog::Tracer`` instance used to instrument the application. Usually you don't need to set that. | ``Datadog.tracer`` |
+
 ### Sinatra
 
 The Sinatra integration traces requests and template rendering.

data/lib/ddtrace.rb

@@ -44,10 +44,11 @@ module Datadog
 end
 
 require 'ddtrace/contrib/base'
+require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/rack/patcher'
 require 'ddtrace/contrib/rails/patcher'
 require 'ddtrace/contrib/active_model_serializers/patcher'
-require 'ddtrace/contrib/active_record/patcher'
+require 'ddtrace/contrib/active_record/integration'
 require 'ddtrace/contrib/sequel/patcher'
 require 'ddtrace/contrib/elasticsearch/patcher'
 require 'ddtrace/contrib/faraday/patcher'
@@ -62,6 +63,7 @@ require 'ddtrace/contrib/mongodb/patcher'
 require 'ddtrace/contrib/dalli/patcher'
 require 'ddtrace/contrib/rake/patcher'
 require 'ddtrace/contrib/resque/patcher'
+require 'ddtrace/contrib/delayed_job/patcher'
 require 'ddtrace/contrib/racecar/patcher'
 require 'ddtrace/contrib/sidekiq/patcher'
 require 'ddtrace/contrib/excon/patcher'

data/lib/ddtrace/configuration.rb

@@ -12,16 +12,28 @@ module Datadog
       @wrapped_registry = {}
     end
 
-    def [](integration_name)
-      @wrapped_registry[integration_name] ||= Proxy.new(fetch_integration(integration_name))
+    def [](integration_name, configuration_name = :default)
+      integration = fetch_integration(integration_name)
+
+      if integration.class <= Datadog::Contrib::Integration
+        integration.configuration(configuration_name)
+      else
+        @wrapped_registry[integration_name] ||= Proxy.new(integration)
+      end
     end
 
-    def use(integration_name, options = {})
+    def use(integration_name, options = {}, &block)
       integration = fetch_integration(integration_name)
-      settings = Proxy.new(integration)
 
-      integration.sorted_options.each do |name|
-        settings[name] = options.fetch(name, settings[name])
+      if integration.class <= Datadog::Contrib::Integration
+        configuration_name = options[:describes] || :default
+        filtered_options = options.reject { |k, _v| k == :describes }
+        integration.configure(configuration_name, filtered_options, &block)
+      else
+        settings = Proxy.new(integration)
+        integration.sorted_options.each do |name|
+          settings[name] = options.fetch(name, settings[name])
+        end
       end
 
       integration.patch if integration.respond_to?(:patch)

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

@@ -0,0 +1,46 @@
+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.
+        class Resolver < Contrib::Configuration::Resolver
+          def initialize(configurations = nil)
+            @configurations = configurations
+          end
+
+          def configurations
+            @configurations || ::ActiveRecord::Base.configurations
+          end
+
+          def connection_resolver
+            @resolver ||= begin
+              if defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+                ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
+              else
+                ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
+              end
+            end
+          end
+
+          def resolve(spec)
+            return :default if spec == :default
+            normalize(connection_resolver.resolve(spec).symbolize_keys)
+          end
+
+          def normalize(hash)
+            {
+              adapter:  hash[:adapter],
+              host:     hash[:host],
+              port:     hash[:port],
+              database: hash[:database],
+              username: hash[:username]
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/active_record/utils'
+
+module Datadog
+  module Contrib
+    module ActiveRecord
+      module Configuration
+        # Unique settings for ActiveRecord
+        class Settings < Contrib::Configuration::Settings
+          option :orm_service_name
+          option :service_name, depends_on: [:tracer] do |value|
+            (value || Utils.adapter_name).tap do |service_name|
+              tracer.set_service_info(service_name, 'active_record', Ext::AppTypes::DB)
+            end
+          end
+
+          option :tracer, default: Datadog.tracer do |value|
+            value.tap do
+              Events.subscriptions.each do |subscription|
+                subscription.tracer = value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end