ddtrace 0.14.0.beta2 → 0.14.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22136c7de76c04edc8e73f76d84eece381a9a9f8a62a4b1a320978c75038a4c3
-  data.tar.gz: 50bbe8adea037b572e177a0a7813baa74c4c0735f36ad0f4f14f4b9c78c7a35c
+  metadata.gz: 4577cdbdd06aac09ea0083d53eb9770be92e4731477c79b75486b31f020668d7
+  data.tar.gz: 523b5f41156dbef1e860ddb209109af347bfd9af8b9d949edb1ea9638e16a670
 SHA512:
-  metadata.gz: '0358db43f6e2f66ebc77b46b4a8e4e1a2721ba23fc96c5b55c05eea1c05a92f6b14a01fb080133f70d7ae1b806c9ffd9c7feb7b39a90838a63511591b5e2d9c2'
-  data.tar.gz: 96f741fa4c727858d0d82e2f52c058639243c17cda0460fc3e5614571578a4c896d4e11134626a7d8fa41f98e1481e2a3ab6a934acf5390ad716d588c87003ab
+  metadata.gz: 0c389d698936501fd887a41d2e2dbe524abcb44ffd84d81147372914c96040e8964a0888d51731cbfb6538c25f556c2b9d56cea16d6de8591cd99724a3386b61
+  data.tar.gz: 8b0b647de877011b9fe16e1db64f8e42c98807e40f64dd629ee6be360ef9da9992446d44e7ff5f8a87e1f6fb0f8f903d4bb5bbd4dc5770ea2f26e898765d7be0

data/Appraisals

@@ -80,6 +80,7 @@ elsif Gem::Version.new('1.9.3') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rack-test', '0.7.0'
       gem 'rake', '< 12.3'
       gem 'redis', '< 4.0'
+      gem 'rest-client', '< 2.0'
       gem 'resque', '< 2.0'
       gem 'sequel', '~> 4.0', '< 4.37'
       gem 'sidekiq', '4.0.0'
