ddtrace 0.45.0 → 0.52.0

data/lib/ddtrace/augmentation/shim.rb

@@ -1,102 +0,0 @@
-require 'set'
-require 'ddtrace/patcher'
-require 'ddtrace/augmentation/method_wrapping'
-
-module Datadog
-  # A "stand-in" that intercepts calls to another object. i.e. man-in-the-middle.
-  # This shim forwards all methods to object, except those overriden.
-  # Useful if you want to intercept inbound behavior to an object without modifying
-  # the object in question, especially useful if the overridding behavior shouldn't be global.
-  class Shim
-    extend Forwardable
-    include Datadog::Patcher
-    include Datadog::MethodWrapping
-
-    METHODS = Set[
-      :override_method!,
-      :shim,
-      :shim?,
-      :shim_target,
-      :wrap_method!,
-      :wrapped_methods
-    ].freeze
-
-    EXCLUDED_METHODS = Set[
-      # For all objects
-      :__binding__,
-      :__id__,
-      :__send__,
-      :extend,
-      :itself,
-      :object_id,
-      :respond_to?,
-      :tap
-    ].freeze
-
-    attr_reader :shim_target, :shim
-
-    def self.shim?(object)
-      # Check whether it responds to #shim? because otherwise the
-      # Shim forwards all method calls, including type checks to
-      # the wrapped object, to mimimize its intrusion.
-      object.respond_to?(:shim?)
-    end
-
-    # Pass this a block to override methods
-    def initialize(shim_target)
-      @shim = self
-      @shim_target = shim_target
-
-      # Save a reference to the original :define_singleton_method
-      # so methods can be defined on the shim after forwarding is applied.
-      @definition_method = method(:define_singleton_method)
-
-      # Wrap any methods
-      yield(self) if block_given?
-
-      # Forward methods
-      forwarded_methods = (
-        shim_target.public_methods.to_set \
-        - METHODS \
-        - EXCLUDED_METHODS \
-        - wrapped_methods
-      )
-      forward_methods!(*forwarded_methods)
-    end
-
-    def override_method!(method_name, &block)
-      return unless block_given?
-
-      without_warnings do
-        @definition_method.call(method_name, &block).tap do
-          wrapped_methods.add(method_name)
-        end
-      end
-    end
-
-    def wrap_method!(method_name, &block)
-      super(shim_target.method(method_name), &block)
-    end
-
-    def shim?
-      true
-    end
-
-    def respond_to?(method_name)
-      return true if METHODS.include?(method_name)
-      shim_target.respond_to?(method_name)
-    end
-
-    private
-
-    def forward_methods!(*forwarded_methods)
-      return if forwarded_methods.empty?
-
-      singleton_class.send(
-        :def_delegators,
-        :@shim_target,
-        *forwarded_methods
-      )
-    end
-  end
-end

data/lib/ddtrace/augmentation.rb

@@ -1,13 +0,0 @@
-require 'ddtrace/augmentation/method_wrapper'
-require 'ddtrace/augmentation/method_wrapping'
-require 'ddtrace/augmentation/shim'
-
-module Datadog
-  # Namespace for components that help modify
-  # existing code for instrumentation purposes.
-  module Augmentation
-    def shim(object, &block)
-      Shim.new(object, &block)
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/cucumber/ext'
-
-module Datadog
-  module Contrib
-    module Cucumber
-      module Configuration
-        # Custom settings for the Cucumber 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, true) }
-            o.lazy
-          end
-
-          option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-            o.lazy
-          end
-
-          option :service_name do |o|
-            o.default { Datadog.configuration.service || Ext::SERVICE_NAME }
-            o.lazy
-          end
-
-          option :operation_name do |o|
-            o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
-            o.lazy
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Datadog
-  module Contrib
-    module Cucumber
-      # Cucumber integration constants
-      module Ext
-        APP = 'cucumber'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_CUCUMBER_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_CUCUMBER_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ENABLED = 'DD_TRACE_CUCUMBER_ENABLED'.freeze
-        ENV_OPERATION_NAME = 'DD_TRACE_CUCUMBER_OPERATION_NAME'.freeze
-        FRAMEWORK = 'cucumber'.freeze
-        OPERATION_NAME = 'cucumber.test'.freeze
-        SERVICE_NAME = 'cucumber'.freeze
-        STEP_SPAN_TYPE = 'step'.freeze
-        TEST_TYPE = 'test'.freeze
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/cucumber/formatter.rb

@@ -1,104 +0,0 @@
-require 'ddtrace/ext/app_types'
-require 'ddtrace/ext/ci'
-require 'ddtrace/ext/test'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/cucumber/ext'
-
-module Datadog
-  module Contrib
-    module Cucumber
-      # Defines collection of instrumented Cucumber events
-      class Formatter
-        attr_reader :config
-        private :config
-
-        attr_reader :current_feature_span, :current_step_span
-        private :current_feature_span, :current_step_span
-
-        def initialize(config)
-          @config = config
-
-          bind_events(config)
-        end
-
-        def bind_events(config)
-          config.on_event :test_case_started, &method(:on_test_case_started)
-          config.on_event :test_case_finished, &method(:on_test_case_finished)
-          config.on_event :test_step_started, &method(:on_test_step_started)
-          config.on_event :test_step_finished, &method(:on_test_step_finished)
-        end
-
-        def on_test_case_started(event)
-          trace_options = {
-            app: Ext::APP,
-            resource: event.test_case.name,
-            service: configuration[:service_name],
-            span_type: Datadog::Ext::AppTypes::TEST,
-            tags: tags.merge(Datadog.configuration.tags)
-          }
-          @current_feature_span = tracer.trace(configuration[:operation_name], trace_options)
-          @current_feature_span.set_tag(Datadog::Ext::Test::TAG_FRAMEWORK, Ext::FRAMEWORK)
-          @current_feature_span.set_tag(Datadog::Ext::Test::TAG_NAME, event.test_case.name)
-          @current_feature_span.set_tag(Datadog::Ext::Test::TAG_SUITE, event.test_case.location.file)
-          @current_feature_span.set_tag(Datadog::Ext::Test::TAG_TYPE, Ext::TEST_TYPE)
-          @current_feature_span.set_tag(Datadog::Ext::Test::TAG_SPAN_KIND, Datadog::Ext::AppTypes::TEST)
-
-          # Set analytics sample rate
-          if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-            Datadog::Contrib::Analytics.set_sample_rate(@current_feature_span, configuration[:analytics_sample_rate])
-          end
-
-          # Measure service stats
-          Contrib::Analytics.set_measured(@current_feature_span)
-        end
-
-        def on_test_case_finished(event)
-          return if @current_feature_span.nil?
-          @current_feature_span.status = 1 if event.result.failed?
-          @current_feature_span.set_tag(Datadog::Ext::Test::TAG_STATUS, status_from_result(event.result))
-          @current_feature_span.finish
-        end
-
-        def on_test_step_started(event)
-          trace_options = {
-            resource: event.test_step.to_s,
-            span_type: Ext::STEP_SPAN_TYPE
-          }
-          @current_step_span = tracer.trace(Ext::STEP_SPAN_TYPE, trace_options)
-        end
-
-        def on_test_step_finished(event)
-          return if @current_step_span.nil?
-          unless event.result.passed?
-            @current_step_span.set_error event.result.exception
-          end
-          @current_step_span.set_tag(Datadog::Ext::Test::TAG_STATUS, status_from_result(event.result))
-          @current_step_span.finish
-        end
-
-        private
-
-        def status_from_result(result)
-          if result.skipped?
-            return Datadog::Ext::Test::Status::SKIP
-          elsif result.ok?
-            return Datadog::Ext::Test::Status::PASS
-          end
-          Datadog::Ext::Test::Status::FAIL
-        end
-
-        def configuration
-          Datadog.configuration[:cucumber]
-        end
-
-        def tracer
-          configuration[:tracer]
-        end
-
-        def tags
-          @tags ||= Datadog::Ext::CI.tags(ENV)
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-require 'ddtrace/contrib/cucumber/formatter'
-
-module Datadog
-  module Contrib
-    module Cucumber
-      # Instrumentation for Cucumber
-      module Instrumentation
-        def self.included(base)
-          base.send(:prepend, InstanceMethods)
-        end
-
-        # Instance methods for configuration
-        module InstanceMethods
-          attr_reader :datadog_formatter
-
-          def formatters
-            @datadog_formatter ||= Datadog::Contrib::Cucumber::Formatter.new(@configuration)
-            [@datadog_formatter] + super
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/cucumber/configuration/settings'
-require 'ddtrace/contrib/cucumber/patcher'
-require 'ddtrace/contrib/integration'
-
-module Datadog
-  module Contrib
-    module Cucumber
-      # Description of Cucumber integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('3.0.0')
-
-        register_as :cucumber, auto_patch: true
-
-        def self.version
-          Gem.loaded_specs['cucumber'] \
-            && Gem.loaded_specs['cucumber'].version
-        end
-
-        def self.loaded?
-          !defined?(::Cucumber).nil? && !defined?(::Cucumber::Runtime).nil?
-        end
-
-        def self.compatible?
-          super && version >= MINIMUM_VERSION
-        end
-
-        # test environments should not auto instrument test libraries
-        def auto_instrument?
-          false
-        end
-
-        def default_configuration
-          Configuration::Settings.new
-        end
-
-        def patcher
-          Patcher
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/rspec/ext'
-
-module Datadog
-  module Contrib
-    module RSpec
-      module Configuration
-        # Custom settings for the RSpec 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, true) }
-            o.lazy
-          end
-
-          option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-            o.lazy
-          end
-
-          option :service_name do |o|
-            o.default { Datadog.configuration.service || Ext::SERVICE_NAME }
-            o.lazy
-          end
-
-          option :operation_name do |o|
-            o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
-            o.lazy
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/rspec/example.rb

@@ -1,61 +0,0 @@
-module Datadog
-  module Contrib
-    module RSpec
-      # Instrument RSpec::Core::Example
-      module Example
-        def self.included(base)
-          base.send(:prepend, InstanceMethods)
-        end
-
-        # Instance methods for configuration
-        module InstanceMethods
-          def run(example_group_instance, reporter)
-            configuration = Datadog.configuration[:rspec]
-            return super unless configuration[:enabled]
-
-            test_name = "#{example_group.description}::#{description}"
-            trace_options = {
-              app: Ext::APP,
-              resource: test_name,
-              service: configuration[:service_name],
-              span_type: Datadog::Ext::AppTypes::TEST,
-              tags: example_group.instance_variable_get(:@tags).merge(Datadog.configuration.tags)
-            }
-
-            configuration[:tracer].trace(configuration[:operation_name], trace_options) do |span|
-              span.set_tag(Datadog::Ext::Test::TAG_FRAMEWORK, Ext::FRAMEWORK)
-              span.set_tag(Datadog::Ext::Test::TAG_NAME, test_name)
-              span.set_tag(Datadog::Ext::Test::TAG_SUITE, example_group.file_path)
-              span.set_tag(Datadog::Ext::Test::TAG_TYPE, Ext::TEST_TYPE)
-              span.set_tag(Datadog::Ext::Test::TAG_SPAN_KIND, Datadog::Ext::AppTypes::TEST)
-
-              # Set analytics sample rate
-              if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-                Datadog::Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-              end
-
-              # Measure service stats
-              Contrib::Analytics.set_measured(span)
-
-              result = super
-
-              case execution_result.status
-              when :passed
-                span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::PASS)
-              when :failed
-                span.status = 1
-                span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::FAIL)
-                span.set_error(execution_result.exception)
-              else
-                if execution_result.example_skipped?
-                  span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::SKIP)
-                end
-              end
-              result
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/rspec/example_group.rb

