ddtrace 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7416eda04ff6e9686b7409bc04a2208bf6b30a7f
-  data.tar.gz: 7293c060f6b3bf6d2c53eaadffcedac89faa20f0
+  metadata.gz: 0fc0133019cee5e3bf12a664792a40ae95f320f7
+  data.tar.gz: 43f7412b5613d8fffc74ddd204bec29c81ac5118
 SHA512:
-  metadata.gz: b6e80a1f921566158b2a6bb8efdfa79725c7a50876069ae74c1f1677eb4e424cdbf8c16d72eadad832ca9e25fd434f2dc17cfd23f5f19145bd09e1bbdbb97547
-  data.tar.gz: ed535d01f21d1aa1095feed91259809a74c35651ccda8821fd9b7dba8548f445ea1e93fa1e0c98aaf7b9ce0fee903cd36c4837e319d1220cdd40e4dbdeb7cc50
+  metadata.gz: 9739cdc4f56336a81e6366b30658fa0f6670c403e7d5d2dd6014a3545f69fb4b3188acd0fb8b499a3a15e211f97ac3d50a81e5f3cc76cb9b8f612eb2778b18ac
+  data.tar.gz: 7b8c1ea6173c53e988548aca2a487357bf0022f23279e94c84097880c9a22866c3d0b9ef83ef34e18abfe85bdc12aa9760e55031b5ccd01020594ec78a2aa1a6

data/Appraisals

@@ -124,7 +124,7 @@ if RUBY_VERSION >= '2.2.2' && RUBY_PLATFORM != 'java'
 else
   appraise 'contrib-old' do
     gem 'elasticsearch-transport'
-    gem 'redis'
+    gem 'redis', '< 4.0.0'
     gem 'hiredis'
     gem 'rack', '1.4.7'
     gem 'rack-test'

data/docs/GettingStarted.md

@@ -112,7 +112,7 @@ If you wish to disable all Rails auto-instrumentation, you need to set the env v
 
 Eg, within Ruby:
 
-    ENV['DISABLE_DATADOG_RAILS'] = 1 # this must be done before ddtrace is included at all
+    ENV['DISABLE_DATADOG_RAILS'] = "1" # this must be done before ddtrace is included at all
     require 'ddtrace'
 
 Or, shell syntax, before launching Rails:
@@ -167,6 +167,8 @@ retrieved at the Rack level.
 To start using the middleware in your generic Rack application, add it to your ``config.ru``:
 
     # config.ru example
+    require 'ddtrace/contrib/rack/middlewares'
+
     use Datadog::Contrib::Rack::TraceMiddleware
 
     app = proc do |env|
