ddtrace 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32267c0f9a646b5c68fec68446808b0338aee9fe
-  data.tar.gz: fe7fb33d51a89cc592aa83c6b52c0b5347d35d68
+  metadata.gz: 7416eda04ff6e9686b7409bc04a2208bf6b30a7f
+  data.tar.gz: 7293c060f6b3bf6d2c53eaadffcedac89faa20f0
 SHA512:
-  metadata.gz: 477f468fb2959ad9d5e48485ec3688d8c2368ce11784903ae76c820748b1772df99f50b25818647320ae4cad7dc7811847616c551092daa18a0fdc9fae883320
-  data.tar.gz: 777c16f17819d7d32f2c4d8544761690344ddac5473bd5ac0b2af45d6428d80c4db7bbbd7129a85780d1bb6fbb6cc60d9abe402dc60d8030fdaf2796643bc18f
+  metadata.gz: b6e80a1f921566158b2a6bb8efdfa79725c7a50876069ae74c1f1677eb4e424cdbf8c16d72eadad832ca9e25fd434f2dc17cfd23f5f19145bd09e1bbdbb97547
+  data.tar.gz: ed535d01f21d1aa1095feed91259809a74c35651ccda8821fd9b7dba8548f445ea1e93fa1e0c98aaf7b9ce0fee903cd36c4837e319d1220cdd40e4dbdeb7cc50

data/Rakefile

@@ -5,6 +5,7 @@ require 'rake/testtask'
 require 'appraisal'
 require 'yard'
 
