ddtrace 0.11.0.beta2 → 0.11.0

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

@@ -83,24 +83,30 @@ module Datadog
     def patch_partial_renderer(klass)
       klass.class_eval do
         def render_with_datadog(*args, &block)
-          # create a tracing context and start the rendering span
-          @tracing_context = {}
-          Datadog::Contrib::Rails::ActionView.start_render_partial(tracing_context: @tracing_context)
+          # Create a tracing context and start the rendering span
+          tracing_context = {}
+          Datadog::Contrib::Rails::ActionView.start_render_partial(tracing_context: tracing_context)
+          tracing_contexts[current_span_id] = tracing_context
+
           render_without_datadog(*args)
         rescue Exception => e
           # attach the exception to the tracing context if any
-          @tracing_context[:exception] = e
+          tracing_contexts[current_span_id][:exception] = e
           raise e
         ensure
-          # ensure that the template `Span` is finished even during exceptions
-          Datadog::Contrib::Rails::ActionView.finish_render_partial(tracing_context: @tracing_context)
+          # Ensure that the template `Span` is finished even during exceptions
+          # Remove the existing tracing context (to avoid leaks)
+          tracing_contexts.delete(current_span_id)
+
+          # Then finish the span associated with the context
+          Datadog::Contrib::Rails::ActionView.finish_render_partial(tracing_context: tracing_context)
         end
 
         def render_partial_with_datadog(*args)
           begin
             # update the tracing context with computed values before the rendering
             template_name = Datadog::Contrib::Rails::Utils.normalize_template_name(@template.try('identifier'))
-            @tracing_context[:template_name] = template_name
+            tracing_contexts[current_span_id][:template_name] = template_name
           rescue StandardError => e
             Datadog::Tracer.log.debug(e.message)
           end
@@ -109,6 +115,17 @@ module Datadog
           render_partial_without_datadog(*args)
         end
 
+        # Table of tracing contexts, one per partial/span, keyed by span_id
+        # because there will be multiple concurrent contexts, depending on how
+        # many partials are nested within one another.
+        def tracing_contexts
+          @tracing_contexts ||= {}
+        end
+
+        def current_span_id
+          Datadog.configuration[:rails][:tracer].call_context.current_span.span_id
+        end
+
         # method aliasing to patch the class
         alias_method :render_without_datadog, :render
         alias_method :render, :render_with_datadog

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

@@ -63,10 +63,12 @@ module Datadog
         end
 
         def self.connection_config
-          if defined?(::ActiveRecord::Base.connection_config)
-            ::ActiveRecord::Base.connection_config
-          else
-            ::ActiveRecord::Base.connection_pool.spec.config
+          @connection_config ||= begin
+            if defined?(::ActiveRecord::Base.connection_config)
+              ::ActiveRecord::Base.connection_config
+            else
+              ::ActiveRecord::Base.connection_pool.spec.config
+            end
           end
         end
 

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

@@ -12,6 +12,7 @@ module Datadog
         include Base
         register_as :redis, auto_patch: true
         option :service_name, default: SERVICE
+        option :tracer, default: Datadog.tracer
 
         @patched = false
 
@@ -19,8 +20,7 @@ module Datadog
 
         # patch applies our patch if needed
         def patch
-          if !@patched && (defined?(::Redis::VERSION) && \
-                           Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('3.0.0'))
+          if !@patched && compatible?
             begin
               # do not require these by default, but only when actually patching
               require 'ddtrace/monkey'
@@ -28,8 +28,7 @@ module Datadog
               require 'ddtrace/contrib/redis/tags'
               require 'ddtrace/contrib/redis/quantize'
 
-              patch_redis()
-              patch_redis_client()
+              patch_redis_client
               @patched = true
               RailsCachePatcher.reload_cache_store if Datadog.registry[:rails].patched?
             rescue StandardError => e
@@ -39,18 +38,8 @@ module Datadog
           @patched
         end
 
-        def patch_redis
-          ::Redis.module_eval do
-            def datadog_pin=(pin)
-              # Forward the pin to client, which actually traces calls.
-              Datadog::Pin.onto(client, pin)
-            end
-
-            def datadog_pin
-              # Get the pin from client, which actually traces calls.
-              Datadog::Pin.get_from(client)
-            end
-          end
+        def compatible?
+          defined?(::Redis::VERSION) && Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('3.0.0')
         end
 
         # rubocop:disable Metrics/MethodLength
