ls-trace 0.1.2 → 0.2.0

data/lib/ddtrace/contrib/action_cable/events/transmit.rb

@@ -0,0 +1,50 @@
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/action_cable/event'
+
+module Datadog
+  module Contrib
+    module ActionCable
+      module Events
+        # Defines instrumentation for 'transmit.action_cable' event.
+        #
+        # A 'transmit' event sends a message to a single client subscribed to a channel.
+        module Transmit
+          include ActionCable::Event
+
+          EVENT_NAME = 'transmit.action_cable'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_TRANSMIT
+          end
+
+          def span_type
+            # ActionCable transmits data over WebSockets
+            Datadog::Ext::AppTypes::WEB
+          end
+
+          def process(span, _event, _id, payload)
+            channel_class = payload[:channel_class]
+
+            span.service = configuration[:service_name]
+            span.resource = channel_class
+            span.span_type = span_type
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            span.set_tag(Ext::TAG_CHANNEL_CLASS, channel_class)
+            span.set_tag(Ext::TAG_TRANSMIT_VIA, payload[:via])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_cable/ext.rb

@@ -0,0 +1,26 @@
+module Datadog
+  module Contrib
+    module ActionCable
+      # ActionCable integration constants
+      module Ext
+        APP = 'action_cable'.freeze
+        ENV_ENABLED = 'DD_TRACE_ACTION_CABLE_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_CABLE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTION_CABLE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'action_cable'.freeze
+        SPAN_ACTION = 'action_cable.action'.freeze
+        SPAN_BROADCAST = 'action_cable.broadcast'.freeze
+        SPAN_ON_OPEN = 'action_cable.on_open'.freeze
+        SPAN_TRANSMIT = 'action_cable.transmit'.freeze
+        TAG_ACTION = 'action_cable.action'.freeze
+        TAG_BROADCAST_CODER = 'action_cable.broadcast.coder'.freeze
+        TAG_CHANNEL = 'action_cable.channel'.freeze
+        TAG_CHANNEL_CLASS = 'action_cable.channel_class'.freeze
+        TAG_CONNECTION = 'action_cable.connection'.freeze
+        TAG_TRANSMIT_VIA = 'action_cable.transmit.via'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_cable/instrumentation.rb

@@ -0,0 +1,31 @@
+module Datadog
+  module Contrib
+    module ActionCable
+      module Instrumentation
+        # When a new WebSocket is open, we receive a Rack request resource name "GET -1".
+        # This module overrides the current Rack resource name to provide a meaningful name.
+        module ActionCableConnection
+          def on_open
+            Datadog.tracer.trace(Ext::SPAN_ON_OPEN) do |span|
+              begin
+                span.resource = "#{self.class}#on_open"
+                span.span_type = Datadog::Ext::AppTypes::WEB
+
+                span.set_tag(Ext::TAG_ACTION, 'on_open')
+                span.set_tag(Ext::TAG_CONNECTION, self.class.to_s)
+
+                # Set the resource name of the Rack request span
+                rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
+                rack_request_span.resource = span.resource if rack_request_span
+              rescue StandardError => e
+                Datadog.logger.error("Error preparing span for ActionCable::Connection: #{e}")
+              end
+
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_cable/integration.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/action_cable/configuration/settings'
+require 'ddtrace/contrib/action_cable/patcher'
+
+module Datadog
+  module Contrib
+    module ActionCable
+      # Description of ActionCable integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('5.0.0')
+
+        register_as :action_cable, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['actioncable'] && Gem.loaded_specs['actioncable'].version
+        end
+
+        def self.loaded?
+          !defined?(::ActionCable).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/action_cable/ext'
+require 'ddtrace/contrib/action_cable/events'
+require 'ddtrace/contrib/action_cable/instrumentation'
+
+module Datadog
+  module Contrib
+    module ActionCable
+      # Patcher enables patching of 'action_cable' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          Events.subscribe!
+          ::ActionCable::Connection::Base.prepend(Instrumentation::ActionCableConnection)
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@ require 'ddtrace/ext/http'
 require 'ddtrace/contrib/action_pack/ext'
 require 'ddtrace/contrib/action_pack/utils'
 require 'ddtrace/contrib/rack/middlewares'
+require 'ddtrace/contrib/analytics'
 
 module Datadog
   module Contrib
@@ -23,7 +24,7 @@ module Datadog
             tracing_context = payload.fetch(:tracing_context)
             tracing_context[:dd_request_span] = span
           rescue StandardError => e
-            Datadog::Tracer.log.error(e.message)
+            Datadog.logger.error(e.message)
           end
 
           def finish_processing(payload)
@@ -48,6 +49,9 @@ module Datadog
               # Set analytics sample rate
               Utils.set_analytics_sample_rate(span)
 
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
               # Associate with runtime metrics
               Datadog.runtime_metrics.associate_with_span(span)
 
@@ -67,7 +71,7 @@ module Datadog
               span.finish
             end
           rescue StandardError => e
-            Datadog::Tracer.log.error(e.message)
+            Datadog.logger.error(e.message)
           end
 
           def exception_controller?(payload)

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/configuration/settings.rb

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the ActionPack integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], nil) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # ActionPack integration constants
       module Ext
         APP = 'action_pack'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_ACTION_PACK_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_ACTION_PACK_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_ACTION_PACK_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_PACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTION_PACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_PACK_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTION_PACK_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'action_pack'.freeze
         SPAN_ACTION_CONTROLLER = 'rails.action_controller'.freeze
         TAG_ROUTE_ACTION = 'rails.route.action'.freeze

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

@@ -9,18 +9,20 @@ module Datadog
       class Integration
         include Contrib::Integration
 
+        MINIMUM_VERSION = Gem::Version.new('3.0')
+
         register_as :action_pack, auto_patch: false
 
         def self.version
           Gem.loaded_specs['actionpack'] && Gem.loaded_specs['actionpack'].version
         end
 
-        def self.present?
-          super && defined?(::ActionPack)
+        def self.loaded?
+          !defined?(::ActionPack).nil?
         end
 
         def self.compatible?
-          super && version >= Gem::Version.new('3.0')
+          super && version >= MINIMUM_VERSION
         end
 
         def default_configuration

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/configuration/settings.rb

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the ActionView integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           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,45 @@
+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
+
+            if (template_name = Utils.normalize_template_name(payload[:identifier]))
+              span.resource = template_name
+              span.set_tag(Ext::TAG_TEMPLATE_NAME, template_name)
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            record_exception(span, payload)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end