+# rubocop:disable Metrics/BlockLength
 namespace :test do
   task all: [:main,
              :rails, :railsredis, :railssidekiq, :railsactivejob,
@@ -25,7 +26,8 @@ namespace :test do
     t.test_files = FileList['test/contrib/rails/**/*_test.rb'].reject do |path|
       path.include?('redis') ||
         path.include?('sidekiq') ||
-        path.include?('active_job')
+        path.include?('active_job') ||
+        path.include?('disable_env')
     end
   end
 
@@ -44,6 +46,11 @@ namespace :test do
     t.test_files = FileList['test/contrib/rails/**/*active_job*_test.rb']
   end
 
+  Rake::TestTask.new(:railsdisableenv) do |t|
+    t.libs << %w[test lib]
+    t.test_files = FileList['test/contrib/rails/**/*disable_env*_test.rb']
+  end
+
   [:elasticsearch, :http, :redis, :sinatra, :sidekiq, :rack, :grape].each do |contrib|
     Rake::TestTask.new(contrib) do |t|
       t.libs << %w[test lib]
@@ -142,12 +149,15 @@ task :ci do
     sh 'rvm $SIDEKIQ_OLD_VERSIONS --verbose do appraisal contrib-old rake test:sidekiq'
   when 2
     sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails30-postgres rake test:rails'
+    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails30-postgres rake test:railsdisableenv'
     sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-mysql2 rake test:rails'
     sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-postgres rake test:rails'
     sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-postgres-redis rake test:railsredis'
+    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-postgres rake test:railsdisableenv'
     sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-mysql2 rake test:rails'
     sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres rake test:rails'
     sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres-redis rake test:railsredis'
+    sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres rake test:railsdisableenv'
     sh 'rvm $RAILS3_SIDEKIQ_VERSIONS --verbose do appraisal rails30-postgres-sidekiq rake test:railssidekiq'
     sh 'rvm $RAILS3_SIDEKIQ_VERSIONS --verbose do appraisal rails32-postgres-sidekiq rake test:railssidekiq'
     sh 'rvm $RAILS4_SIDEKIQ_VERSIONS --verbose do appraisal rails4-postgres-sidekiq rake test:railssidekiq'
@@ -157,6 +167,7 @@ task :ci do
     sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-redis rake test:railsredis'
     sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-sidekiq rake test:railssidekiq'
     sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-sidekiq rake test:railsactivejob'
+    sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres rake test:railsdisableenv'
   else
     puts 'Too many workers than parallel tasks'
   end

data/docs/GettingStarted.md

@@ -106,6 +106,21 @@ Available settings are:
 * ``env``: set the environment. Rails users may set it to ``Rails.env`` to use their application settings.
 * ``tags``: set global tags that should be applied to all spans. Defaults to an empty hash
 
+#### Disabling Rails auto-instrumentation
+
+If you wish to disable all Rails auto-instrumentation, you need to set the env var ``DISABLE_DATADOG_RAILS``.
+
+Eg, within Ruby:
+
+    ENV['DISABLE_DATADOG_RAILS'] = 1 # this must be done before ddtrace is included at all
+    require 'ddtrace'
+
+Or, shell syntax, before launching Rails:
+
+```
+export DISABLE_DATADOG_RAILS=1
+```
+
 ### Sinatra
 
 The Sinatra integration traces requests and template rendering. The integration is based on the
@@ -177,6 +192,12 @@ See [distributed tracing](#Distributed_Tracing) for details.
 To modify the default middleware configuration, you can use middleware options as follows:
 
     # config.ru example
+    Datadog.tracer.configure(
+      enabled: true,
+      hostname: localhost,
+      port: 8126
+    )
+
     use Datadog::Contrib::Rack::TraceMiddleware, default_service: 'rack-stack'
 
     app = proc do |env|

data/lib/ddtrace.rb

@@ -27,40 +27,46 @@ end
 
 # Datadog auto instrumentation for frameworks
 if defined?(Rails::VERSION)
-  if Rails::VERSION::MAJOR.to_i >= 3
-    require 'ddtrace/contrib/rails/framework'
+  if !ENV['DISABLE_DATADOG_RAILS']
+    if Rails::VERSION::MAJOR.to_i >= 3
+      require 'ddtrace/contrib/rails/framework'
+      require 'ddtrace/contrib/rails/middlewares'
 
-    module Datadog
-      # Railtie class initializes
-      class Railtie < Rails::Railtie
-        # auto instrument Rails and third party components after
-        # the framework initialization
-        options = {}
-        config.after_initialize do |app|
-          Datadog::Contrib::Rails::Framework.configure(config: app.config)
-          Datadog::Contrib::Rails::Framework.auto_instrument()
-          Datadog::Contrib::Rails::Framework.auto_instrument_redis()
-          Datadog::Contrib::Rails::Framework.auto_instrument_grape()
+      module Datadog
+        # Railtie class initializes
+        class Railtie < Rails::Railtie
+          config.app_middleware.use(Datadog::Contrib::Rails::ExceptionMiddleware)
 
-          # override Rack Middleware configurations with Rails
-          options.update(::Rails.configuration.datadog_trace)
-        end
+          # auto instrument Rails and third party components after
+          # the framework initialization
+          options = {}
+          config.after_initialize do |app|
+            Datadog::Contrib::Rails::Framework.configure(config: app.config)
+            Datadog::Contrib::Rails::Framework.auto_instrument()
+            Datadog::Contrib::Rails::Framework.auto_instrument_redis()
+            Datadog::Contrib::Rails::Framework.auto_instrument_grape()
+
+            # override Rack Middleware configurations with Rails
+            options.update(::Rails.configuration.datadog_trace)
+          end
 
-        # Configure datadog settings before building the middleware stack.
-        # This is required because the middleware stack is frozen after
-        # the initialization and so it's too late to add our tracing
-        # functionalities.
-        initializer :datadog_config, before: :build_middleware_stack do |app|
-          app.config.middleware.insert_before(
-            0, Datadog::Contrib::Rack::TraceMiddleware, options
-          )
+          # Configure datadog settings before building the middleware stack.
+          # This is required because the middleware stack is frozen after
+          # the initialization and so it's too late to add our tracing
+          # functionalities.
+          initializer :datadog_config, before: :build_middleware_stack do |app|
+            app.config.middleware.insert_before(
+              0, Datadog::Contrib::Rack::TraceMiddleware, options
+            )
+          end
         end
       end
+    else
+      Datadog::Tracer.log.warn 'Detected a Rails version < 3.x.'\
+                               'This version is not supported yet and the'\
+                               'auto-instrumentation for core components will be disabled.'
     end
   else
-    logger = Logger.new(STDOUT)
-    logger.warn 'Detected a Rails version < 3.x.'\
-        'This version is not supported yet and the'\
-        'auto-instrumentation for core components will be disabled.'
+    Datadog::Tracer.log.info 'Skipping Rails auto-instrumentation, DISABLE_DATADOG_RAILS is set.'
   end
 end

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

@@ -87,6 +87,7 @@ module Datadog
 
           # call the rest of the stack
           status, headers, response = @app.call(env)
+
         # rubocop:disable Lint/RescueException
         # Here we really want to catch *any* exception, not only StandardError,
         # as we really have no clue of what is in the block,
@@ -96,7 +97,7 @@ module Datadog
         rescue Exception => e
           # catch exceptions that may be raised in the middleware chain
           # Note: if a middleware catches an Exception without re raising,
-          # the Exception cannot be recorded here
+          # the Exception cannot be recorded here.
           request_span.set_error(e)
           raise e
         ensure
@@ -128,10 +129,6 @@ module Datadog
           # unless it has been already set by the underlying framework
           if status.to_s.start_with?('5') && request_span.status.zero?
             request_span.status = 1
-            # in any case we don't touch the stacktrace if it has been set
-            if request_span.get_tag(Datadog::Ext::Errors::STACK).nil?
-              request_span.set_tag(Datadog::Ext::Errors::STACK, caller().join("\n"))
-            end
           end
 
           request_span.finish()

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

@@ -4,7 +4,7 @@ require 'ddtrace/ext/errors'
 module Datadog
   module Contrib
     module Rails
-      # TODO[manu]: write docs
+      # Code used to create and handle 'rails.action_controller' spans.
       module ActionController
         KEY = 'datadog_actioncontroller'.freeze
 
@@ -33,7 +33,6 @@ module Datadog
           Datadog::Tracer.log.error(e.message)
         end
 
-        # rubocop:disable Metrics/MethodLength
         def self.process_action(_name, start, finish, _id, payload)
           return unless Thread.current[KEY]
           Thread.current[KEY] = false
@@ -58,10 +57,7 @@ module Datadog
               # [christian] in some cases :status is not defined,
               # rather than firing an error, simply acknowledge we don't know it.
               status = payload.fetch(:status, '?').to_s
-              if status.starts_with?('5')
-                span.status = 1
-                span.set_tag(Datadog::Ext::Errors::STACK, caller().join("\n"))
-              end
+              span.status = 1 if status.starts_with?('5')
             else
               error = payload[:exception]
               if defined?(::ActionDispatch::ExceptionWrapper)
@@ -74,7 +70,6 @@ module Datadog
                 span.status = 1
                 span.set_tag(Datadog::Ext::Errors::TYPE, error[0])
                 span.set_tag(Datadog::Ext::Errors::MSG, error[1])
-                span.set_tag(Datadog::Ext::Errors::STACK, caller().join("\n"))
               end
             end
           ensure

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

@@ -3,7 +3,7 @@ require 'ddtrace/contrib/rails/utils'
 module Datadog
   module Contrib
     module Rails
-      # TODO[manu]: write docs
+      # Code used to create and handle 'rails.render_template' and 'rails.render_partial' spans.
       module ActionView
         def self.instrument
           # patch Rails core components

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

@@ -5,7 +5,7 @@ require 'ddtrace/contrib/rails/utils'
 module Datadog
   module Contrib
     module Rails
-      # TODO[manu]: write docs
+      # Code used to create and handle 'mysql.query', 'postgres.query', ... spans.
       module ActiveRecord
         def self.instrument
           # ActiveRecord is instrumented only if it's available

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

@@ -4,7 +4,7 @@ require 'ddtrace/ext/cache'
 module Datadog
   module Contrib
     module Rails
-      # TODO[manu]: write docs
+      # Code used to create and handle 'rails.cache' spans.
       module ActiveSupport
         def self.instrument
           # patch Rails core components

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

@@ -12,7 +12,7 @@ require 'ddtrace/contrib/rails/active_support'
 require 'ddtrace/contrib/rails/utils'
 
 # Rails < 3.1
-unless defined?(ActiveRecord::Base.connection_config)
+if defined?(::ActiveRecord) && !defined?(::ActiveRecord::Base.connection_config)
   ActiveRecord::Base.class_eval do
     class << self
       def connection_config
@@ -24,9 +24,11 @@ end
 
 module Datadog
   module Contrib
-    # TODO[manu]: write docs
+    # Instrument Rails.
     module Rails
-      # TODO[manu]: write docs
+      # Rails framework code, used to essentially:
+      # - handle configuration entries which are specific to Datadog tracing
+      # - instrument parts of the framework when needed
       module Framework
         # default configurations for the Rails integration; by default
         # the Datadog.tracer is enabled, while the Rails auto instrumentation

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

@@ -0,0 +1,32 @@
+require 'ddtrace/ext/http'
+
+module Datadog
+  module Contrib
+    # Rails module includes middlewares that are required for Rails to be properly instrumented.
+    module Rails
+      # This is only here to catch errors, the Rack module does something very similar, however,
+      # since it's not in the same place in the stack, when the Rack middleware is called,
+      # error is already swallowed and handled by Rails so we miss the call stack, for instance.
+      class ExceptionMiddleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          @app.call(env)
+        # rubocop:disable Lint/RescueException
+        # Here we really want to catch *any* exception, not only StandardError,
+        # as we really have no clue of what is in the block,
+        # and it is user code which should be executed no matter what.
+        # It's not a problem since we re-raise it afterwards so for example a
+        # SignalException::Interrupt would still bubble up.
+        rescue Exception => e
+          tracer = ::Rails.configuration.datadog_trace.fetch(:tracer)
+          span = tracer.active_span()
+          span.set_error(e) unless span.nil?
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/transport.rb

@@ -2,6 +2,7 @@ require 'thread'
 require 'net/http'
 
 require 'ddtrace/encoding'
+require 'ddtrace/version'
 
 module Datadog
   # Transport class that handles the spans delivery to the
@@ -16,6 +17,7 @@ module Datadog
 
     # header containing the number of traces in a payload
     TRACE_COUNT_HEADER = 'X-Datadog-Trace-Count'.freeze
+    RUBY_INTERPRETER = RUBY_VERSION > '1.9' ? RUBY_ENGINE + '-' + RUBY_PLATFORM : 'ruby-' + RUBY_PLATFORM
 
     def initialize(hostname, port, options = {})
       @hostname = hostname
@@ -28,6 +30,10 @@ module Datadog
       # overwrite the Content-type with the one chosen in the Encoder
       @headers = options.fetch(:headers, {})
       @headers['Content-Type'] = @encoder.content_type
+      @headers['Datadog-Meta-Lang'] = 'ruby'
+      @headers['Datadog-Meta-Lang-Version'] = RUBY_VERSION
+      @headers['Datadog-Meta-Lang-Interpreter'] = RUBY_INTERPRETER
+      @headers['Datadog-Meta-Tracer-Version'] = Datadog::VERSION::STRING
 
       # stats
       @mutex = Mutex.new

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module VERSION
     MAJOR = 0
     MINOR = 8
-    PATCH = 0
+    PATCH = 1
 
     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.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -149,6 +149,7 @@ files:
 - lib/ddtrace/contrib/rails/active_support.rb
 - lib/ddtrace/contrib/rails/core_extensions.rb
 - lib/ddtrace/contrib/rails/framework.rb
+- lib/ddtrace/contrib/rails/middlewares.rb
 - lib/ddtrace/contrib/rails/utils.rb
 - lib/ddtrace/contrib/redis/patcher.rb
 - lib/ddtrace/contrib/redis/quantize.rb