ls-trace 0.1.1

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

@@ -0,0 +1,72 @@
+module Datadog
+  module Contrib
+    module Rack
+      # Provides instrumentation for `rack`
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:rack)
+        end
+
+        def patch
+          # Patch middleware
+          do_once(:rack) do
+            require_relative 'middlewares'
+          end
+
+          # Patch middleware names
+          if !done?(:rack_middleware_names) && get_option(:middleware_names)
+            if get_option(:application)
+              do_once(:rack_middleware_names) do
+                patch_middleware_names
+              end
+            else
+              Datadog::Tracer.log.warn(%(
+              Rack :middleware_names requires you to also pass :application.
+              Middleware names have NOT been patched; please provide :application.
+              e.g. use: :rack, middleware_names: true, application: my_rack_app).freeze)
+            end
+          end
+        rescue StandardError => e
+          Datadog::Tracer.log.error("Unable to apply Rack integration: #{e}")
+        end
+
+        def patch_middleware_names
+          retain_middleware_name(get_option(:application))
+        rescue => e
+          # We can safely ignore these exceptions since they happen only in the
+          # context of middleware patching outside a Rails server process (eg. a
+          # process that doesn't serve HTTP requests but has Rails environment
+          # loaded such as a Resque master process)
+          Tracer.log.debug("Error patching middleware stack: #{e}")
+        end
+
+        def retain_middleware_name(middleware)
+          return unless middleware && middleware.respond_to?(:call)
+
+          middleware.singleton_class.class_eval do
+            alias_method :__call, :call
+
+            def call(env)
+              env['RESPONSE_MIDDLEWARE'] = self.class.to_s
+              __call(env)
+            end
+          end
+
+          following = if middleware.instance_variable_defined?('@app')
+                        middleware.instance_variable_get('@app')
+                      end
+
+          retain_middleware_name(following)
+        end
+
+        def get_option(option)
+          Datadog.configuration[:rack].get_option(option)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Datadog
+  module Contrib
+    module Rack
+      # QueueTime simply...
+      module QueueTime
+        REQUEST_START = 'HTTP_X_REQUEST_START'.freeze
+        QUEUE_START = 'HTTP_X_QUEUE_START'.freeze
+        MINIMUM_ACCEPTABLE_TIME_VALUE = 1_000_000_000
+
+        module_function
+
+        def get_request_start(env, now = Time.now.utc)
+          header = env[REQUEST_START] || env[QUEUE_START]
+          return unless header
+
+          # nginx header is seconds in the format "t=1512379167.574"
+          # apache header is microseconds in the format "t=1570633834463123"
+          # heroku header is milliseconds in the format "1570634024294"
+          time_string = header.to_s.delete('^0-9')
+          return if time_string.nil?
+
+          # Return nil if the time is clearly invalid
+          time_value = "#{time_string[0, 10]}.#{time_string[10, 6]}".to_f
+          return if time_value.zero? || time_value < MINIMUM_ACCEPTABLE_TIME_VALUE
+
+          # return the request_start only if it's lesser than
+          # current time, to avoid significant clock skew
+          request_start = Time.at(time_value)
+          request_start.utc > now ? nil : request_start
+        rescue StandardError => e
+          # in case of an Exception we don't create a
+          # `request.queuing` span
+          Datadog::Tracer.log.debug("[rack] unable to parse request queue headers: #{e}")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+require 'ddtrace/contrib/configuration/settings'
+
+module Datadog
+  module Contrib
+    module Rails
+      module Configuration
+        # Custom settings for the Rails integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
+            o.lazy
+            o.on_set do |value|
+              # Update ActionPack analytics too
+              Datadog.configuration[:action_pack][:analytics_enabled] = value
+            end
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+            o.on_set do |value|
+              # Update ActionPack analytics too
+              Datadog.configuration[:action_pack][:analytics_sample_rate] = value
+            end
+          end
+
+          option :cache_service do |o|
+            o.on_set do |value|
+              # Update ActiveSupport service name too
+              Datadog.configuration[:active_support][:cache_service] = value
+            end
+          end
+
+          option :controller_service do |o|
+            o.on_set do |value|
+              # Update ActionPack service name too
+              Datadog.configuration[:action_pack][:controller_service] = value
+            end
+          end
+
+          option :database_service do |o|
+            o.depends_on :service_name
+            o.on_set do |value|
+              # Update ActiveRecord service name too
+              Datadog.configuration[:active_record][:service_name] = value
+            end
+          end
+
+          option :distributed_tracing, default: true
+          option :exception_controller do |o|
+            o.on_set do |value|
+              # Update ActionPack exception controller too
+              Datadog.configuration[:action_pack][:exception_controller] = value
+            end
+          end
+
+          option :middleware, default: true
+          option :middleware_names, default: false
+          option :template_base_path do |o|
+            o.default 'views/'
+            o.on_set do |value|
+              # Update ActionView template base path too
+              Datadog.configuration[:action_view][:template_base_path] = value
+            end
+          end
+
+          option :tracer do |o|
+            o.delegate_to { Datadog.tracer }
+            o.on_set do |value|
+              Datadog.configuration[:active_record][:tracer] = value
+              Datadog.configuration[:active_support][:tracer] = value
+              Datadog.configuration[:action_pack][:tracer] = value
+              Datadog.configuration[:action_view][:tracer] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Datadog
+  module Contrib
+    module Rails
+      # Rails integration constants
+      module Ext
+        APP = 'rails'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RAILS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RAILS_ANALYTICS_SAMPLE_RATE'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+require 'ddtrace/pin'
+require 'ddtrace/ext/app_types'
+
+require 'ddtrace/contrib/active_record/integration'
+require 'ddtrace/contrib/active_support/integration'
+require 'ddtrace/contrib/action_pack/integration'
+require 'ddtrace/contrib/action_view/integration'
+require 'ddtrace/contrib/grape/endpoint'
+
+require 'ddtrace/contrib/rails/ext'
+require 'ddtrace/contrib/rails/utils'
+
+module Datadog
+  module Contrib
+    # Instrument Rails.
+    module Rails
+      # Rails framework code, used to essentially:
+      # - handle configuration entries which are specific to Datadog tracing
+      # - instrument parts of the framework when needed
+      module Framework
+        # configure Datadog settings
+        def self.setup
+          config = config_with_defaults
+
+          activate_rack!(config)
+          activate_active_support!(config)
+          activate_action_pack!(config)
+          activate_action_view!(config)
+          activate_active_record!(config)
+
+          # By default, default service would be guessed from the script
+          # being executed, but here we know better, get it from Rails config.
+          config[:tracer].default_service = config[:service_name]
+        end
+
+        def self.config_with_defaults
+          # We set defaults here instead of in the patcher because we need to wait
+          # for the Rails application to be fully initialized.
+          Datadog.configuration[:rails].tap do |config|
+            config[:service_name] ||= Utils.app_name
+            config[:database_service] ||= "#{config[:service_name]}-#{Contrib::ActiveRecord::Utils.adapter_name}"
+            config[:controller_service] ||= config[:service_name]
+            config[:cache_service] ||= "#{config[:service_name]}-cache"
+          end
+        end
+
+        def self.activate_rack!(config)
+          Datadog.configuration.use(
+            :rack,
+            tracer: config[:tracer],
+            application: ::Rails.application,
+            service_name: config[:service_name],
+            middleware_names: config[:middleware_names],
+            distributed_tracing: config[:distributed_tracing]
+          )
+        end
+
+        def self.activate_active_support!(config)
+          return unless defined?(::ActiveSupport)
+
+          Datadog.configuration.use(
+            :active_support,
+            cache_service: config[:cache_service],
+            tracer: config[:tracer]
+          )
+        end
+
+        def self.activate_action_pack!(config)
+          return unless defined?(::ActionPack)
+
+          Datadog.configuration.use(
+            :action_pack,
+            service_name: config[:service_name],
+            tracer: config[:tracer]
+          )
+        end
+
+        def self.activate_action_view!(config)
+          return unless defined?(::ActionView)
+
+          Datadog.configuration.use(
+            :action_view,
+            service_name: config[:service_name],
+            tracer: config[:tracer]
+          )
+        end
+
+        def self.activate_active_record!(config)
+          return unless defined?(::ActiveRecord)
+
+          Datadog.configuration.use(
+            :active_record,
+            service_name: config[:database_service],
+            tracer: config[:tracer]
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/rails/configuration/settings'
+require 'ddtrace/contrib/rails/patcher'
+
+module Datadog
+  module Contrib
+    module Rails
+      # Description of Rails integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :rails, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['rails'] && Gem.loaded_specs['rails'].version
+        end
+
+        def self.present?
+          defined?(::Rails)
+        end
+
+        def self.compatible?
+          return false if ENV['DISABLE_DATADOG_RAILS']
+          super && defined?(::Rails::VERSION) && ::Rails::VERSION::MAJOR.to_i >= 3
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/action_pack/utils'
+
+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 = Datadog.configuration[:rails][:tracer]
+          span = tracer.active_span
+          unless span.nil?
+            # Only set error if it's supposed to be flagged as such
+            # e.g. we don't want to flag 404s.
+            # You can add custom errors via `config.action_dispatch.rescue_responses`
+            span.set_error(e) if ActionPack::Utils.exception_is_error?(e)
+          end
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require 'ddtrace/contrib/rails/utils'
+require 'ddtrace/contrib/rails/framework'
+require 'ddtrace/contrib/rails/middlewares'
+require 'ddtrace/contrib/rack/middlewares'
+
+module Datadog
+  module Contrib
+    module Rails
+      # Patcher enables patching of 'rails' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:rails)
+        end
+
+        def patch
+          do_once(:rails) do
+            patch_before_intialize
+            patch_after_intialize
+          end
+        rescue => e
+          Datadog::Tracer.log.error("Unable to apply Rails integration: #{e}")
+        end
+
+        def patch_before_intialize
+          ::ActiveSupport.on_load(:before_initialize) do
+            Datadog::Contrib::Rails::Patcher.before_intialize(self)
+          end
+        end
+
+        def before_intialize(app)
+          do_once(:rails_before_initialize, for: app) do
+            # Middleware must be added before the application is initialized.
+            # Otherwise the middleware stack will be frozen.
+            # Sometimes we don't want to activate middleware e.g. OpenTracing, etc.
+            add_middleware(app) if Datadog.configuration[:rails][:middleware]
+          end
+        end
+
+        def add_middleware(app)
+          # Add trace middleware
+          app.middleware.insert_before(0, Datadog::Contrib::Rack::TraceMiddleware)
+
+          # Insert right after Rails exception handling middleware, because if it's before,
+          # it catches and swallows the error. If it's too far after, custom middleware can find itself
+          # between, and raise exceptions that don't end up getting tagged on the request properly.
+          # e.g lost stack trace.
+          app.middleware.insert_after(
+            ActionDispatch::ShowExceptions,
+            Datadog::Contrib::Rails::ExceptionMiddleware
+          )
+        end
+
+        def patch_after_intialize
+          ::ActiveSupport.on_load(:after_initialize) do
+            Datadog::Contrib::Rails::Patcher.after_intialize(self)
+          end
+        end
+
+        def after_intialize(app)
+          do_once(:rails_after_initialize, for: app) do
+            # Finish configuring the tracer after the application is initialized.
+            # We need to wait for some things, like application name, middleware stack, etc.
+            setup_tracer
+          end
+        end
+
+        # Configure Rails tracing with settings
+        def setup_tracer
+          Datadog::Contrib::Rails::Framework.setup
+        end
+      end
+    end
+  end
+end