ddtrace 0.29.1 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b29416bf90ae1197fb95cf7f3d505a6a83098156
-  data.tar.gz: 9eabc9df9b505136aa18780d6dfb4d4b48545766
+SHA256:
+  metadata.gz: 4a4700ac8c6e74091fdd23024559ff87298b5c5048c52bf036b894570a79aac5
+  data.tar.gz: a89768fb74be26e2fdd2cf51ae09fe95e35df762b0aa1e742f7a7578ded3540d
 SHA512:
-  metadata.gz: 1f0b882500d0d548a90b1080fae7edbba1c337e9fe9c9749a9ece3eb9840e65d9f622b608c3a451bafe0905aa4560683e81a5008aa3903854974ead88c0c66aa
-  data.tar.gz: b9b5278d663cf8461e6df66626e4b131ec1b723f4eef2eb2b806a34ed7cc55b3a0b3dd7c09789f9bec2b82da22b56a65b97580407f922cb4955cc6369b1f6dd1
+  metadata.gz: 022cd6564c22b95f1edb1e0c565f3ab2c823221e3913da7dcf204c0476eec43885a2087be1986a1895f6ee8ccb0888db476e237d528a4189c60556b28ec465f5
+  data.tar.gz: 8b069db6714abb290e746a22def4a9a874392d1cfd533b267e516a704dd98a59da4ff4ea6e5ba416127975bc162cff33b578e76835501df588ede4124366743e

data/.rubocop.yml

@@ -75,3 +75,7 @@ Style/SymbolArray:
 # expressions.
 Style/GuardClause:
   Enabled: false
+
+# Case equality is not intrinsically problematic.
+Style/CaseEquality:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased]
 