@@ -162,6 +163,7 @@ elsif Gem::Version.new('2.0.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rack-test', '0.7.0'
       gem 'rake', '< 12.3'
       gem 'redis', '< 4.0'
+      gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel', '~> 4.0', '< 4.37'
       gem 'sidekiq', '4.0.0'
@@ -264,6 +266,7 @@ elsif Gem::Version.new('2.1.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rack-test', '0.7.0'
       gem 'rake', '< 12.3'
       gem 'redis', '< 4.0'
+      gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel', '~> 4.0', '< 4.37'
       gem 'sidekiq', '4.0.0'
@@ -400,6 +403,7 @@ elsif Gem::Version.new('2.2.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rack-test'
       gem 'rake', '>= 12.3'
       gem 'redis', '< 4.0'
+      gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel'
       gem 'sidekiq'
@@ -536,6 +540,7 @@ elsif Gem::Version.new('2.3.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rack-test'
       gem 'rake', '>= 12.3'
       gem 'redis', '< 4.0'
+      gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel'
       gem 'sidekiq'
@@ -566,6 +571,7 @@ elsif Gem::Version.new('2.4.0') <= Gem::Version.new(RUBY_VERSION)
       gem 'rack-test'
       gem 'rake', '>= 12.3'
       gem 'redis', '< 4.0'
+      gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel'
       gem 'sidekiq'

data/CHANGELOG.md

@@ -4,6 +4,21 @@
 
 ## [Unreleased (beta)]
 
+## [0.14.0.rc1] - 2018-08-08
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.14.0.rc1
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.14.0.beta2...v0.14.0.rc1
+
+### Added
+
+- RestClient integration (#422, #460)
+- Tracer#active_root_span helper (#503)
+
+### Fixed
+
+- Context propagation for distributed traces when context is full (#502)
+
 ## [0.14.0.beta2] - 2018-07-25
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.14.0.beta2
@@ -36,6 +51,16 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.13.1...v0.14.0.beta1
 - DelayedJob integration (#393 #444)
 - Version information to integrations (#483)
 
+## [0.13.2] - 2018-08-07
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.13.2
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.13.1...v0.13.2
+
+### Fixed
+
+ - Context propagation for distributed traces when context is full (#502)
+
 ## [0.13.1] - 2018-07-17
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.13.1
@@ -410,8 +435,12 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.3.1
 
 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
+[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.13.2...master
+[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.14.rc1...0.14-dev
+[0.14.0.rc1]: https://github.com/DataDog/dd-trace-rb/compare/v0.14.0.beta2...v0.14.rc1
+[0.14.0.beta2]: https://github.com/DataDog/dd-trace-rb/compare/v0.14.0.beta1...v0.14.beta2
+[0.14.0.beta1]: https://github.com/DataDog/dd-trace-rb/compare/v0.13.0...v0.14.beta1
+[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/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 # Add debugger for pry that's compatible with 0.10.4
 gem 'pry-nav', git: 'https://github.com/nixme/pry-nav.git', branch: 'master'
+# This file was generated by Appraisal

data/Rakefile

@@ -67,7 +67,8 @@ namespace :spec do
     :sequel,
     :sidekiq,
     :sinatra,
-    :sucker_punch
+    :sucker_punch,
+    :rest_client
   ].each do |contrib|
     RSpec::Core::RakeTask.new(contrib) do |t|
       t.pattern = "spec/ddtrace/contrib/#{contrib}/**/*_spec.rb"
@@ -240,6 +241,7 @@ task :ci do
       sh 'bundle exec appraisal contrib-old rake spec:redis'
       sh 'bundle exec appraisal contrib-old rake spec:resque'
       sh 'bundle exec appraisal contrib-old rake spec:sequel'
+      sh 'bundle exec appraisal contrib-old rake spec:rest_client'
       # Rails minitests
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
       sh 'bundle exec appraisal rails30-postgres rake test:railsdisableenv'
@@ -284,6 +286,7 @@ task :ci do
       sh 'bundle exec appraisal contrib-old rake spec:redis'
       sh 'bundle exec appraisal contrib-old rake spec:resque'
       sh 'bundle exec appraisal contrib-old rake spec:sequel'
+      sh 'bundle exec appraisal contrib-old rake spec:rest_client'
       # Rails minitests
       sh 'bundle exec appraisal contrib-old rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
@@ -331,6 +334,7 @@ task :ci do
       sh 'bundle exec appraisal contrib-old rake spec:redis'
       sh 'bundle exec appraisal contrib-old rake spec:resque'
       sh 'bundle exec appraisal contrib-old rake spec:sequel'
+      sh 'bundle exec appraisal contrib-old rake spec:rest_client'
       # Rails minitests
       sh 'bundle exec appraisal contrib-old rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
@@ -387,6 +391,7 @@ task :ci do
       sh 'bundle exec appraisal contrib rake spec:redis'
       sh 'bundle exec appraisal contrib rake spec:resque'
       sh 'bundle exec appraisal contrib rake spec:sequel'
+      sh 'bundle exec appraisal contrib rake spec:rest_client'
       # Rails minitests
       sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
@@ -451,6 +456,7 @@ task :ci do
       sh 'bundle exec appraisal contrib rake spec:redis'
       sh 'bundle exec appraisal contrib rake spec:resque'
       sh 'bundle exec appraisal contrib rake spec:sequel'
+      sh 'bundle exec appraisal contrib rake spec:rest_client'
       # Rails minitests
       sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
@@ -514,6 +520,7 @@ task :ci do
       sh 'bundle exec appraisal contrib rake spec:redis'
       sh 'bundle exec appraisal contrib rake spec:resque'
       sh 'bundle exec appraisal contrib rake spec:sequel'
+      sh 'bundle exec appraisal contrib rake spec:rest_client'
       # Rails minitests
       sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec rake benchmark'

data/docs/GettingStarted.md

@@ -41,6 +41,7 @@ For descriptions of terminology used in APM, take a look at the [official docume
      - [Rails](#rails)
      - [Rake](#rake)
      - [Redis](#redis)
+     - [Rest Client](#restclient)
      - [Resque](#resque)
      - [Sequel](#sequel)
      - [Sidekiq](#sidekiq)
@@ -229,7 +230,7 @@ def finish(name, id, payload)
   end
 end
 ```
-#####Enriching traces from nested methods
+##### Enriching traces from nested methods
 
 You can tag additional information to current active span from any method. Note however that if the method is called and there is no span currently active `active_span` will be nil.
 
@@ -240,6 +241,15 @@ current_span = Datadog.tracer.active_span
 current_span.set_tag('my_tag', 'my_value') unless current_span.nil?
 ```
 
+You can also get the root span of the current active trace using the `active_root_span` method. This method will return `nil` if there is no active trace.
+
+```ruby
+# e.g. adding tag to active root span
+
+current_root_span = Datadog.tracer.active_root_span
+current_root_span.set_tag('my_tag', 'my_value') unless current_root_span.nil?
+```
+
 ## Integration instrumentation
 
 Many popular libraries and frameworks are supported out-of-the-box, which can be auto-instrumented. Although they are not activated automatically, they can be easily activated and configured by using the `Datadog.configure` API:
@@ -275,6 +285,7 @@ For a list of available integrations, and their configuration options, please re
 | Rails          | `rails`         | `>= 3.2, < 5.2`        | *[Link](#rails)*          | *[Link](https://github.com/rails/rails)*                                       |
 | Rake           | `rake`          | `>= 12.0`              | *[Link](#rake)*           | *[Link](https://github.com/ruby/rake)*                                         |
 | Redis          | `redis`         | `>= 3.2, < 4.0`        | *[Link](#redis)*          | *[Link](https://github.com/redis/redis-rb)*                                    |
+| Rest Client    | `rest-client`   | `>= 1.8`               | *[Link](#restclient)*     | *[Link](https://github.com/rest-client/rest-client)*                           |
 | Resque         | `resque`        | `>= 1.0, < 2.0`        | *[Link](#resque)*         | *[Link](https://github.com/resque/resque)*                                     |
 | Sequel         | `sequel`        | `>= 3.41`              | *[Link](#sequel)*         | *[Link](https://github.com/jeremyevans/sequel)*                                |
 | Sidekiq        | `sidekiq`       | `>= 4.0`               | *[Link](#sidekiq)*        | *[Link](https://github.com/mperham/sidekiq)*                                   |
@@ -936,6 +947,27 @@ customer_cache.get(...) # traced call will belong to `customer-cache` service
 invoice_cache.get(...) # traced call will belong to `invoice-cache` service
 ```
 
+### Rest Client
+
+The `rest-client` integration is available through the `ddtrace` middleware:
+
+```ruby
+require 'rest_client'
+require 'ddtrace'
+
+Datadog.configure do |c|
+  c.use :rest_client, service_name: 'rest_client' # global service name
+end
+```
+
+Where `options` is an optional `Hash` that accepts the following parameters:
+
+| Key | Description | Default |
+| --- | --- | --- |
+| `service_name` | Service name for Rest Client instrumentation. | `'rest_client'` |
+| `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `false` |
+| `tracer` | A `Datadog::Tracer` instance used to instrument the application. Usually you don't need to set that. | `Datadog.tracer` |
+
 ### Resque
 
 The Resque integration uses Resque hooks that wraps the ``perform`` method.
@@ -1326,6 +1358,7 @@ For more details on how to activate distributed tracing for integrations, see th
 
 - [Excon](#excon)
 - [Faraday](#faraday)
+- [Rest Client](#restclient)
 - [Net/HTTP](#nethttp)
 - [Rack](#rack)
 - [Rails](#rails)

data/lib/ddtrace.rb

@@ -59,6 +59,7 @@ require 'ddtrace/contrib/redis/patcher'
 require 'ddtrace/contrib/http/patcher'
 require 'ddtrace/contrib/aws/patcher'
 require 'ddtrace/contrib/sucker_punch/patcher'
+require 'ddtrace/contrib/rest_client/integration'
 require 'ddtrace/contrib/mongodb/patcher'
 require 'ddtrace/contrib/dalli/patcher'
 require 'ddtrace/contrib/rake/patcher'

data/lib/ddtrace/context.rb

@@ -63,6 +63,12 @@ module Datadog
       end
     end
 
+    def current_root_span
+      @mutex.synchronize do
+        return @current_root_span
+      end
+    end
+
     # Add a span to the context trace list, keeping it as the last active span.
     def add_span(span)
       @mutex.synchronize do
@@ -77,6 +83,7 @@ module Datadog
           return
         end
         set_current_span(span)
+        @current_root_span = span if @trace.empty?
         @trace << span
         span.context = self
       end
@@ -158,6 +165,7 @@ module Datadog
       @sampling_priority = options.fetch(:sampling_priority, nil)
       @finished_spans = 0
       @current_span = nil
+      @current_root_span = nil
     end
 
     def set_current_span(span)

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

@@ -0,0 +1,22 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/active_record/utils'
+
+module Datadog
+  module Contrib
+    module RestClient
+      module Configuration
+        # Unique settings for RestClient
+        class Settings < Contrib::Configuration::Settings
+          NAME = 'rest_client'.freeze
+
+          option :service_name, default: NAME, depends_on: [:tracer] do |value|
+            get_option(:tracer).set_service_info(value, NAME, Ext::AppTypes::DB)
+            value
+          end
+
+          option :distributed_tracing, default: false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/rest_client/configuration/settings'
+require 'ddtrace/contrib/rest_client/patcher'
+
+module Datadog
+  module Contrib
+    module RestClient
+      # Description of RestClient integration
+      class Integration
+        include Contrib::Integration
+        register_as :rest_client
+
+        def self.compatible?
+          RUBY_VERSION >= '1.9.3' && defined?(::RestClient::Request)
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Datadog
+  module Contrib
+    module RestClient
+      # RestClient integration
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:rest_client)
+        end
+
+        def patch
+          do_once(:rest_client) do
+            require 'ddtrace/ext/app_types'
+            require 'ddtrace/contrib/rest_client/request_patch'
+
+            ::RestClient::Request.send(:include, RequestPatch)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -0,0 +1,90 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/propagation/http_propagator'
+
+module Datadog
+  module Contrib
+    module RestClient
+      # RestClient RequestPatch
+      module RequestPatch
+        REQUEST_TRACE_NAME = 'rest_client.request'.freeze
+
+        def self.included(base)
+          if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+            base.class_eval do
+              alias_method :execute_without_datadog, :execute
+              remove_method :execute
+              include InstanceMethods
+            end
+          else
+            base.send(:prepend, InstanceMethods)
+          end
+        end
+
+        # Compatibility shim for Rubies not supporting `.prepend`
+        module InstanceMethodsCompatibility
+          def execute(&block)
+            execute_without_datadog(&block)
+          end
+        end
+
+        # InstanceMethods - implementing instrumentation
+        module InstanceMethods
+          include InstanceMethodsCompatibility unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0')
+
+          def execute(&block)
+            uri = URI.parse(url)
+
+            return super(&block) unless datadog_configuration[:tracer].enabled
+
+            datadog_trace_request(uri) do |span|
+              if datadog_configuration[:distributed_tracing]
+                Datadog::HTTPPropagator.inject!(span.context, processed_headers)
+              end
+
+              super(&block)
+            end
+          end
+
+          def datadog_tag_request(uri, span)
+            span.resource = method.to_s.upcase
+            span.set_tag(Ext::HTTP::URL, uri.path)
+            span.set_tag(Ext::HTTP::METHOD, method.to_s.upcase)
+            span.set_tag(Ext::NET::TARGET_HOST, uri.host)
+            span.set_tag(Ext::NET::TARGET_PORT, uri.port)
+          end
+
+          def datadog_trace_request(uri)
+            span = datadog_configuration[:tracer].trace(REQUEST_TRACE_NAME,
+                                                        service: datadog_configuration[:service_name],
+                                                        span_type: Datadog::Ext::AppTypes::WEB)
+
+            datadog_tag_request(uri, span)
+
+            response = yield(span)
+
+            span.set_tag(Ext::HTTP::STATUS_CODE, response.code)
+            response
+          rescue ::RestClient::ExceptionWithResponse => e
+            span.set_error(e) if Ext::HTTP::ERROR_RANGE.cover?(e.http_code)
+            span.set_tag(Ext::HTTP::STATUS_CODE, e.http_code)
+
+            raise e
+            # rubocop:disable Lint/RescueException
+          rescue Exception => e
+            # rubocop:enable Lint/RescueException
+            span.set_error(e)
+
+            raise e
+          ensure
+            span.finish
+          end
+
+          def datadog_configuration
+            Datadog.configuration[:rest_client]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/propagation/http_propagator.rb

@@ -9,6 +9,12 @@ module Datadog
 
     # inject! popolates the env with span ID, trace ID and sampling priority
     def self.inject!(context, env)
+      # Prevent propagation from being attempted if context provided is nil.
+      if context.nil?
+        Datadog::Tracer.log.debug('Cannot inject context into env to propagate over HTTP: context is nil.'.freeze)
+        return
+      end
+
       env[HTTP_HEADER_TRACE_ID] = context.trace_id.to_s
       env[HTTP_HEADER_PARENT_ID] = context.span_id.to_s
       env[HTTP_HEADER_SAMPLING_PRIORITY] = context.sampling_priority.to_s

data/lib/ddtrace/span.rb

@@ -25,7 +25,6 @@ module Datadog
                   :tracer, :context
 
     attr_reader :parent
-
     # Create a new span linked to the given tracer. Call the \Tracer method <tt>start_span()</tt>
     # and then <tt>finish()</tt> once the tracer operation is over.
     #

data/lib/ddtrace/tracer.rb

@@ -346,6 +346,11 @@ module Datadog
       call_context.current_span
     end
 
+    # Return the current active root span or +nil+.
+    def active_root_span
+      call_context.current_root_span
+    end
+
     # Send the trace to the writer to enqueue the spans list in the agent
     # sending queue.
     def write(trace)

data/lib/ddtrace/version.rb

@@ -3,7 +3,7 @@ module Datadog
     MAJOR = 0
     MINOR = 14
     PATCH = 0
-    PRE = 'beta2'.freeze
+    PRE = 'rc1'.freeze
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.14.0.beta2
+  version: 0.14.0.rc1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -361,6 +361,10 @@ files:
 - lib/ddtrace/contrib/registerable.rb
 - lib/ddtrace/contrib/resque/patcher.rb
 - lib/ddtrace/contrib/resque/resque_job.rb
+- lib/ddtrace/contrib/rest_client/configuration/settings.rb
+- lib/ddtrace/contrib/rest_client/integration.rb
+- lib/ddtrace/contrib/rest_client/patcher.rb
+- lib/ddtrace/contrib/rest_client/request_patch.rb
 - lib/ddtrace/contrib/sequel/configuration/settings.rb
 - lib/ddtrace/contrib/sequel/database.rb
 - lib/ddtrace/contrib/sequel/dataset.rb