cw-datadog 2.23.0.2

data/lib/datadog/tracing/contrib/rack/route_inference.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rack
+        # This module provides logic for inferring HTTP route pattern
+        # from an HTTP path.
+        module RouteInference
+          MAX_NUMBER_OF_SEGMENTS = 8
+
+          INT_PARAM_REGEX = /\A[0-9]+\z/.freeze
+          INT_ID_PARAM_REGEX = /\A(?=.*\d)[\d._-]{3,}\z/.freeze
+          HEX_PARAM_REGEX = /\A(?=.*\d)[A-Fa-f0-9]{6,}\z/.freeze
+          HEX_ID_PARAM_REGEX = /\A(?=.*\d)[A-Fa-f0-9._-]{6,}\z/.freeze
+          STRING_PARAM_REGEX = /\A.{20,}|.*[%&'()*+,:=@].*\z/.freeze
+
+          DATADOG_INFERRED_ROUTE_ENV_KEY = 'datadog.inferred_route'
+
+          module_function
+
+          def read_or_infer(request_env)
+            request_env[DATADOG_INFERRED_ROUTE_ENV_KEY] ||=
+              infer(request_env['SCRIPT_NAME'].to_s + request_env['PATH_INFO'].to_s)
+          end
+
+          def infer(path)
+            segments = path.delete_prefix('/').split('/', MAX_NUMBER_OF_SEGMENTS + 1).first(MAX_NUMBER_OF_SEGMENTS)
+
+            segments.map! do |segment| #: Array[String?]
+              next if segment.empty?
+
+              case segment
+              when INT_PARAM_REGEX then '{param:int}'
+              when INT_ID_PARAM_REGEX then '{param:int_id}'
+              when HEX_PARAM_REGEX then '{param:hex}'
+              when HEX_ID_PARAM_REGEX then '{param:hex_id}'
+              when STRING_PARAM_REGEX then '{param:str}'
+              else segment
+              end
+            end
+
+            segments.compact! #: Array[String]
+
+            "/#{segments.join("/")}"
+          rescue
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rack/trace_proxy_middleware.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative 'request_queue'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rack
+        # Module to create virtual proxy span
+        module TraceProxyMiddleware
+          module_function
+
+          def call(env, configuration)
+            return yield unless configuration[:request_queuing]
+
+            # parse the request queue time
+            start_time = Contrib::Rack::QueueTime.get_request_start(env)
+            return yield unless start_time
+
+            options = {
+              service: configuration[:web_service_name],
+              start_time: start_time,
+              type: Tracing::Metadata::Ext::HTTP::TYPE_PROXY
+            }
+
+            request_span = Tracing.trace(Ext::SPAN_HTTP_PROXY_REQUEST, **options)
+
+            request_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT_HTTP_PROXY)
+            request_span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_HTTP_PROXY_REQUEST)
+            request_span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_PROXY)
+
+            queue_span = Tracing.trace(Ext::SPAN_HTTP_PROXY_QUEUE, **options)
+
+            queue_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT_HTTP_PROXY)
+            queue_span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_HTTP_PROXY_QUEUE)
+            queue_span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_PROXY)
+
+            Contrib::Analytics.set_measured(queue_span)
+            # finish the `queue` span now to record only the time spent *in queue*,
+            # excluding the time spent processing the request itself
+            queue_span.finish
+
+            yield
+          ensure
+            # Ensure that the spans are finished even if an exception is raised.
+            # **This is very important** to prevent the trace from leaking between requests,
+            # especially because `queue_span` is normally a root span.
+            queue_span&.finish
+            request_span&.finish
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/auto_instrument_railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Railtie to include AutoInstrumentation in rails loading
+class DatadogAutoInstrumentRailtie < Rails::Railtie
+  # we want to load before config initializers so that any user supplied config
+  # in config/initializers/datadog.rb will take precedence
+  initializer 'datadog.start_tracer', before: :load_config_initializers do
+    Datadog::Tracing::Contrib::AutoInstrument.patch_all!
+  end
+end