@@ -64,11 +53,9 @@ module Datadog
 
             def initialize(*args)
               service = Datadog.configuration[:redis][:service_name]
-              pin = Datadog::Pin.new(service, app: 'redis', app_type: Datadog::Ext::AppTypes::DB)
+              tracer = Datadog.configuration[:redis][:tracer]
+              pin = Datadog::Pin.new(service, app: 'redis', app_type: Datadog::Ext::AppTypes::DB, tracer: tracer)
               pin.onto(self)
-              if pin.tracer && pin.service
-                pin.tracer.set_service_info(pin.service, pin.app, pin.app_type)
-              end
               initialize_without_datadog(*args)
             end
 

data/lib/ddtrace/contrib/redis/quantize.rb

@@ -5,16 +5,16 @@ module Datadog
       module Quantize
         PLACEHOLDER = '?'.freeze
         TOO_LONG_MARK = '...'.freeze
-        VALUE_MAX_LEN = 100
-        CMD_MAX_LEN = 1000
+        VALUE_MAX_LEN = 50
+        CMD_MAX_LEN = 500
 
         module_function
 
         def format_arg(arg)
           str = arg.is_a?(Symbol) ? arg.to_s.upcase : arg.to_s
-          str = str.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+          str = Utils.utf8_encode(str, binary: true, placeholder: PLACEHOLDER)
           Utils.truncate(str, VALUE_MAX_LEN, TOO_LONG_MARK)
-        rescue StandardError => e
+        rescue => e
           Datadog::Tracer.log.debug("non formattable Redis arg #{str}: #{e}")
           PLACEHOLDER
         end

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

@@ -40,9 +40,9 @@ module Datadog
           private
 
           def add_pin
-            Pin.new(get_option(:service_name), app_type: Ext::AppTypes::WORKER).tap do |pin|
-              pin.onto(::Resque)
-            end
+            Pin
+              .new(get_option(:service_name), app: 'resque', app_type: Ext::AppTypes::WORKER)
+              .onto(::Resque)
           end
         end
       end

data/lib/ddtrace/contrib/resque/resque_job.rb

@@ -25,7 +25,6 @@ end
 Resque.before_first_fork do
   pin = Datadog::Pin.get_from(Resque)
   next unless pin && pin.tracer
-  pin.tracer.set_service_info(pin.service, 'resque', Datadog::Ext::AppTypes::WORKER)
 
   # Create SyncWriter instance before forking
   sync_writer = Datadog::SyncWriter.new(transport: pin.tracer.writer.transport)

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

@@ -0,0 +1,33 @@
+module Datadog
+  module Contrib
+    module Sidekiq
+      # Provides instrumentation support for Sidekiq
+      module Patcher
+        include Base
+        VERSION_REQUIRED = Gem::Version.new('4.0.0')
+        register_as :sidekiq
+        option :service_name, default: 'sidekiq'
+        option :tracer, default: Datadog.tracer
+
+        module_function
+
+        def patch
+          return unless compatible?
+
+          require_relative 'tracer'
+
+          ::Sidekiq.configure_server do |config|
+            config.server_middleware do |chain|
+              chain.add(Sidekiq::Tracer)
+            end
+          end
+        end
+
+        def compatible?
+          defined?(::Sidekiq) &&
+            Gem::Version.new(::Sidekiq::VERSION) >= VERSION_REQUIRED
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sidekiq/tracer.rb

@@ -2,25 +2,11 @@ require 'sidekiq/api'
 
 require 'ddtrace/ext/app_types'
 
-sidekiq_vs = Gem::Version.new(Sidekiq::VERSION)
-sidekiq_min_vs = Gem::Version.new('4.0.0')
-if sidekiq_vs < sidekiq_min_vs
-  raise "sidekiq version #{sidekiq_vs} is not supported yet " \
-        + "(supporting versions >=#{sidekiq_min_vs})"
-end
-
-Datadog::Tracer.log.debug("Activating instrumentation for Sidekiq '#{sidekiq_vs}'")
-
 module Datadog
   module Contrib
     module Sidekiq
-      # Middleware is a Sidekiq server-side middleware which traces executed jobs
+      # Tracer is a Sidekiq server-side middleware which traces executed jobs
       class Tracer
