ddtrace 0.12.0 → 0.12.1

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

@@ -6,6 +6,11 @@ module Datadog
   module RailsRendererPatcher
     include Datadog::Patcher
 
+    SPAN_NAME_RENDER_PARTIAL = 'rails.render_partial'.freeze
+    SPAN_NAME_RENDER_TEMPLATE = 'rails.render_template'.freeze
+    TAG_LAYOUT = 'rails.layout'.freeze
+    TAG_TEMPLATE_NAME = 'rails.template_name'.freeze
+
     module_function
 
     def patch_renderer
@@ -24,25 +29,22 @@ module Datadog
     end
 
     def patch_template_renderer(klass)
+      # rubocop:disable Metrics/BlockLength
       do_once(:patch_template_renderer) do
         klass.class_eval do
           def render_with_datadog(*args, &block)
-            # create a tracing context and start the rendering span
-            # NOTE: Rails < 3.1 compatibility: preserve the tracing
-            # context when a partial is rendered
-            @tracing_context ||= {}
-            if @tracing_context.empty?
-              Datadog::Contrib::Rails::ActionView.start_render_template(tracing_context: @tracing_context)
+            # NOTE: This check exists purely for Rails 3.0 compatibility.
+            #       The 'if' part can be removed when support for Rails 3.0 is removed.
+            if active_datadog_span
+              render_without_datadog(*args, &block)
+            else
+              datadog_tracer.trace(
+                Datadog::RailsRendererPatcher::SPAN_NAME_RENDER_TEMPLATE,
+                span_type: Datadog::Ext::HTTP::TEMPLATE
+              ) do |span|
+                with_datadog_span(span) { render_without_datadog(*args, &block) }
+              end
             end
-
-            render_without_datadog(*args, &block)
-          rescue Exception => e
-            # attach the exception to the tracing context if any
-            @tracing_context[:exception] = e
-            raise e
-          ensure
-            # ensure that the template `Span` is finished even during exceptions
-            Datadog::Contrib::Rails::ActionView.finish_render_template(tracing_context: @tracing_context)
           end
 
           def render_template_with_datadog(*args)
@@ -60,8 +62,19 @@ module Datadog
                        else
                          layout_name.try(:[], 'virtual_path')
                        end
-              @tracing_context[:template_name] = template_name
-              @tracing_context[:layout] = layout
+              if template_name
+                active_datadog_span.set_tag(
+                  Datadog::RailsRendererPatcher::TAG_TEMPLATE_NAME,
+                  template_name
+                )
+              end
+
+              if layout
+                active_datadog_span.set_tag(
+                  Datadog::RailsRendererPatcher::TAG_LAYOUT,
+                  layout
+                )
+              end
             rescue StandardError => e
               Datadog::Tracer.log.debug(e.message)
             end
@@ -70,6 +83,21 @@ module Datadog
             render_template_without_datadog(*args)
           end
 
+          private
+
+          attr_accessor :active_datadog_span
+
+          def datadog_tracer
+            Datadog.configuration[:rails][:tracer]
+          end
+
+          def with_datadog_span(span)
+            self.active_datadog_span = span
+            yield
+          ensure
+            self.active_datadog_span = nil
+          end
+
           # method aliasing to patch the class
           alias_method :render_without_datadog, :render
           alias_method :render, :render_with_datadog
@@ -90,30 +118,23 @@ module Datadog
       do_once(:patch_partial_renderer) do
         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)
-            tracing_contexts[current_span_id] = tracing_context
-
-            render_without_datadog(*args)
-          rescue Exception => e
-            # attach the exception to the tracing context if any
-            tracing_contexts[current_span_id][:exception] = e
-            raise e
-          ensure
-            # 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)
+            datadog_tracer.trace(
+              Datadog::RailsRendererPatcher::SPAN_NAME_RENDER_PARTIAL,
+              span_type: Datadog::Ext::HTTP::TEMPLATE
+            ) do |span|
+              with_datadog_span(span) { render_without_datadog(*args) }
+            end
           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_contexts[current_span_id][:template_name] = template_name
+              if template_name
+                active_datadog_span.set_tag(
+                  Datadog::RailsRendererPatcher::TAG_TEMPLATE_NAME,
+                  template_name
+                )
+              end
             rescue StandardError => e
               Datadog::Tracer.log.debug(e.message)
             end
@@ -122,15 +143,19 @@ 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 ||= {}
+          private
+
+          attr_accessor :active_datadog_span
+
+          def datadog_tracer
+            Datadog.configuration[:rails][:tracer]
           end
 
-          def current_span_id
-            Datadog.configuration[:rails][:tracer].call_context.current_span.span_id
+          def with_datadog_span(span)
+            self.active_datadog_span = span
+            yield
+          ensure
+            self.active_datadog_span = nil
           end
 
           # method aliasing to patch the class
@@ -157,79 +182,9 @@ module Datadog
 
     def patch_process_action
       do_once(:patch_process_action) do
