ls-trace 0.1.2 → 0.2.0

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

@@ -4,8 +4,11 @@ module Datadog
       # HTTP integration constants
       module Ext
         APP = 'net/http'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_HTTP_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_HTTP_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTP_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_HTTP_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'net/http'.freeze
         SPAN_REQUEST = 'http.request'.freeze
       end

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

@@ -5,6 +5,7 @@ require 'ddtrace/ext/http'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/http_annotation_helper'
 
 module Datadog
   module Contrib
@@ -28,31 +29,42 @@ module Datadog
 
         # InstanceMethods - implementing instrumentation
         module InstanceMethods
+          include Datadog::Contrib::HttpAnnotationHelper
+
           def request(req, body = nil, &block) # :yield: +response+
-            pin = datadog_pin
+            host, = host_and_port(req)
+            request_options = datadog_configuration(host)
+            pin = datadog_pin(request_options)
             return super(req, body, &block) unless pin && pin.tracer
 
-            if Datadog::Contrib::HTTP.should_skip_tracing?(req, @address, @port, pin.tracer)
+            if Datadog::Contrib::HTTP.should_skip_tracing?(req, pin.tracer)
               return super(req, body, &block)
             end
 
-            pin.tracer.trace(Ext::SPAN_REQUEST) do |span|
+            pin.tracer.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span|
               begin
-                span.service = pin.service
+                # even though service_name might already be in request_options,
+                # we need to capture the name from the pin since it could be
+                # overridden
+                request_options[:service_name] = pin.service_name
+                span.service = service_name(host, request_options)
                 span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
                 span.resource = req.method
 
                 if pin.tracer.enabled && !Datadog::Contrib::HTTP.should_skip_distributed_tracing?(pin)
                   Datadog::HTTPPropagator.inject!(span.context, req)
                 end
+
+                # Add additional request specific tags to the span.
+                annotate_span_with_request!(span, req, request_options)
               rescue StandardError => e
-                Datadog::Tracer.log.error("error preparing span for http request: #{e}")
+                Datadog.logger.error("error preparing span for http request: #{e}")
               ensure
                 response = super(req, body, &block)
               end
 
-              # Add additional tags to the span.
-              annotate_span!(span, req, response)
+              # Add additional response specific tags to the span.
+              annotate_span_with_response!(span, response)
 
               # Invoke hook, if set.
               unless Contrib::HTTP::Instrumentation.after_request.nil?
@@ -63,21 +75,22 @@ module Datadog
             end
           end
 
-          def annotate_span!(span, request, response)
+          def annotate_span_with_request!(span, request, request_options)
             span.set_tag(Datadog::Ext::HTTP::URL, request.path)
             span.set_tag(Datadog::Ext::HTTP::METHOD, request.method)
-            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
 
-            if request.respond_to?(:uri) && request.uri
-              span.set_tag(Datadog::Ext::NET::TARGET_HOST, request.uri.host)
-              span.set_tag(Datadog::Ext::NET::TARGET_PORT, request.uri.port.to_s)
-            else
-              span.set_tag(Datadog::Ext::NET::TARGET_HOST, @address)
-              span.set_tag(Datadog::Ext::NET::TARGET_PORT, @port.to_s)
-            end
+            host, port = host_and_port(request)
+            span.set_tag(Datadog::Ext::NET::TARGET_HOST, host)
+            span.set_tag(Datadog::Ext::NET::TARGET_PORT, port.to_s)
 
             # Set analytics sample rate
-            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+            set_analytics_sample_rate(span, request_options)
+          end
+
+          def annotate_span_with_response!(span, response)
+            return unless response && response.code
+
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
 
             case response.code.to_i
             when 400...599
@@ -85,27 +98,75 @@ module Datadog
             end
           end
 
-          def datadog_pin
-            @datadog_pin ||= begin
-              service = Datadog.configuration[:http][:service_name]
-              tracer = Datadog.configuration[:http][:tracer]
+          def annotate_span_with_error!(span, error)
+            span.set_error(error)
+          end
+
+          def set_analytics_sample_rate(span, request_options)
+            return unless analytics_enabled?(request_options)
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate(request_options))
+          end
 