-        include Base
-        register_as :sidekiq
-        option :service_name, default: 'sidekiq'
-        option :tracer, default: Datadog.tracer
-
         def initialize(options = {})
           config = Datadog.configuration[:sidekiq].merge(options)
           @tracer = config[:tracer]

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

@@ -24,7 +24,6 @@ module Datadog
           add_pin!
           ExceptionHandler.patch!
           Instrumentation.patch!
-          Datadog.tracer.set_service_info(get_option(:service_name), 'sucker_punch', Ext::AppTypes::WORKER)
 
           @patched = true
         rescue => e
@@ -43,7 +42,7 @@ module Datadog
         end
 
         def add_pin!
-          Pin.new(get_option(:service_name), app_type: Ext::AppTypes::WORKER).tap do |pin|
+          Pin.new(get_option(:service_name), app: 'sucker_punch', app_type: Ext::AppTypes::WORKER).tap do |pin|
             pin.onto(::SuckerPunch)
           end
         end

data/lib/ddtrace/error.rb

@@ -16,19 +16,9 @@ module Datadog
 
     def initialize(type = nil, message = nil, backtrace = nil)
       backtrace = Array(backtrace).join("\n")
-      @type = sanitize(type)
-      @message = sanitize(message)
-      @backtrace = sanitize(backtrace)
-    end
-
-    private
-
-    def sanitize(value)
-      value = value.to_s
-
-      return value if value.encoding == ::Encoding::UTF_8
-
-      value.encode(::Encoding::UTF_8)
+      @type = Utils.utf8_encode(type)
+      @message = Utils.utf8_encode(message)
+      @backtrace = Utils.utf8_encode(backtrace)
     end
 
     BlankError = Error.new

data/lib/ddtrace/ext/cache.rb

@@ -2,6 +2,7 @@ module Datadog
   module Ext
     module CACHE
       TYPE = 'cache'.freeze
+      MAX_KEY_SIZE = 300
     end
   end
 end

data/lib/ddtrace/ext/priority.rb

@@ -0,0 +1,16 @@
+module Datadog
+  module Ext
+    # Priority is a hint given to the backend so that it knows which traces to reject or kept.
+    # In a distributed context, it should be set before any context propagation (fork, RPC calls) to be effective.
+    module Priority
+      # Use this to explicitely inform the backend that a trace should be rejected and not stored.
+      USER_REJECT = -1
+      # Used by the builtin sampler to inform the backend that a trace should be rejected and not stored.
+      AUTO_REJECT = 0
+      # Used by the builtin sampler to inform the backend that a trace should be kept and stored.
+      AUTO_KEEP = 1
+      # Use this to explicitely inform the backend that a trace should be kept and stored.
+      USER_KEEP = 2
+    end
+  end
+end

data/lib/ddtrace/monkey.rb

@@ -18,6 +18,7 @@ require 'ddtrace/contrib/mongodb/patcher'
 require 'ddtrace/contrib/dalli/patcher'
 require 'ddtrace/contrib/resque/patcher'
 require 'ddtrace/contrib/racecar/patcher'
+require 'ddtrace/contrib/sidekiq/patcher'
 
 module Datadog
   # Monkey is used for monkey-patching 3rd party libs.

data/lib/ddtrace/pin.rb

@@ -10,7 +10,7 @@ module Datadog
       obj.datadog_pin
     end
 
-    attr_accessor :service
+    attr_accessor :service_name
     attr_accessor :app
     attr_accessor :tags
     attr_accessor :app_type
@@ -18,15 +18,14 @@ module Datadog
     attr_accessor :tracer
     attr_accessor :config
 
-    # [ruby19] named parameters would be more idiomatic here, but would break backward compatibility
-    def initialize(service, options = { app: nil, tags: nil, app_type: nil, tracer: nil, config: nil })
-      @service = service
-      @app = options.fetch(:app, nil)
-      @tags = options.fetch(:tags, nil)
-      @app_type = options.fetch(:app_type, nil)
+    def initialize(service_name, options = {})
+      @app = options[:app]
+      @tags = options[:tags]
+      @app_type = options[:app_type]
       @name = nil # this would rarely be overriden as it's really span-specific
       @tracer = options[:tracer] || Datadog.tracer