-        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0')
-          # Patch Rails controller base class
-          ::ActionController::Metal.send(:prepend, ActionControllerPatch)
-        else
-          # Rewrite module that gets composed into the Rails controller base class
-          ::ActionController::Instrumentation.class_eval do
-            def process_action_with_datadog(*args)
-              # mutable payload with a tracing context that is used in two different
-              # signals; it propagates the request span so that it can be finished
-              # no matter what
-              payload = {
-                controller: self.class,
-                action: action_name,
-                headers: {
-                  # The exception this controller was given in the request,
-                  # which is typical if the controller is configured to handle exceptions.
-                  request_exception: request.headers['action_dispatch.exception']
-                },
-                tracing_context: {}
-              }
-
-              begin
-                # process and catch request exceptions
-                Datadog::Contrib::Rails::ActionController.start_processing(payload)
-                result = process_action_without_datadog(*args)
-                payload[:status] = response.status
-                result
-              rescue Exception => e
-                payload[:exception] = [e.class.name, e.message]
-                payload[:exception_object] = e
-                raise e
-              end
-            ensure
-              Datadog::Contrib::Rails::ActionController.finish_processing(payload)
-            end
+        require 'ddtrace/contrib/rails/action_controller_patch'
 
-            alias_method :process_action_without_datadog, :process_action
-            alias_method :process_action, :process_action_with_datadog
-          end
-        end
-      end
-    end
-
-    # ActionController patch for Ruby 2.0+
-    module ActionControllerPatch
-      def process_action(*args)
-        # mutable payload with a tracing context that is used in two different
-        # signals; it propagates the request span so that it can be finished
-        # no matter what
-        payload = {
-          controller: self.class,
-          action: action_name,
-          headers: {
-            # The exception this controller was given in the request,
-            # which is typical if the controller is configured to handle exceptions.
-            request_exception: request.headers['action_dispatch.exception']
-          },
-          tracing_context: {}
-        }
-
-        begin
-          # process and catch request exceptions
-          Datadog::Contrib::Rails::ActionController.start_processing(payload)
-          result = super(*args)
-          payload[:status] = response.status
-          result
-        rescue Exception => e
-          payload[:exception] = [e.class.name, e.message]
-          payload[:exception_object] = e
-          raise e
-        end
-      ensure
-        Datadog::Contrib::Rails::ActionController.finish_processing(payload)
+        ::ActionController::Metal.send(:include, Datadog::Contrib::Rails::ActionControllerPatch)
       end
     end
   end
@@ -270,6 +225,7 @@ module Datadog
       do_once(:patch_cache_store_read) do
         cache_store_class(:read).class_eval do
           alias_method :read_without_datadog, :read