-              Datadog::Pin.new(service, app: Ext::APP, app_type: Datadog::Ext::AppTypes::WEB, tracer: tracer)
+          def datadog_pin(config = Datadog.configuration[:http])
+            service = config[:service_name]
+            tracer = config[:tracer]
+
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: -> { config[:tracer] }
+            )
+
+            # this shockingly poor code exists to solve the case where someone
+            # calls datadog_pin on this object before running a request, which
+            # would cause the :default config to be used. If a request is then
+            # run for a hostname that matches a different configuration, we
+            # would use the wrong configs since the pin is memoized.
+            # The solution is to detect if we are using the default config and
+            # apply the new config if necessary, while still allowing custom
+            # values to be supplied
+            if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
+              @datadog_pin.service = service
+            end
+            if @datadog_pin.tracer == default_datadog_pin.tracer && @datadog_pin.tracer != tracer
+              @datadog_pin.tracer = tracer
             end
+
+            @datadog_pin
+          end
+
+          def default_datadog_pin
+            config = Datadog.configuration[:http]
+            service = config[:service_name]
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: -> { config[:tracer] }
+            )
           end
 
           private
 
-          def datadog_configuration
-            Datadog.configuration[:http]
+          def host_and_port(request)
+            if request.respond_to?(:uri) && request.uri
+              [request.uri.host, request.uri.port]
+            else
+              [@address, @port]
+            end
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:http, host]
           end
 
-          def analytics_enabled?
-            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          def analytics_enabled?(request_options)
+            Contrib::Analytics.enabled?(request_options[:analytics_enabled])
           end
 
-          def analytics_sample_rate
-            datadog_configuration[:analytics_sample_rate]
+          def analytics_sample_rate(request_options)
+            request_options[:analytics_sample_rate]
           end
         end
       end

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

@@ -1,5 +1,8 @@
+require 'ddtrace/version'
+
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/http/configuration/settings'
+require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
 require 'ddtrace/contrib/http/patcher'
 require 'ddtrace/contrib/http/circuit_breaker'
 
@@ -13,12 +16,18 @@ module Datadog
       class Integration
         include Contrib::Integration
 
+        MINIMUM_VERSION = Datadog::VERSION::MINIMUM_RUBY_VERSION
+
         register_as :http, auto_patch: true
 
         def self.version
           Gem::Version.new(RUBY_VERSION)
         end
 
+        def self.loaded?
+          !defined?(::Net::HTTP).nil?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end
@@ -26,6 +35,10 @@ module Datadog
         def patcher
           Patcher
         end
+
+        def resolver
+          @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+        end
       end
     end
   end

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

@@ -12,19 +12,13 @@ module Datadog
 
         module_function
 
-        def patched?
-          done?(:http)
+        def target_version
+          Integration.version
         end
 
         # patch applies our patch if needed
         def patch
-          do_once(:http) do
-            begin
-              ::Net::HTTP.send(:include, Instrumentation)
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply net/http integration: #{e}")
-            end
-          end
+          ::Net::HTTP.send(:include, Instrumentation)
         end
       end
     end

data/lib/ddtrace/contrib/http_annotation_helper.rb