+## [0.30.0] - 2019-12-04
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.30.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.29.1...v0.30.0
+
+### Added
+
+- Additional tracer health metrics (#867)
+- Integration patching instrumentation (#871)
+- Rule-based trace sampling (#854)
+
+### Fixed
+
+- Rails template layout name error (#872) (@djmb)
+
 ## [0.29.1] - 2019-11-26
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.29.1
@@ -981,7 +997,8 @@ 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]: https://github.com/DataDog/dd-trace-rb/compare/v0.29.1...master
+[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v0.30.0...master
+[0.30.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.29.1...v0.30.0
 [0.29.1]: https://github.com/DataDog/dd-trace-rb/compare/v0.29.0...v0.29.1
 [0.29.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.28.0...v0.29.0
 [0.28.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.27.0...v0.28.0

data/lib/ddtrace/context.rb

@@ -1,4 +1,5 @@
 require 'thread'
+require 'ddtrace/diagnostics/health'
 
 module Datadog
   # \Context is used to keep track of a hierarchy of spans for the current
@@ -89,9 +90,17 @@ module Datadog
         # by default has 10000 spans, all of which belong to unfinished parts of a
         # larger trace. This is a catch-all to reduce global memory usage.
         if @max_length > 0 && @trace.length >= @max_length
-          Datadog::Tracer.log.debug("context full, ignoring span #{span.name}")
           # Detach the span from any context, it's being dropped and ignored.
           span.context = nil
+          Datadog::Tracer.log.debug("context full, ignoring span #{span.name}")
+
+          # If overflow has already occurred, don't send this metric.
+          # Prevents metrics spam if buffer repeatedly overflows for the same trace.
+          unless @overflow
+            Diagnostics::Health.metrics.error_context_overflow(1, tags: ["max_length:#{@max_length}"])
+            @overflow = true
+          end
+
           return
         end
         set_current_span(span)
@@ -111,12 +120,18 @@ module Datadog
         # on per-instrumentation code to retrieve handle parent/child relations.
         set_current_span(span.parent)
         return if span.tracer.nil?
-        return unless Datadog::Tracer.debug_logging
-        if span.parent.nil? && !check_finished_spans
-          opened_spans = @trace.length - @finished_spans
-          Datadog::Tracer.log.debug("root span #{span.name} closed but has #{opened_spans} unfinished spans:")
-          @trace.each do |s|
-            Datadog::Tracer.log.debug("unfinished span: #{s}") unless s.finished?
+        if span.parent.nil? && !all_spans_finished?
+          if Datadog::Tracer.debug_logging
+            opened_spans = @trace.length - @finished_spans
+            Datadog::Tracer.log.debug("root span #{span.name} closed but has #{opened_spans} unfinished spans:")
+          end
+
+          @trace.reject(&:finished?).group_by(&:name).each do |unfinished_span_name, unfinished_spans|
+            Datadog::Tracer.log.debug("unfinished span: #{unfinished_spans.first}") if Datadog::Tracer.debug_logging
+            Diagnostics::Health.metrics.error_unfinished_spans(
+              unfinished_spans.length,
+              tags: ["name:#{unfinished_span_name}"]
+            )
           end
         end
       end
@@ -126,7 +141,7 @@ module Datadog
     # is considered finished if all spans in this context are finished.
     def finished?
       @mutex.synchronize do
-        return check_finished_spans
+        return all_spans_finished?
       end
     end
 
@@ -153,7 +168,7 @@ module Datadog
         attach_origin if @origin
 
         # still return sampled attribute, even if context is not finished
-        return nil, sampled unless check_finished_spans()
+        return nil, sampled unless all_spans_finished?
 
         reset
         [trace, sampled]
@@ -180,6 +195,7 @@ module Datadog
       @finished_spans = 0
       @current_span = nil
       @current_root_span = nil
+      @overflow = false
     end
 
     def set_current_span(span)
@@ -195,7 +211,7 @@ module Datadog
 
     # Returns if the trace for the current Context is finished or not.
     # Low-level internal function, not thread-safe.
-    def check_finished_spans
+    def all_spans_finished?
       @finished_spans > 0 && @trace.length == @finished_spans
     end
 

data/lib/ddtrace/contrib/action_pack/action_controller/patcher.rb

@@ -11,24 +11,12 @@ module Datadog
 
           module_function
 
-          def patched?
-            done?(:action_controller)
+          def target_version
+            Integration.version
           end
 
           def patch
-            do_once(:action_controller) do
-              begin
-                patch_action_controller_metal
-              rescue StandardError => e
-                Datadog::Tracer.log.error("Unable to apply ActionController integration: #{e}")
-              end
-            end
-          end
-
-          def patch_action_controller_metal
-            do_once(:patch_action_controller_metal) do
-              ::ActionController::Metal.send(:prepend, ActionController::Instrumentation::Metal)
-            end
+            ::ActionController::Metal.send(:prepend, ActionController::Instrumentation::Metal)
           end
         end
       end

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

@@ -10,18 +10,12 @@ module Datadog
 
         module_function
 
-        def patched?
-          done?(:action_pack)
+        def target_version
+          Integration.version
         end
 
         def patch
-          do_once(:action_pack) do
-            begin
-              ActionController::Patcher.patch
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply ActionPack integration: #{e}")
-            end
-          end
+          ActionController::Patcher.patch
         end
       end
     end

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

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/active_support/notifications/event'
+
+module Datadog
+  module Contrib
+    module ActionView
+      # Defines basic behavior for an ActionView event.
+      module Event
+        def self.included(base)
+          base.send(:include, ActiveSupport::Notifications::Event)
+          base.send(:extend, ClassMethods)
+        end
+
+        # Class methods for ActionView events.
+        module ClassMethods
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:action_view]
+          end
+
+          def record_exception(span, payload)
+            if payload [:exception_object]
+              span.set_error(payload[:exception_object])
+            elsif payload[:exception]
+              # Fallback for ActiveSupport < 5.0
+              span.set_error(payload[:exception])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/action_view/events/render_partial'
+require 'ddtrace/contrib/action_view/events/render_template'
+
+module Datadog
+  module Contrib
+    module ActionView
+      # Defines collection of instrumented ActionView events
+      module Events
+        ALL = [
+          Events::RenderPartial,
+          Events::RenderTemplate
+        ].freeze
+
+        module_function
+
+        def all
+          self::ALL
+        end
+
+        def subscriptions
+          all.collect(&:subscriptions).collect(&:to_a).flatten
+        end
+
+        def subscribe!
+          all.each(&:subscribe!)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_view/events/render_partial.rb

@@ -0,0 +1,40 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/action_view/ext'
+require 'ddtrace/contrib/action_view/event'
+
+module Datadog
+  module Contrib
+    module ActionView
+      module Events
+        # Defines instrumentation for render_partial.action_view event
+        module RenderPartial
+          include ActionView::Event
+
+          EVENT_NAME = 'render_partial.action_view'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_RENDER_PARTIAL
+          end
+
+          def process(span, _event, _id, payload)
+            span.span_type = Datadog::Ext::HTTP::TEMPLATE
+
+            template_name = Utils.normalize_template_name(payload[:identifier])
+            span.set_tag(Ext::TAG_TEMPLATE_NAME, template_name) if template_name
+
+            record_exception(span, payload)
+          rescue StandardError => e
+            Datadog::Tracer.log.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_view/events/render_template.rb

@@ -0,0 +1,43 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/action_view/ext'
+require 'ddtrace/contrib/action_view/event'
+
+module Datadog
+  module Contrib
+    module ActionView
+      module Events
+        # Defines instrumentation for render_template.action_view event
+        module RenderTemplate
+          include ActionView::Event
+
+          EVENT_NAME = 'render_template.action_view'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_RENDER_TEMPLATE
+          end
+
+          def process(span, _event, _id, payload)
+            span.span_type = Datadog::Ext::HTTP::TEMPLATE
+
+            template_name = Utils.normalize_template_name(payload[:identifier])
+            span.set_tag(Ext::TAG_TEMPLATE_NAME, template_name) if template_name
+
+            layout = payload[:layout]
+            span.set_tag(Ext::TAG_LAYOUT, layout) if layout
+
+            record_exception(span, payload)
+          rescue StandardError => e
+            Datadog::Tracer.log.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_view/instrumentation/partial_renderer.rb

@@ -4,7 +4,7 @@ module Datadog
   module Contrib
     module ActionView
       module Instrumentation
-        # Instrumentation for partial rendering
+        # Legacy instrumentation for partial rendering for Rails < 4
         module PartialRenderer
           def render(*args, &block)
             datadog_tracer.trace(
@@ -54,23 +54,15 @@ module Datadog
             self.active_datadog_span = nil
           end
 
-          # Rails < 6 partial rendering
-          module RailsLessThan6
+          # Rails < 4 partial rendering
+          # ActiveSupport events are used instead for Rails >= 4
+          module RailsLessThan4
             include PartialRenderer
 
             def datadog_template(*args)
               @template
             end
           end
-
-          # Rails >= 6 partial rendering
-          module Rails6Plus
-            include PartialRenderer
-
-            def datadog_template(*args)
-              args[1]
-            end
-          end
         end
       end
     end

data/lib/ddtrace/contrib/action_view/instrumentation/template_renderer.rb

@@ -4,9 +4,9 @@ module Datadog
   module Contrib
     module ActionView
       module Instrumentation
-        # Instrumentation for template rendering
+        # Legacy instrumentation for template rendering for Rails < 4
         module TemplateRenderer
-          # Rails < 3.1 template rendering
+          # Legacy Rails < 3.1 template rendering
           module Rails30
             # rubocop:disable Metrics/MethodLength
             def self.prepended(base)
@@ -82,7 +82,7 @@ module Datadog
             end
           end
 
-          # Shared code for Rails >= 3.1 template rendering
+          # Legacy shared code for Rails >= 3.1 template rendering
           module Rails31Plus
             def render(*args, &block)
               datadog_tracer.trace(
@@ -143,23 +143,15 @@ module Datadog
             end
           end
 
-          # Rails >= 3.1 && < 6 template rendering
-          module Rails31To5
+          # Rails >= 3.1, < 4 template rendering
+          # ActiveSupport events are used instead for Rails >= 4
+          module RailsLessThan4
             include Rails31Plus
 
             def datadog_parse_args(template, layout_name, *args)
               [template, layout_name]
             end
           end
-
-          # Rails >= 6 template rendering
-          module Rails6Plus
-            include Rails31Plus
-
-            def datadog_parse_args(view, template, layout_name, *args)
-              [template, layout_name]
-            end
-          end
         end
       end
     end

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

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/action_view/events'
 require 'ddtrace/contrib/action_view/ext'
 require 'ddtrace/contrib/action_view/instrumentation/partial_renderer'
 require 'ddtrace/contrib/action_view/instrumentation/template_renderer'
@@ -14,37 +15,30 @@ module Datadog
 
         module_function
 
-        def patched?
-          done?(:action_view)
+        def target_version
+          Integration.version
         end
 
         def patch
-          do_once(:action_view) do
-            begin
-              patch_renderer
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply Action View integration: #{e} Location: #{e.backtrace.first}")
-            end
-          end
+          patch_renderer
         end
 
         def patch_renderer
-          do_once(:patch_renderer) do
-            if defined?(::ActionView::TemplateRenderer) && defined?(::ActionView::PartialRenderer)
-              if Integration.version < Gem::Version.new('6.0.0')
-                ::ActionView::TemplateRenderer.send(:prepend, Instrumentation::TemplateRenderer::Rails31To5)
-                ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan6)
-              else
-                ::ActionView::TemplateRenderer.send(:prepend, Instrumentation::TemplateRenderer::Rails6Plus)
-                ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::Rails6Plus)
-              end
-            elsif defined?(::ActionView::Rendering) && defined?(::ActionView::Partials::PartialRenderer)
-              # NOTE: Rails < 3.1 compatibility: different classes are used
-              ::ActionView::Rendering.send(:prepend, Instrumentation::TemplateRenderer::Rails30)
-              ::ActionView::Partials::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan6)
-            else
-              Datadog::Tracer.log.debug('Expected Template/Partial classes not found; template rendering disabled')
-            end
+          if target_version >= Gem::Version.new('4.0.0')
+            Events.subscribe!
+          elsif defined?(::ActionView::TemplateRenderer) && defined?(::ActionView::PartialRenderer)
+            # Rails < 4 compatibility:
+            #  Rendering events are not nested in this version, creating
+            #  render_partial spans outside of the parent render_template span.
+            #  We fall back to manual patching instead.
+            ::ActionView::TemplateRenderer.send(:prepend, Instrumentation::TemplateRenderer::RailsLessThan4)
+            ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan4)
+          elsif defined?(::ActionView::Rendering) && defined?(::ActionView::Partials::PartialRenderer)
+            # NOTE: Rails < 3.1 compatibility: different classes are used
+            ::ActionView::Rendering.send(:prepend, Instrumentation::TemplateRenderer::Rails30)
+            ::ActionView::Partials::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan4)
+          else
+            Datadog::Tracer.log.debug('Expected Template/Partial classes not found; template rendering disabled')
           end
         end
       end