+
           def read(*args, &block)
             payload = {
               action: 'GET',
@@ -297,6 +253,7 @@ module Datadog
       do_once(:patch_cache_store_fetch) do
         cache_store_class(:fetch).class_eval do
           alias_method :fetch_without_datadog, :fetch
+
           def fetch(*args, &block)
             payload = {
               action: 'GET',
@@ -324,6 +281,7 @@ module Datadog
       do_once(:patch_cache_store_write) do
         cache_store_class(:write).class_eval do
           alias_method :write_without_datadog, :write
+
           def write(*args, &block)
             payload = {
               action: 'SET',
@@ -351,6 +309,7 @@ module Datadog
       do_once(:patch_cache_store_delete) do
         cache_store_class(:delete).class_eval do
           alias_method :delete_without_datadog, :delete
+
           def delete(*args, &block)
             payload = {
               action: 'DELETE',

data/lib/ddtrace/tracer.rb

@@ -23,6 +23,8 @@ module Datadog
     attr_accessor :enabled, :writer
     attr_writer :default_service
 
+    ALLOWED_SPAN_OPTIONS = [:service, :resource, :span_type].freeze
+
     # Global, memoized, lazy initialized instance of a logger that is used within the the Datadog
     # namespace. This logger outputs to +STDOUT+ by default, and is considered thread-safe.
     def self.log
@@ -204,12 +206,13 @@ module Datadog
     # * +tags+: extra tags which should be added to the span.
     def start_span(name, options = {})
       start_time = options.fetch(:start_time, Time.now.utc)
+
       tags = options.fetch(:tags, {})
 
       opts = options.select do |k, _v|
         # Filter options, we want no side effects with unexpected args.
         # Plus, this documents the code (Ruby 2 named args would be better but we're Ruby 1.9 compatible)
-        [:service, :resource, :span_type].include?(k)
+        ALLOWED_SPAN_OPTIONS.include?(k)
       end
 
       ctx, parent = guess_context_and_parent(options[:child_of])

data/lib/ddtrace/utils.rb

@@ -26,12 +26,20 @@ module Datadog
 
     reset!
 
-    def self.truncate(value, size, omission = '...')
+    def self.truncate(value, size, omission = '...'.freeze)
       string = value.to_s
 
       return string if string.size <= size
 
-      string.slice(0, size - omission.size) + omission
+      string = string.slice(0, size - 1)
+
+      if size < omission.size
+        string[0, size] = omission
+      else
+        string[size - omission.size, size] = omission
+      end
+
+      string
     end
 
     def self.utf8_encode(str, options = {})

data/lib/ddtrace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -216,6 +216,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".circleci/images/primary/Dockerfile-1.9.3"
+- ".circleci/images/primary/Dockerfile-2.0.0"
+- ".circleci/images/primary/Dockerfile-2.1.10"
+- ".circleci/images/primary/Dockerfile-2.2.10"
+- ".circleci/images/primary/Dockerfile-2.3.7"
+- ".circleci/images/primary/Dockerfile-2.4.4"
 - ".env"
 - ".gitignore"
 - ".rspec"
@@ -227,7 +234,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- circle.yml
 - ddtrace.gemspec
 - docker-compose.yml
 - docs/GettingStarted.md
@@ -283,6 +289,7 @@ files:
 - lib/ddtrace/contrib/rack/middlewares.rb
 - lib/ddtrace/contrib/rack/patcher.rb
 - lib/ddtrace/contrib/rails/action_controller.rb
+- lib/ddtrace/contrib/rails/action_controller_patch.rb
 - lib/ddtrace/contrib/rails/action_view.rb
 - lib/ddtrace/contrib/rails/active_support.rb
 - lib/ddtrace/contrib/rails/core_extensions.rb
@@ -357,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications

data/circle.yml

@@ -1,69 +0,0 @@
-machine:
-  services:
-    - docker
-  ruby:
-    version:
-      2.2.7
-  environment:
-    LAST_STABLE: 2.4.1
-    EARLY_STABLE: 2.2.7
-    MRI_VERSIONS: 2.4.1,2.3.4,2.2.7
-    MRI_OLD_VERSIONS: 2.1.10,2.0.0,1.9.3
-    SIDEKIQ_OLD_VERSIONS: 2.1.10,2.0.0
-    RAILS3_VERSIONS: 2.3.4,2.2.7,2.1.10,2.0.0,1.9.3
-    RAILS4_VERSIONS: 2.3.4,2.2.7,2.1.10
-    RAILS5_VERSIONS: 2.3.4,2.2.7
-    RAILS3_SIDEKIQ_VERSIONS: 2.1.10,2.0.0
-    RAILS4_SIDEKIQ_VERSIONS: 2.3.4,2.2.7
-    JRUBY_VERSIONS: jruby-9.1.13.0
-    AGENT_BUILD_PATH: "/home/ubuntu/agent"
-    TEST_DATADOG_INTEGRATION: 1
-
-dependencies:
-  cache_directories:
-    # Cache Ruby binaries and gems
-    - "/opt/circleci/.rvm/"
-    - ~/rubies_cache
-  pre:
-    - mkdir -p ~/rubies_cache
-    - rsync -a -v --ignore-existing ~/rubies_cache/ /opt/circleci/.rvm/rubies
-    # we should use an old docker-compose because CircleCI supports
-    # only docker-engine==1.9
-    - pip install docker-compose==1.7.1
-    - docker-compose up -d | cat
-    # installing dev dependencies
-    - |
-      for version in $(echo "$MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS" | tr "," "\n"); do
-        $(rvm list | grep -q $version) || rvm install $version --rubygems 2.6.11
-      done
-    - gem install bundler
-    # remove line below once `msgpack` have a consistent version for jruby
-    - bundle inject msgpack 1.1.0 && sed -i "y/\"/'/" Gemfile
-    - bundle install
-  override:
-    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS --verbose do gem install bundler
-    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS --verbose do bundle install
-    # [FIXME] appraisal does not work with jruby (problem with native ext, eg sqlite3)
-    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS --verbose do bundle exec appraisal install || echo FIX-ME: Ignoring non-zero exit status
-  post:
-    - rsync -a -v --ignore-existing /opt/circleci/.rvm/rubies/ ~/rubies_cache
-
-test:
-  override:
-    - rvm $EARLY_STABLE --verbose do bundle exec rake rubocop
-    # TODO: integration tests should run with the master branch of the agent
-    - bundle exec rake ci:
-        parallel: true
-
-deployment:
-  develop:
-    branch: /(master)|(develop)/
-    # CircleCI is configured to provide VERSION_SUFFIX=$CIRCLE_BUILD_NUM
-    commands:
-      - S3_DIR=trace-dev bundle exec rake release:docs
-      - S3_DIR=trace-dev bundle exec rake release:gem
-      - cp -r ./rubygems/* $CIRCLE_ARTIFACTS
-  public:
-    tag: /v[0-9]+(\.[0-9]+)*/
-    commands:
-      - S3_DIR=trace bundle exec rake release:docs