@@ -0,0 +1,10 @@
+module Datadog
+  module Contrib
+    # Contains methods helpful for tracing/annotating HTTP request libraries
+    module HttpAnnotationHelper
+      def service_name(hostname, configuration_options)
+        configuration_options[:split_by_domain] ? hostname : configuration_options[:service_name]
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/httprb/configuration/settings.rb

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/httprb/ext'
+
+module Datadog
+  module Contrib
+    module Httprb
+      module Configuration
+        # Custom settings for the Httprb 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, 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, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
+            o.lazy
+          end
+
+          option :distributed_tracing, default: true
+          option :service_name, default: Ext::SERVICE_NAME
+          option :split_by_domain, default: false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Datadog
+  module Contrib
+    module Httprb
+      # Httprb integration constants
+      module Ext
+        APP = 'httprb'.freeze
+        ENV_ENABLED = 'DD_TRACE_HTTPRB_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPRB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_HTTPRB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EHTTPRB_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_HTTPRB_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'httprb'.freeze
+        SPAN_REQUEST = 'httprb.request'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/http_annotation_helper'
+
+module Datadog
+  module Contrib
+    module Httprb
+      # Instrumentation for Httprb
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        # rubocop:disable Metrics/ModuleLength
+        module InstanceMethods
+          include Datadog::Contrib::HttpAnnotationHelper
+
+          def perform(req, options)
+            host = req.uri.host if req.respond_to?(:uri) && req.uri
+            request_options = datadog_configuration(host)
+            pin = datadog_pin(request_options)
+
+            return super(req, options) unless pin && pin.tracer
+
+            pin.tracer.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span|
+              begin
+                request_options[:service_name] = pin.service_name
+                span.service = service_name(host, request_options)
+                span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
+
+                if pin.tracer.enabled && !should_skip_distributed_tracing?(pin)
+                  Datadog::HTTPPropagator.inject!(span.context, req)
+                end
+
+                # Add additional request specific tags to the span.
+                annotate_span_with_request!(span, req, request_options)
+              rescue StandardError => e
+                logger.error("error preparing span for http.rb request: #{e}, Soure: #{e.backtrace}")
+              ensure
+                res = super(req, options)
+              end
+
+              # Add additional response specific tags to the span.
+              annotate_span_with_response!(span, res)
+
+              res
+            end
+          end
+
+          private
+
+          def annotate_span_with_request!(span, req, req_options)
+            if req.verb && req.verb.is_a?(String) || req.verb.is_a?(Symbol)
+              http_method = req.verb.to_s.upcase
+              span.resource = http_method
+              span.set_tag(Datadog::Ext::HTTP::METHOD, http_method)
+            else
+              logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing request verb")
+            end
+
+            if req.uri
+              uri = req.uri
+              span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
+            else
+              logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing uri")
+            end
+
+            set_analytics_sample_rate(span, req_options)
+          end
+
+          def annotate_span_with_response!(span, response)
+            return unless response && response.code
+
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
+
+            case response.code.to_i
+            when 400...599
+              # https://github.com/DataDog/dd-trace-rb/issues/1116
+              # parsing the response body message will alter downstream application behavior
+              span.set_error(["Error #{response.code}", 'Error'])
+            end
+          end
+
+          def annotate_span_with_error!(span, error)
+            span.set_error(error)
+          end
+
+          def datadog_pin(config = Datadog.configuration[:httprb])
+            service = config[:service_name]
+            tracer = config[:tracer]
+
+            @datadog_pin ||= begin
+              Datadog::Pin.new(
+                service,
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::WEB,
+                tracer: -> { config[:tracer] }
+              )
+            end
+
+            if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
+              @datadog_pin.service = service
+            end
+            if @datadog_pin.tracer == default_datadog_pin.tracer && @datadog_pin.tracer != tracer
+              @datadog_pin.tracer = tracer
+            end
+
+            @datadog_pin
+          end
+
+          def default_datadog_pin
+            config = Datadog.configuration[:httprb]
+            service = config[:service_name]
+
+            @default_datadog_pin ||= begin
+              Datadog::Pin.new(
+                service,
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::WEB,
+                tracer: -> { config[:tracer] }
+              )
+            end
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:httprb, host]
+          end
+
+          def analytics_enabled?(request_options)
+            Contrib::Analytics.enabled?(request_options[:analytics_enabled])
+          end
+
+          def logger
+            Datadog.logger
+          end
+
+          def should_skip_distributed_tracing?(pin)
+            if pin.config && pin.config.key?(:distributed_tracing)
+              return !pin.config[:distributed_tracing]
+            end
+
+            !Datadog.configuration[:httprb][:distributed_tracing]
+          end
+
+          def set_analytics_sample_rate(span, request_options)
+            return unless analytics_enabled?(request_options)
+            Contrib::Analytics.set_sample_rate(span, request_options[:analytics_sample_rate])
+          end
+        end
+      end
+    end
+  end
+end