@@ -178,6 +180,9 @@ To start using the middleware in your generic Rack application, add it to your `
 Experimental distributed tracing support is available for this library.
 You need to set the ``:distributed_tracing_enabled`` option to true, for example:
 
+    # config.ru example
+    require 'ddtrace/contrib/rack/middlewares'
+
     use Datadog::Contrib::Rack::TraceMiddleware, distributed_tracing_enabled: true
 
     app = proc do |env|
@@ -192,6 +197,8 @@ See [distributed tracing](#Distributed_Tracing) for details.
 To modify the default middleware configuration, you can use middleware options as follows:
 
     # config.ru example
+    require 'ddtrace/contrib/rack/middlewares'
+
     Datadog.tracer.configure(
       enabled: true,
       hostname: localhost,

data/gemfiles/contrib_old.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "elasticsearch-transport"
-gem "redis"
+gem "redis", "< 4.0.0"
 gem "hiredis"
 gem "rack", "1.4.7"
 gem "rack-test"

data/lib/ddtrace.rb

@@ -1,6 +1,7 @@
 require 'ddtrace/monkey'
 require 'ddtrace/pin'
 require 'ddtrace/tracer'
+require 'ddtrace/error'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
 module Datadog

data/lib/ddtrace/contrib/rack/middlewares.rb

@@ -40,7 +40,7 @@ module Datadog
 
         def configure
           # ensure that the configuration is executed only once
-          return if @tracer && @service
+          return clean_context if @tracer && @service
 
           # retrieve the current tracer and service
           @tracer = @options.fetch(:tracer)
@@ -135,6 +135,15 @@ module Datadog
 
           [status, headers, response]
         end
+
+        private
+
+        # TODO: Remove this once we change how context propagation works. This
+        # ensures we clean thread-local variables on each HTTP request avoiding
+        # memory leaks.
+        def clean_context
+          @tracer.provider.context = Datadog::Context.new
+        end
       end
     end
   end

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

@@ -66,11 +66,7 @@ module Datadog
               else
                 status = '500'
               end
-              if status.starts_with?('5')
-                span.status = 1
-                span.set_tag(Datadog::Ext::Errors::TYPE, error[0])
-                span.set_tag(Datadog::Ext::Errors::MSG, error[1])
-              end
+              span.set_error(error) if status.starts_with?('5')
             end
           ensure
             span.start_time = start

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

@@ -74,13 +74,7 @@ module Datadog
             template_name = Datadog::Contrib::Rails::Utils.normalize_template_name(payload.fetch(:identifier))
             span.set_tag('rails.template_name', template_name)
             span.set_tag('rails.layout', payload.fetch(:layout))
-
-            if payload[:exception]
-              error = payload[:exception]
-              span.status = 1
-              span.set_tag(Datadog::Ext::Errors::TYPE, error[0])
-              span.set_tag(Datadog::Ext::Errors::MSG, error[1])
-            end
+            span.set_error(payload[:exception]) if payload[:exception]
           ensure
             span.start_time = start
             span.finish(finish)
@@ -102,13 +96,7 @@ module Datadog
           begin
             template_name = Datadog::Contrib::Rails::Utils.normalize_template_name(payload.fetch(:identifier))
             span.set_tag('rails.template_name', template_name)
-
-            if payload[:exception]
-              error = payload[:exception]
-              span.status = 1
-              span.set_tag(Datadog::Ext::Errors::TYPE, error[0])
-              span.set_tag(Datadog::Ext::Errors::MSG, error[1])
-            end
+            span.set_error(payload[:exception]) if payload[:exception]
           ensure
             span.start_time = start
             span.finish(finish)

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

@@ -97,13 +97,7 @@ module Datadog
             store, = *Array.wrap(::Rails.configuration.cache_store).flatten
             span.set_tag('rails.cache.backend', store)
             span.set_tag('rails.cache.key', payload.fetch(:key))
-
-            if payload[:exception]
-              error = payload[:exception]
-              span.status = 1
-              span.set_tag(Datadog::Ext::Errors::TYPE, error[0])
-              span.set_tag(Datadog::Ext::Errors::MSG, error[1])
-            end
+            span.set_error(payload[:exception]) if payload[:exception]
           ensure
             span.start_time = start
             span.finish(finish)

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

@@ -151,17 +151,7 @@ module Datadog
               span.resource = "#{request.request_method} #{@datadog_route}"
               span.set_tag('sinatra.route.path', @datadog_route)
               span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.status)
-
-              if response.server_error?
-                span.status = 1
-
-                err = env['sinatra.error']
-                if err
-                  span.set_tag(Datadog::Ext::Errors::TYPE, err.class)
-                  span.set_tag(Datadog::Ext::Errors::MSG, err.message)
-                end
-              end
-
+              span.set_error(env['sinatra.error']) if response.server_error?
               span.finish()
             ensure
               @datadog_request_span = nil

data/lib/ddtrace/error.rb

@@ -0,0 +1,37 @@
+# Datadog global namespace
+module Datadog
+  # Error is a value-object responsible for sanitizing/encapsulating error data
+  class Error
+    attr_reader :type, :message, :backtrace
+
+    def self.build_from(value)
+      case value
+      when Error then value
+      when Array then new(*value)
+      when Exception then new(value.class, value.message, value.backtrace)
+      when ContainsMessage then new(value.class, value.message)
+      else BlankError
+      end
+    end
+
+    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)
+    end
+
+    BlankError = Error.new
+    ContainsMessage = ->(v) { v.respond_to?(:message) }
+  end
+end

data/lib/ddtrace/ext/errors.rb

@@ -1,6 +1,7 @@
 module Datadog
   module Ext
     module Errors
+      STATUS = 1
       MSG = 'error.msg'.freeze
       TYPE = 'error.type'.freeze
       STACK = 'error.stack'.freeze

data/lib/ddtrace/provider.rb

@@ -8,6 +8,11 @@ module Datadog
       @context = Datadog::ThreadLocalContext.new
     end
 
+    # Sets the current context.
+    def context=(ctx)
+      @context.local = ctx
+    end
+
     # Return the current context.
     def context
       @context.local

data/lib/ddtrace/span.rb

@@ -92,11 +92,12 @@ module Datadog
 
     # Mark the span with the given error.
     def set_error(e)
-      return if e.nil?
-      @status = 1
-      @meta[Datadog::Ext::Errors::MSG] = e.message if e.respond_to?(:message) && e.message
-      @meta[Datadog::Ext::Errors::TYPE] = e.class.to_s
-      @meta[Datadog::Ext::Errors::STACK] = e.backtrace.join("\n") if e.respond_to?(:backtrace) && e.backtrace
+      e = Error.build_from(e)
+
+      @status = Ext::Errors::STATUS
+      set_tag(Ext::Errors::TYPE, e.type) unless e.type.empty?
+      set_tag(Ext::Errors::MSG, e.message) unless e.message.empty?
+      set_tag(Ext::Errors::STACK, e.backtrace) unless e.backtrace.empty?
     end
 
     # Mark the span finished at the current time and submit it.

data/lib/ddtrace/tracer.rb

@@ -18,7 +18,7 @@ module Datadog
   # of these function calls and sub-requests would be encapsulated within a single trace.
   # rubocop:disable Metrics/ClassLength
   class Tracer
-    attr_reader :writer, :sampler, :services, :tags
+    attr_reader :writer, :sampler, :services, :tags, :provider
     attr_accessor :enabled
     attr_writer :default_service
 

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module VERSION
     MAJOR = 0
     MINOR = 8
-    PATCH = 1
+    PATCH = 2
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -158,6 +158,7 @@ files:
 - lib/ddtrace/contrib/sinatra/tracer.rb
 - lib/ddtrace/distributed.rb
 - lib/ddtrace/encoding.rb
+- lib/ddtrace/error.rb
 - lib/ddtrace/ext/app_types.rb
 - lib/ddtrace/ext/cache.rb
 - lib/ddtrace/ext/distributed.rb
@@ -199,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications