ddtrace 0.49.0 → 1.12.1

data/lib/ddtrace/configuration/components.rb

@@ -1,226 +0,0 @@
-require 'ddtrace/configuration/agent_settings_resolver'
-require 'ddtrace/diagnostics/health'
-require 'ddtrace/logger'
-require 'ddtrace/profiling'
-require 'ddtrace/runtime/metrics'
-require 'ddtrace/tracer'
-require 'ddtrace/workers/runtime_metrics'
-
-module Datadog
-  module Configuration
-    # Global components for the trace library.
-    # rubocop:disable Layout/LineLength
-    class Components
-      class << self
-        def build_health_metrics(settings)
-          settings = settings.diagnostics.health_metrics
-          options = { enabled: settings.enabled }
-          options[:statsd] = settings.statsd unless settings.statsd.nil?
-
-          Datadog::Diagnostics::Health::Metrics.new(options)
-        end
-
-        def build_logger(settings)
-          logger = settings.logger.instance || Datadog::Logger.new($stdout)
-          logger.level = settings.diagnostics.debug ? ::Logger::DEBUG : settings.logger.level
-
-          logger
-        end
-
-        def build_runtime_metrics(settings)
-          options = { enabled: settings.runtime_metrics.enabled }
-          options[:statsd] = settings.runtime_metrics.statsd unless settings.runtime_metrics.statsd.nil?
-          options[:services] = [settings.service] unless settings.service.nil?
-
-          Datadog::Runtime::Metrics.new(options)
-        end
-
-        def build_runtime_metrics_worker(settings)
-          # NOTE: Should we just ignore building the worker if its not enabled?
-          options = settings.runtime_metrics.opts.merge(
-            enabled: settings.runtime_metrics.enabled,
-            metrics: build_runtime_metrics(settings)
-          )
-
-          Datadog::Workers::RuntimeMetrics.new(options)
-        end
-
-        def build_tracer(settings, agent_settings)
-          # If a custom tracer has been provided, use it instead.
-          # Ignore all other options (they should already be configured.)
-          tracer = settings.tracer.instance
-          return tracer unless tracer.nil?
-
-          tracer = Tracer.new(
-            default_service: settings.service,
-            enabled: settings.tracer.enabled,
-            partial_flush: settings.tracer.partial_flush.enabled,
-            tags: build_tracer_tags(settings)
-          )
-
-          # TODO: We reconfigure the tracer here because it has way too many
-          #       options it allows to mutate, and it's overwhelming to rewrite
-          #       tracer initialization for now. Just reconfigure using the
-          #       existing mutable #configure function. Remove when these components
-          #       are extracted.
-          tracer.configure(agent_settings: agent_settings, **build_tracer_options(settings))
-
-          tracer
-        end
-
-        def build_profiler(settings, agent_settings)
-          return unless Datadog::Profiling.supported? && settings.profiling.enabled
-
-          # Load extensions needed to support some of the Profiling features
-          Datadog::Profiling::Tasks::Setup.new.run
-
-          # NOTE: Please update the Initialization section of ProfilingDevelopment.md with any changes to this method
-
-          recorder = build_profiler_recorder(settings)
-          collectors = build_profiler_collectors(settings, recorder)
-          exporters = build_profiler_exporters(settings, agent_settings)
-          scheduler = build_profiler_scheduler(settings, recorder, exporters)
-
-          Datadog::Profiler.new(collectors, scheduler)
-        end
-
-        private
-
-        def build_tracer_tags(settings)
-          settings.tags.dup.tap do |tags|
-            tags['env'] = settings.env unless settings.env.nil?
-            tags['version'] = settings.version unless settings.version.nil?
-          end
-        end
-
-        def build_tracer_options(settings)
-          settings = settings.tracer
-
-          {}.tap do |opts|
-            opts[:min_spans_before_partial_flush] = settings.partial_flush.min_spans_threshold unless settings.partial_flush.min_spans_threshold.nil?
-            opts[:partial_flush] = settings.partial_flush.enabled unless settings.partial_flush.enabled.nil?
-            opts[:priority_sampling] = settings.priority_sampling unless settings.priority_sampling.nil?
-            opts[:sampler] = settings.sampler unless settings.sampler.nil?
-            opts[:writer] = settings.writer unless settings.writer.nil?
-            opts[:writer_options] = settings.writer_options if settings.writer.nil?
-          end
-        end
-
-        def build_profiler_recorder(settings)
-          event_classes = [Datadog::Profiling::Events::StackSample]
-
-          Datadog::Profiling::Recorder.new(event_classes, settings.profiling.max_events)
-        end
-
-        def build_profiler_collectors(settings, recorder)
-          [
-            Datadog::Profiling::Collectors::Stack.new(
-              recorder,
-              max_frames: settings.profiling.max_frames
-              # TODO: Provide proc that identifies Datadog worker threads?
-              # ignore_thread: settings.profiling.ignore_profiler
-            )
-          ]
-        end
-
-        def build_profiler_exporters(settings, agent_settings)
-          transport =
-            settings.profiling.exporter.transport || Datadog::Profiling::Transport::HTTP.default(
-              agent_settings: agent_settings,
-              site: settings.site,
-              api_key: settings.api_key,
-              profiling_upload_timeout_seconds: settings.profiling.upload.timeout_seconds
-            )
-
-          [Datadog::Profiling::Exporter.new(transport)]
-        end
-
-        def build_profiler_scheduler(settings, recorder, exporters)
-          Datadog::Profiling::Scheduler.new(recorder, exporters)
-        end
-      end
-
-      attr_reader \
-        :health_metrics,
-        :logger,
-        :profiler,
-        :runtime_metrics,
-        :tracer
-
-      def initialize(settings)
-        # Logger
-        @logger = self.class.build_logger(settings)
-
-        agent_settings = AgentSettingsResolver.call(settings, logger: @logger)
-
-        # Tracer
-        @tracer = self.class.build_tracer(settings, agent_settings)
-
-        # Profiler
-        @profiler = self.class.build_profiler(settings, agent_settings)
-
-        # Runtime metrics
-        @runtime_metrics = self.class.build_runtime_metrics_worker(settings)
-
-        # Health metrics
-        @health_metrics = self.class.build_health_metrics(settings)
-      end
-
-      # Starts up components
-      def startup!(settings)
-        if settings.profiling.enabled
-          if profiler
-            @logger.debug('Profiling started')
-            profiler.start
-          else
-            # Display a warning for users who expected profiling to be enabled
-            unsupported_reason = Datadog::Profiling.unsupported_reason
-            logger.warn("Profiling was requested but is not supported, profiling disabled: #{unsupported_reason}")
-          end
-        else
-          @logger.debug('Profiling is disabled')
-        end
-      end
-
-      # Shuts down all the components in use.
-      # If it has another instance to compare to, it will compare
-      # and avoid tearing down parts still in use.
-      def shutdown!(replacement = nil)
-        # Shutdown the old tracer, unless it's still being used.
-        # (e.g. a custom tracer instance passed in.)
-        tracer.shutdown! unless replacement && tracer == replacement.tracer
-
-        # Shutdown old profiler
-        profiler.shutdown! unless profiler.nil?
-
-        # Shutdown workers
-        runtime_metrics.stop(true, close_metrics: false)
-
-        # Shutdown the old metrics, unless they are still being used.
-        # (e.g. custom Statsd instances.)
-        #
-        # TODO: This violates the encapsulation created by Runtime::Metrics and
-        # Health::Metrics, by directly manipulating `statsd` and changing
-        # it's lifecycle management.
-        # If we need to directly have ownership of `statsd` lifecycle, we should
-        # have direct ownership of it.
-        old_statsd = [
-          runtime_metrics.metrics.statsd,
-          health_metrics.statsd
-        ].compact.uniq
-
-        new_statsd =  if replacement
-                        [
-                          replacement.runtime_metrics.metrics.statsd,
-                          replacement.health_metrics.statsd
-                        ].compact.uniq
-                      else
-                        []
-                      end
-
-        unused_statsd = (old_statsd - (old_statsd & new_statsd))
-        unused_statsd.each(&:close)
-      end
-    end
-  end
-end

data/lib/ddtrace/configuration/dependency_resolver.rb

@@ -1,24 +0,0 @@
-require 'tsort'
-
-module Datadog
-  module Configuration
-    # Resolver performs a topological sort over the dependency graph
-    class DependencyResolver
-      include TSort
-
-      def initialize(dependency_graph = {})
-        @dependency_graph = dependency_graph
-      end
-
-      def tsort_each_node(&blk)
-        @dependency_graph.each_key(&blk)
-      end
-
-      def tsort_each_child(node, &blk)
-        @dependency_graph.fetch(node).each(&blk)
-      end
-
-      alias call tsort
-    end
-  end
-end

data/lib/ddtrace/configuration/option.rb

@@ -1,64 +0,0 @@
-module Datadog
-  module Configuration
-    # Represents an instance of an integration configuration option
-    class Option
-      attr_reader \
-        :definition
-
-      def initialize(definition, context)
-        @definition = definition
-        @context = context
-        @value = nil
-        @is_set = false
-      end
-
-      def set(value)
-        old_value = @value
-        (@value = context_exec(value, old_value, &definition.setter)).tap do |v|
-          @is_set = true
-          context_exec(v, old_value, &definition.on_set) if definition.on_set
-        end
-      end
-
-      def get
-        if @is_set
-          @value
-        elsif definition.delegate_to
-          context_eval(&definition.delegate_to)
-        else
-          set(default_value)
-        end
-      end
-
-      def reset
-        @value = if definition.resetter
-                   # Don't change @is_set to false; custom resetters are
-                   # responsible for changing @value back to a good state.
-                   # Setting @is_set = false would cause a default to be applied.
-                   context_exec(@value, &definition.resetter)
-                 else
-                   @is_set = false
-                   nil
-                 end
-      end
-
-      def default_value
-        if definition.lazy
-          context_eval(&definition.default)
-        else
-          definition.default
-        end
-      end
-
-      private
-
-      def context_exec(*args, &block)
-        @context.instance_exec(*args, &block)
-      end
-
-      def context_eval(&block)
-        @context.instance_eval(&block)
-      end
-    end
-  end
-end

data/lib/ddtrace/configuration/option_definition.rb

@@ -1,121 +0,0 @@
-require 'ddtrace/configuration/option'
-
-module Datadog
-  module Configuration
-    # Represents a definition for an integration configuration option
-    class OptionDefinition
-      IDENTITY = ->(new_value, _old_value) { new_value }
-
-      attr_reader \
-        :default,
-        :delegate_to,
-        :depends_on,
-        :lazy,
-        :name,
-        :on_set,
-        :resetter,
-        :setter
-
-      def initialize(name, meta = {}, &block)
-        @default = meta[:default]
-        @delegate_to = meta[:delegate_to]
-        @depends_on = meta[:depends_on] || []
-        @lazy = meta[:lazy] || false
-        @name = name.to_sym
-        @on_set = meta[:on_set]
-        @resetter = meta[:resetter]
-        @setter = meta[:setter] || block || IDENTITY
-      end
-
-      # Creates a new Option, bound to the context provided.
-      def build(context)
-        Option.new(self, context)
-      end
-
-      # Acts as DSL for building OptionDefinitions
-      class Builder
-        attr_reader \
-          :helpers
-
-        def initialize(name, options = {})
-          @default = nil
-          @delegate_to = nil
-          @depends_on = []
-          @helpers = {}
-          @lazy = false
-          @name = name.to_sym
-          @on_set = nil
-          @resetter = nil
-          @setter = OptionDefinition::IDENTITY
-
-          # If options were supplied, apply them.
-          apply_options!(options)
-
-          # Apply block if given.
-          yield(self) if block_given?
-        end
-
-        def depends_on(*values)
-          @depends_on = values.flatten
-        end
-
-        def default(value = nil, &block)
-          @default = block || value
-        end
-
-        def delegate_to(&block)
-          @delegate_to = block
-        end
-
-        def helper(name, *_args, &block)
-          @helpers[name] = block
-        end
-
-        def lazy(value = true)
-          @lazy = value
-        end
-
-        def on_set(&block)
-          @on_set = block
-        end
-
-        def resetter(&block)
-          @resetter = block
-        end
-
-        def setter(&block)
-          @setter = block
-        end
-
-        # For applying options for OptionDefinition
-        def apply_options!(options = {})
-          return if options.nil? || options.empty?
-
-          default(options[:default]) if options.key?(:default)
-          delegate_to(&options[:delegate_to]) if options.key?(:delegate_to)
-          depends_on(*options[:depends_on]) if options.key?(:depends_on)
-          lazy(options[:lazy]) if options.key?(:lazy)
-          on_set(&options[:on_set]) if options.key?(:on_set)
-          resetter(&options[:resetter]) if options.key?(:resetter)
-          setter(&options[:setter]) if options.key?(:setter)
-        end
-
-        def to_definition
-          OptionDefinition.new(@name, meta)
-        end
-
-        def meta
-          {
-            default: @default,
-            delegate_to: @delegate_to,
-            depends_on: @depends_on,
-            lazy: @lazy,
-            on_set: @on_set,
-            resetter: @resetter,
-            setter: @setter
-          }
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/configuration/option_definition_set.rb

@@ -1,18 +0,0 @@
-require 'ddtrace/configuration/dependency_resolver'
-
-module Datadog
-  module Configuration
-    # Represents a set of configuration option definitions for an integration
-    class OptionDefinitionSet < Hash
-      def dependency_order
-        DependencyResolver.new(dependency_graph).call
-      end
-
-      def dependency_graph
-        each_with_object({}) do |(name, option), graph|
-          graph[name] = option.depends_on
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/configuration/option_set.rb

@@ -1,6 +0,0 @@
-module Datadog
-  module Configuration
-    class OptionSet < Hash
-    end
-  end
-end

data/lib/ddtrace/configuration/options.rb

@@ -1,111 +0,0 @@
-require 'ddtrace/configuration/option_set'
-require 'ddtrace/configuration/option_definition'
-require 'ddtrace/configuration/option_definition_set'
-
-module Datadog
-  module Configuration
-    # Behavior for a configuration object that has options
-    module Options
-      def self.included(base)
-        base.send(:extend, ClassMethods)
-        base.send(:include, InstanceMethods)
-      end
-
-      # Class behavior for a configuration object with options
-      module ClassMethods
-        def options
-          # Allows for class inheritance of option definitions
-          @options ||= superclass <= Options ? superclass.options.dup : OptionDefinitionSet.new
-        end
-
-        protected
-
-        def option(name, meta = {}, &block)
-          builder = OptionDefinition::Builder.new(name, meta, &block)
-          options[name] = builder.to_definition.tap do
-            # Resolve and define helper functions
-            helpers = default_helpers(name)
-            # Prevent unnecessary creation of an identical copy of helpers if there's nothing to merge
-            helpers = helpers.merge(builder.helpers) unless builder.helpers.empty?
-            define_helpers(helpers)
-          end
-        end
-
-        private
-
-        def default_helpers(name)
-          option_name = name.to_sym
-
-          {
-            option_name.to_sym => proc do
-              get_option(option_name)
-            end,
-            "#{option_name}=".to_sym => proc do |value|
-              set_option(option_name, value)
-            end
-          }
-        end
-
-        def define_helpers(helpers)
-          helpers.each do |name, block|
-            next unless block.is_a?(Proc)
-
-            define_method(name, &block)
-          end
-        end
-      end
-
-      # Instance behavior for a configuration object with options
-      module InstanceMethods
-        def options
-          @options ||= OptionSet.new
-        end
-
-        def set_option(name, value)
-          add_option(name) unless options.key?(name)
-          options[name].set(value)
-        end
-
-        def get_option(name)
-          add_option(name) unless options.key?(name)
-          options[name].get
-        end
-
-        def reset_option(name)
-          assert_valid_option!(name)
-          options[name].reset if options.key?(name)
-        end
-
-        def option_defined?(name)
-          self.class.options.key?(name)
-        end
-
-        def options_hash
-          self.class.options.merge(options).each_with_object({}) do |(key, _), hash|
-            hash[key] = get_option(key)
-          end
-        end
-
-        def reset_options!
-          options.values.each(&:reset)
-        end
-
-        private
-
-        def add_option(name)
-          assert_valid_option!(name)
-          definition = self.class.options[name]
-          definition.build(self).tap do |option|
-            options[name] = option
-          end
-        end
-
-        def assert_valid_option!(name)
-          raise(InvalidOptionError, "#{self.class.name} doesn't define the option: #{name}") unless option_defined?(name)
-        end
-      end
-
-      InvalidOptionError = Class.new(StandardError)
-    end
-  end
-end

data/lib/ddtrace/configuration/pin_setup.rb

@@ -1,31 +0,0 @@
-module Datadog
-  module Configuration
-    # PinSetup translates a flat hash into a Pin configuration
-    # This class should be removed if we ever remove/refactor the Pin class
-    class PinSetup
-      def initialize(target, opts = {})
-        @pin = Pin.get_from(target)
-        @opts = opts
-      end
-
-      def call
-        return unless pin
-
-        ATTRS.each { |key| pin.public_send("#{key}=", opts[key]) if opts[key] }
-
-        pin.config = opts.reject { |key, _| ATTRS.include?(key) || DEPRECATED_ATTRS.include?(key) }
-
-        true
-      end
-
-      private
-
-      attr_reader :pin, :opts
-
-      ATTRS = [:app, :tags, :app_type, :name, :service_name].freeze
-      DEPRECATED_ATTRS = [:tracer].freeze
-
-      private_constant :ATTRS
-    end
-  end
-end