data/lib/datadog/tracing/contrib/rails/configuration/settings.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+
+require_relative '../../../../core'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rails
+        module Configuration
+          # Custom settings for the Rails integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            def initialize(options = {})
+              super
+
+              # NOTE: Eager load these
+              #       Rails integration is responsible for orchestrating other integrations.
+              #       When using environment variables, settings will not be automatically
+              #       filled because nothing explicitly calls them. They must though, so
+              #       integrations like ActionPack can receive the value as it should.
+              #       Trigger these manually to force an eager load and propagate them.
+              analytics_enabled
+              analytics_sample_rate
+            end
+
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            # @!visibility private
+            option :analytics_enabled do |o|
+              o.type :bool, nilable: true
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.after_set do |value|
+                # Update ActionPack analytics too
+                Datadog.configuration.tracing[:action_pack][:analytics_enabled] = value
+              end
+            end
+
+            option :analytics_sample_rate do |o|
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
+              o.after_set do |value|
+                # Update ActionPack analytics too
+                Datadog.configuration.tracing[:action_pack][:analytics_sample_rate] = value
+              end
+            end
+
+            option :distributed_tracing, default: true, type: :bool
+
+            option :request_queuing do |o|
+              o.type :bool
+              o.default false
+            end
+
+            option :middleware, default: true, type: :bool
+            option :middleware_names, default: false, type: :bool
+            option :template_base_path do |o|
+              o.type :string
+              o.default 'views/'
+              o.after_set do |value|
+                # Update ActionView template base path too
+                Datadog.configuration.tracing[:action_view][:template_base_path] = value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/ext.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rails
+        # Rails integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          APP = 'rails'
+          ENV_ENABLED = 'DD_TRACE_RAILS_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_RAILS_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RAILS_ANALYTICS_SAMPLE_RATE'
+          # Note: Alias (previous name DISABLE_DATADOG_RAILS) defined in supported-configurations.json
+          ENV_DISABLE = 'DD_DISABLE_DATADOG_RAILS'
+
+          SPAN_RUNNER_FILE = 'rails.runner.file'
+          SPAN_RUNNER_INLINE = 'rails.runner.inline'
+          SPAN_RUNNER_STDIN = 'rails.runner.stdin'
+          TAG_COMPONENT = 'rails'
+          TAG_OPERATION_FILE = 'runner.file'
+          TAG_OPERATION_INLINE = 'runner.inline'
+          TAG_OPERATION_STDIN = 'runner.stdin'
+          TAG_RUNNER_SOURCE = 'source'
+
+          # @!visibility private
+          MINIMUM_VERSION = Gem::Version.new('4')
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/framework.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative '../action_cable/integration'
+require_relative '../action_mailer/integration'
+require_relative '../action_pack/integration'
+require_relative '../action_view/integration'
+require_relative '../active_record/integration'
+require_relative '../active_support/integration'
+require_relative '../grape/endpoint'
+require_relative '../lograge/integration'
+require_relative 'ext'
+require_relative '../../../core/contrib/rails/utils'
+require_relative '../semantic_logger/integration'
+
+module Datadog
+  module Tracing
+    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
+          # After the Rails application finishes initializing, we configure the Rails
+          # integration and all its sub-components with the application information
+          # available.
+          # We do this after the initialization because not all the information we
+          # require is available before then.
+          def self.setup
+            # NOTE: #configure has the side effect of rebuilding trace components.
+            #       During a typical Rails application lifecycle, we will see trace
+            #       components initialized twice because of this. This is necessary
+            #       because key configuration is not available until after the Rails
+            #       application has fully loaded, and some of this configuration is
+            #       used to reconfigure tracer components with Rails-sourced defaults.
+            #       This is a trade-off we take to get nice defaults.
+            Datadog.configure do |datadog_config|
+              rails_config = datadog_config.tracing[:rails]
+
+              # By default, default service would be guessed from the script
+              # being executed, but here we know better, get it from Rails config.
+              # Don't set this if service has been explicitly provided by the user.
+              if datadog_config.service_without_fallback.nil?
+                datadog_config.service = rails_config[:service_name] || Core::Contrib::Rails::Utils.app_name
+              end
+
+              activate_rack!(datadog_config, rails_config)
+              activate_action_cable!(datadog_config, rails_config)
+              activate_action_mailer!(datadog_config, rails_config)
+              activate_active_support!(datadog_config, rails_config)
+              activate_action_pack!(datadog_config, rails_config)
+              activate_action_view!(datadog_config, rails_config)
+              activate_active_job!(datadog_config, rails_config)
+              activate_active_record!(datadog_config, rails_config)
+              activate_lograge!(datadog_config, rails_config)
+              activate_semantic_logger!(datadog_config, rails_config)
+            end
+          end
+
+          def self.activate_rack!(datadog_config, rails_config)
+            datadog_config.tracing.instrument(
+              :rack,
+              application: ::Rails.application,
+              service_name: rails_config[:service_name],
+              middleware_names: rails_config[:middleware_names],
+              distributed_tracing: rails_config[:distributed_tracing],
+              request_queuing: rails_config[:request_queuing]
+            )
+          end
+
+          def self.activate_active_support!(datadog_config, rails_config)
+            return unless defined?(::ActiveSupport)
+
+            datadog_config.tracing.instrument(:active_support)
+          end
+
+          def self.activate_action_cable!(datadog_config, rails_config)
+            return unless defined?(::ActionCable)
+
+            datadog_config.tracing.instrument(:action_cable)
+          end
+
+          def self.activate_action_mailer!(datadog_config, rails_config)
+            return unless defined?(::ActionMailer)
+
+            datadog_config.tracing.instrument(
+              :action_mailer,
+              service_name: rails_config[:service_name]
+            )
+          end
+
+          def self.activate_action_pack!(datadog_config, rails_config)
+            return unless defined?(::ActionPack)
+
+            datadog_config.tracing.instrument(
+              :action_pack,
+              service_name: rails_config[:service_name]
+            )
+          end
+
+          def self.activate_action_view!(datadog_config, rails_config)
+            return unless defined?(::ActionView)
+
+            datadog_config.tracing.instrument(
+              :action_view,
+              service_name: rails_config[:service_name]
+            )
+          end
+
+          def self.activate_active_job!(datadog_config, rails_config)
+            return unless defined?(::ActiveJob)
+
+            datadog_config.tracing.instrument(
+              :active_job,
+              service_name: rails_config[:service_name]
+            )
+          end
+
+          def self.activate_active_record!(datadog_config, rails_config)
+            return unless defined?(::ActiveRecord)
+
+            datadog_config.tracing.instrument(:active_record)
+          end
+
+          def self.activate_lograge!(datadog_config, rails_config)
+            return unless defined?(::Lograge)
+
+            if datadog_config.tracing.log_injection
+              datadog_config.tracing.instrument(
+                :lograge
+              )
+            end
+          end
+
+          def self.activate_semantic_logger!(datadog_config, rails_config)
+            return unless defined?(::SemanticLogger)
+
+            if datadog_config.tracing.log_injection
+              datadog_config.tracing.instrument(
+                :semantic_logger
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/integration.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+
+require_relative 'ext'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rails
+        # Description of Rails integration
+        class Integration
+          include Contrib::Integration
+
+          # The version of Rails lives in Ext because the `rails/patcher.rb` indirectly loads
+          # all Rails components, and those components need the Rails version. Declaring the version
+          # here would cause a circular dependency.
+          MINIMUM_VERSION = Ext::MINIMUM_VERSION
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :rails, auto_patch: false
+
+          def self.version
+            Gem.loaded_specs['railties']&.version
+          end
+
+          def self.loaded?
+            !defined?(::Rails).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def self.patchable?
+            super && !DATADOG_ENV.key?(Ext::ENV_DISABLE)
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/log_injection.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Instrument Rails.
+      module Rails
+        # Rails log injection helper methods
+        module LogInjection
+          module_function
+
+          # Use `app.config.log_tags` to inject propagation tags into the default Rails logger.
+          def configure_log_tags(app_config)
+            # When using SemanticLogger, app_config.log_tags could be a Hash and should not be modified here
+            return unless app_config.log_tags.nil? || app_config.log_tags.respond_to?(:<<)
+
+            app_config.log_tags ||= [] # Can be nil, we initialized it if so
+            app_config.log_tags << proc { Tracing.log_correlation if Datadog.configuration.tracing.log_injection }
+          rescue => e
+            Datadog.logger.warn(
+              "Unable to add Datadog Trace context to ActiveSupport::TaggedLogging: #{e.class.name} #{e.message}"
+            )
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/middlewares.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../action_pack/utils'
+
+module Datadog
+  module Tracing
+    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
+            span = Tracing.active_span
+            if !span.nil? && ActionPack::Utils.exception_is_error?(e)
+              # By default, only 5XX exceptions are actually errors (e.g. don't flag 404s).
+              # This can be changed by setting `DD_TRACE_HTTP_SERVER_ERROR_STATUSES` environment variable.
+              # You can add custom errors via `config.action_dispatch.rescue_responses`
+              span.set_error(e)
+
+              # Some exception gets handled by Rails middleware before it can be set on Rack middleware
+              # The rack span is the root span of the request and should make sure it has the full exception
+              # set on it.
+              env[Contrib::Rack::Ext::RACK_ENV_REQUEST_SPAN]&.set_error(e)
+            end
+            raise e
+          end
+          # rubocop:enable Lint/RescueException
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/patcher.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative '../../../core/utils/only_once'
+require_relative '../rack/middlewares'
+require_relative 'framework'
+require_relative 'log_injection'
+require_relative 'middlewares'
+require_relative 'runner'
+require_relative '../../../core/contrib/rails/utils'
+require_relative '../semantic_logger/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rails
+        # Patcher enables patching of 'rails' module.
+        module Patcher
+          include Contrib::Patcher
+
+          BEFORE_INITIALIZE_ONLY_ONCE_PER_APP = Hash.new { |h, key| h[key] = Core::Utils::OnlyOnce.new }
+          AFTER_INITIALIZE_ONLY_ONCE_PER_APP = Hash.new { |h, key| h[key] = Core::Utils::OnlyOnce.new }
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            patch_before_initialize
+            patch_after_initialize
+            patch_rails_runner
+          end
+
+          def patch_before_initialize
+            ::ActiveSupport.on_load(:before_initialize) do
+              Contrib::Rails::Patcher.before_initialize(self)
+            end
+          end
+
+          def before_initialize(app)
+            BEFORE_INITIALIZE_ONLY_ONCE_PER_APP[app].run do
+              # Middleware must be added before the application is initialized.
+              # Otherwise the middleware stack will be frozen.
+              add_middleware(app) if Datadog.configuration.tracing[:rails][:middleware]
+
+              Rails::LogInjection.configure_log_tags(app.config)
+            end
+          end
+
+          def add_middleware(app)
+            # Add trace middleware at the top of the middleware stack,
+            # to ensure we capture the complete execution time.
+            app.middleware.insert_before(0, Contrib::Rack::TraceMiddleware)
+
+            # Some Rails middleware can swallow an application error, preventing
+            # the error propagation to the encompassing Rack span.
+            #
+            # We insert our own middleware right before these Rails middleware
+            # have a chance to swallow the error.
+            #
+            # Note: because the middleware stack is push/pop, "before" and "after" are reversed
+            # for our use case: we insert ourselves with "after" a middleware to ensure we are
+            # able to pop the request "before" it.
+            app.middleware.insert_after(::ActionDispatch::DebugExceptions, Contrib::Rails::ExceptionMiddleware)
+          end
+
+          def patch_after_initialize
+            ::ActiveSupport.on_load(:after_initialize) do
+              Contrib::Rails::Patcher.after_initialize(self)
+            end
+          end
+
+          def after_initialize(app)
+            AFTER_INITIALIZE_ONLY_ONCE_PER_APP[app].run 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
+            Contrib::Rails::Framework.setup
+          end
+
+          # Instruments the `bin/rails runner` command.
+          def patch_rails_runner
+            # The `RunnerCommand` class is only available in Rails 5.1 and later.
+            if defined?(::Rails::Command::RunnerCommand) && Integration.version >= Gem::Version.new('5.1')
+              ::Rails::Command::RunnerCommand.prepend(Runner)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rails/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'framework'
+require_relative 'middlewares'
+require_relative '../rack/middlewares'
+
+module Datadog
+  # Railtie class initializes
+  class Railtie < Rails::Railtie
+    # Add the trace middleware to the application stack
+    initializer 'datadog.before_initialize' do |app|
+      Tracing::Contrib::Rails::Patcher.before_initialize(app)
+    end
+
+    config.after_initialize do
+      Tracing::Contrib::Rails::Patcher.after_initialize(self)
+    end
+  end
+end