@@ -1,61 +0,0 @@
-module Datadog
-  module Contrib
-    module RSpec
-      # Instrument RSpec::Core::ExampleGroup
-      module ExampleGroup
-        def self.included(base)
-          base.singleton_class.send(:prepend, ClassMethods)
-        end
-
-        # Class methods for configuration
-        module ClassMethods
-          def run(reporter = ::RSpec::Core::NullReporter)
-            configuration = Datadog.configuration[:rspec]
-            return super unless configuration[:enabled]
-
-            trace_options = {
-              app: Ext::APP,
-              resource: description,
-              service: configuration[:service_name],
-              span_type: Datadog::Ext::AppTypes::TEST,
-              tags: tags.merge(Datadog.configuration.tags)
-            }
-
-            configuration[:tracer].trace(Ext::EXAMPLE_GROUP_OPERATION_NAME, trace_options) do |span|
-              span.set_tag(Datadog::Ext::Test::TAG_FRAMEWORK, Ext::FRAMEWORK)
-              span.set_tag(Datadog::Ext::Test::TAG_NAME, description)
-              span.set_tag(Datadog::Ext::Test::TAG_SUITE, file_path)
-              span.set_tag(Datadog::Ext::Test::TAG_TYPE, Ext::TEST_TYPE)
-              span.set_tag(Datadog::Ext::Test::TAG_SPAN_KIND, Datadog::Ext::AppTypes::TEST)
-
-              # Set analytics sample rate
-              if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-                Datadog::Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-              end
-
-              # Measure service stats
-              Contrib::Analytics.set_measured(span)
-
-              result = super
-
-              if ::RSpec.world.wants_to_quit
-                span.status = 1
-                span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::FAIL)
-              else
-                span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::PASS)
-              end
-
-              result
-            end
-          end
-
-          private
-
-          def tags
-            @tags ||= Datadog::Ext::CI.tags(ENV)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Datadog
-  module Contrib
-    module RSpec
-      # RSpec integration constants
-      module Ext
-        APP = 'rspec'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RSPEC_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RSPEC_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ENABLED = 'DD_TRACE_RSPEC_ENABLED'.freeze
-        ENV_OPERATION_NAME = 'DD_TRACE_RSPEC_OPERATION_NAME'.freeze
-        FRAMEWORK = 'rspec'.freeze
-        OPERATION_NAME = 'rspec.example'.freeze
-        EXAMPLE_GROUP_OPERATION_NAME = 'rspec.example_group'.freeze
-        SERVICE_NAME = 'rspec'.freeze
-        TEST_TYPE = 'test'.freeze
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/rspec/configuration/settings'
-require 'ddtrace/contrib/rspec/patcher'
-require 'ddtrace/contrib/integration'
-
-module Datadog
-  module Contrib
-    module RSpec
-      # Description of RSpec integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('3.0.0')
-
-        register_as :rspec, auto_patch: true
-
-        def self.version
-          Gem.loaded_specs['rspec'] \
-            && Gem.loaded_specs['rspec'].version
-        end
-
-        def self.loaded?
-          !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? && \
-            !defined?(::RSpec::Core::Example).nil? && !defined?(::RSpec::Core::ExampleGroup).nil?
-        end
-
-        def self.compatible?
-          super && version >= MINIMUM_VERSION
-        end
-
-        # test environments should not auto instrument test libraries
-        def auto_instrument?
-          false
-        end
-
-        def default_configuration
-          Configuration::Settings.new
-        end
-
-        def patcher
-          Patcher
-        end
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/contrib/rspec/example'
-require 'ddtrace/contrib/rspec/example_group'
-
-module Datadog
-  module Contrib
-    module RSpec
-      # Patcher enables patching of 'rspec' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          ::RSpec::Core::Example.send(:include, Example)
-          ::RSpec::Core::ExampleGroup.send(:include, ExampleGroup)
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/environment.rb

@@ -1,41 +0,0 @@
-require 'ddtrace/ext/environment'
-
-module Datadog
-  # Namespace for handling application environment
-  module Environment
-    # Defines helper methods for environment
-    module Helpers
-      def env_to_bool(var, default = nil)
-        var = decode_array(var)
-        var && ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default
-      end
-
-      def env_to_int(var, default = nil)
-        var = decode_array(var)
-        var && ENV.key?(var) ? ENV[var].to_i : default
-      end
-
-      def env_to_float(var, default = nil)
-        var = decode_array(var)
-        var && ENV.key?(var) ? ENV[var].to_f : default
-      end
-
-      def env_to_list(var, default = [])
-        var = decode_array(var)
-        if var && ENV.key?(var)
-          ENV[var].split(',').map(&:strip)
-        else
-          default
-        end
-      end
-
-      private
-
-      def decode_array(var)
-        var.is_a?(Array) ? var.find { |env_var| ENV.key?(env_var) } : var
-      end
-    end
-
-    extend Helpers
-  end
-end