-      @config = options.fetch(:config, nil)
+      @config = options[:config]
+      self.service_name = service_name
     end
 
     def enabled?
@@ -55,8 +54,17 @@ module Datadog
       obj.datadog_pin = self
     end
 
+    def service_name=(name)
+      tracer.set_service_info(name, app, app_type) if name && app && app_type
+
+      @service_name = name
+    end
+
+    alias service= service_name=
+    alias service service_name
+
     def to_s
-      "Pin(service:#{@service},app:#{@app},app_type:#{@app_type},name:#{@name})"
+      "Pin(service:#{service},app:#{app},app_type:#{app_type},name:#{name})"
     end
   end
 end

data/lib/ddtrace/sampler.rb

@@ -1,5 +1,7 @@
 require 'forwardable'
 
+require 'ddtrace/ext/priority'
+
 module Datadog
   # \Sampler performs client-side trace sampling.
   class Sampler
@@ -96,10 +98,10 @@ module Datadog
     end
 
     def sample(span)
-      span.context.sampling_priority = 0 if span.context
+      span.context.sampling_priority = Datadog::Ext::Priority::AUTO_REJECT if span.context
       return unless @base_sampler.sample(span)
       return unless @post_sampler.sample(span)
-      span.context.sampling_priority = 1 if span.context
+      span.context.sampling_priority = Datadog::Ext::Priority::AUTO_KEEP if span.context
 
       true
     end

data/lib/ddtrace/utils.rb

@@ -1,6 +1,7 @@
 module Datadog
   # Utils contains low-level utilities, typically to provide pseudo-random trace IDs.
   module Utils
+    STRING_PLACEHOLDER = ''.encode(::Encoding::UTF_8).freeze
     # We use a custom random number generator because we want no interference
     # with the default one. Using the default prng, we could break code that
     # would rely on srand/rand sequences.
@@ -21,6 +22,10 @@ module Datadog
       Process.pid != @pid
     end
 
+    private_class_method :reset!, :was_forked?
+
+    reset!
+
     def self.truncate(value, size, omission = '...')
       string = value.to_s
 
@@ -29,8 +34,22 @@ module Datadog
       string.slice(0, size - omission.size) + omission
     end
 
-    private_class_method :reset!, :was_forked?
-
-    reset!
+    def self.utf8_encode(str, options = {})
+      str = str.to_s
+
+      if options[:binary]
+        # This option is useful for "gracefully" displaying binary data that
+        # often contains text such as marshalled objects
+        str.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+      elsif str.encoding == ::Encoding::UTF_8
+        str
+      else
+        str.encode(::Encoding::UTF_8)
+      end
+    rescue => e
+      Tracer.log.debug("Error encoding string in UTF-8: #{e}")
+
+      options.fetch(:placeholder, STRING_PLACEHOLDER)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta2
+  version: 0.11.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -52,6 +52,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -154,28 +182,28 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.9.2
 description: |
@@ -190,6 +218,7 @@ extra_rdoc_files: []
 files:
 - ".env"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
 - Appraisals
@@ -221,6 +250,7 @@ files:
 - lib/ddtrace/buffer.rb
 - lib/ddtrace/configurable.rb
 - lib/ddtrace/configuration.rb
+- lib/ddtrace/configuration/pin_setup.rb
 - lib/ddtrace/configuration/proxy.rb
 - lib/ddtrace/configuration/resolver.rb
 - lib/ddtrace/context.rb
@@ -261,6 +291,7 @@ files:
 - lib/ddtrace/contrib/redis/tags.rb
 - lib/ddtrace/contrib/resque/patcher.rb
 - lib/ddtrace/contrib/resque/resque_job.rb
+- lib/ddtrace/contrib/sidekiq/patcher.rb
 - lib/ddtrace/contrib/sidekiq/tracer.rb
 - lib/ddtrace/contrib/sinatra/tracer.rb
 - lib/ddtrace/contrib/sucker_punch/exception_handler.rb
@@ -275,6 +306,7 @@ files:
 - lib/ddtrace/ext/http.rb
 - lib/ddtrace/ext/mongo.rb
 - lib/ddtrace/ext/net.rb
+- lib/ddtrace/ext/priority.rb
 - lib/ddtrace/ext/redis.rb
 - lib/ddtrace/ext/sql.rb
 - lib/ddtrace/logger.rb
@@ -313,12 +345,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications