ls-trace 0.1.2 → 0.2.0

data/lib/ddtrace.rb

@@ -26,8 +26,18 @@ module Datadog
   # Load and extend Contrib by default
   require 'ddtrace/contrib/extensions'
   extend Contrib::Extensions
+
+  # Load and extend OpenTelemetry compatibility by default
+  require 'ddtrace/opentelemetry/extensions'
+  extend OpenTelemetry::Extensions
+
+  # Add shutdown hook:
+  # Ensures the tracer has an opportunity to flush traces
+  # and cleanup before terminating the process.
+  at_exit { Datadog.shutdown! }
 end
 
+require 'ddtrace/contrib/action_cable/integration'
 require 'ddtrace/contrib/action_pack/integration'
 require 'ddtrace/contrib/action_view/integration'
 require 'ddtrace/contrib/active_model_serializers/integration'
@@ -45,7 +55,11 @@ require 'ddtrace/contrib/grape/integration'
 require 'ddtrace/contrib/graphql/integration'
 require 'ddtrace/contrib/grpc/integration'
 require 'ddtrace/contrib/http/integration'
+require 'ddtrace/contrib/httprb/integration'
 require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/kafka/integration'
+require 'ddtrace/contrib/presto/integration'
+require 'ddtrace/contrib/que/integration'
 require 'ddtrace/contrib/mysql2/integration'
 require 'ddtrace/contrib/mongodb/integration'
 require 'ddtrace/contrib/racecar/integration'
@@ -59,5 +73,6 @@ require 'ddtrace/contrib/sequel/integration'
 require 'ddtrace/contrib/shoryuken/integration'
 require 'ddtrace/contrib/sidekiq/integration'
 require 'ddtrace/contrib/sinatra/integration'
+require 'ddtrace/contrib/sneakers/integration'
 require 'ddtrace/contrib/sucker_punch/integration'
 require 'ddtrace/monkey'

data/lib/ddtrace/analytics.rb

@@ -8,6 +8,13 @@ module Datadog
         return if span.nil? || !sample_rate.is_a?(Numeric)
         span.set_metric(Datadog::Ext::Analytics::TAG_SAMPLE_RATE, sample_rate)
       end
+
+      def set_measured(span, value = true)
+        return if span.nil?
+        # rubocop:disable Style/MultipleComparison
+        value = value == true || value == 1 ? 1 : 0
+        span.set_metric(Datadog::Ext::Analytics::TAG_MEASURED, value)
+      end
     end
 
     # Extension for Datadog::Span

data/lib/ddtrace/buffer.rb

@@ -83,7 +83,7 @@ module Datadog
       @buffer_accepted += 1
       @buffer_accepted_lengths += trace.length
     rescue StandardError => e
-      Datadog::Tracer.log.debug("Failed to measure queue accept. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.debug("Failed to measure queue accept. Cause: #{e.message} Source: #{e.backtrace.first}")
     end
 
     def measure_drop(trace)
@@ -91,21 +91,21 @@ module Datadog
       @buffer_spans -= trace.length
       @buffer_accepted_lengths -= trace.length
     rescue StandardError => e
-      Datadog::Tracer.log.debug("Failed to measure queue drop. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.debug("Failed to measure queue drop. Cause: #{e.message} Source: #{e.backtrace.first}")
     end
 
     def measure_pop(traces)
       # Accepted
-      Diagnostics::Health.metrics.queue_accepted(@buffer_accepted)
-      Diagnostics::Health.metrics.queue_accepted_lengths(@buffer_accepted_lengths)
+      Datadog.health_metrics.queue_accepted(@buffer_accepted)
+      Datadog.health_metrics.queue_accepted_lengths(@buffer_accepted_lengths)
 
       # Dropped
-      Diagnostics::Health.metrics.queue_dropped(@buffer_dropped)
+      Datadog.health_metrics.queue_dropped(@buffer_dropped)
 
       # Queue gauges
-      Diagnostics::Health.metrics.queue_max_length(@max_size)
-      Diagnostics::Health.metrics.queue_spans(@buffer_spans)
-      Diagnostics::Health.metrics.queue_length(traces.length)
+      Datadog.health_metrics.queue_max_length(@max_size)
+      Datadog.health_metrics.queue_spans(@buffer_spans)
+      Datadog.health_metrics.queue_length(traces.length)
 
       # Reset aggregated metrics
       @buffer_accepted = 0
@@ -113,7 +113,7 @@ module Datadog
       @buffer_dropped = 0
       @buffer_spans = 0
     rescue StandardError => e
-      Datadog::Tracer.log.debug("Failed to measure queue. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.debug("Failed to measure queue. Cause: #{e.message} Source: #{e.backtrace.first}")
     end
   end
 end

data/lib/ddtrace/chunker.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'msgpack'
+
+module Datadog
+  # Chunks list of elements into batches
+  module Chunker
+    module_function
+
+    # Chunks a list into batches of at most +max_chunk_size+ elements each.
+    #
+    # An exception can occur if a single element is too large. That single
+    # element will be returned in its own chunk. You have to verify by yourself
+    # when such elements are returned.
+    #
+    # @param list [Enumerable] list of elements
+    # @param max_chunk_size [Numeric] maximum acceptable chunk size
+    # @return [Enumerable] lazy list of chunks
+    def chunk_by_size(list, max_chunk_size)
+      chunk_agg = 0
+      list.slice_before do |elem|
+        size = elem.size
+        chunk_agg += size
+        if chunk_agg > max_chunk_size
+          # Can't fit element in current chunk, start a new one.
+          chunk_agg = size
+          true
+        else
+          # Add to current chunk
+          false
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/configuration.rb

@@ -1,9 +1,14 @@
+require 'forwardable'
+
 require 'ddtrace/configuration/pin_setup'
 require 'ddtrace/configuration/settings'
+require 'ddtrace/configuration/components'
 
 module Datadog
   # Configuration provides a unique access point for configurations
   module Configuration
+    extend Forwardable
+
     attr_writer :configuration
 
     def configuration
@@ -13,18 +18,67 @@ module Datadog
     def configure(target = configuration, opts = {})
       if target.is_a?(Settings)
         yield(target) if block_given?
+
+        # Build immutable components from settings
+        @components ||= nil
+        @components = if @components
+                        replace_components!(target, @components)
+                      else
+                        build_components(target)
+                      end
+
+        target
       else
         PinSetup.new(target, opts).call
       end
     end
 
-    # Helper methods
-    def tracer
-      configuration.tracer
+    def_delegators \
+      :components,
+      :health_metrics,
+      :runtime_metrics,
+      :tracer
+
+    def logger
+      if instance_variable_defined?(:@components) && @components
+        @temp_logger = nil
+        components.logger
+      else
+        # Use default logger without initializing components.
+        # This prevents recursive loops while initializing.
+        # e.g. Get logger --> Build components --> Log message --> Repeat...
+        @temp_logger ||= begin
+          logger = configuration.logger.instance || Datadog::Logger.new(STDOUT)
+          logger.level = configuration.diagnostics.debug ? ::Logger::DEBUG : configuration.logger.level
+          logger
+        end
+      end
+    end
+
+    def shutdown!
+      components.shutdown! if instance_variable_defined?(:@components) && @components
+    end
+
+    protected
+
+    def components
+      @components ||= build_components(configuration)
+    end
+
+    private
+
+    def build_components(settings)
+      components = Components.new(settings)
+      components.startup!(settings)
+      components
     end
 
-    def runtime_metrics
-      tracer.writer.runtime_metrics
+    def replace_components!(settings, old)
+      components = Components.new(settings)
+
+      old.shutdown!(components)
+      components.startup!(settings)
+      components
     end
   end
 end

data/lib/ddtrace/configuration/base.rb

@@ -7,6 +7,7 @@ module Datadog
     module Base
       def self.included(base)
         base.send(:extend, Datadog::Environment::Helpers)
+        base.send(:include, Datadog::Environment::Helpers)
         base.send(:include, Options)
 
         base.send(:extend, ClassMethods)
@@ -23,7 +24,8 @@ module Datadog
           settings_class = new_settings_class(&block)
 
           option(name) do |o|
-            o.default settings_class.new
+            o.default { settings_class.new }
+            o.lazy
             o.resetter do |value|
               value.reset! if value.respond_to?(:reset!)
               value
@@ -43,7 +45,7 @@ module Datadog
       # Instance methods for configuration
       module InstanceMethods
         def initialize(options = {})
-          configure(options)
+          configure(options) unless options.empty?
         end
 
         def configure(opts = {})

data/lib/ddtrace/configuration/components.rb

@@ -0,0 +1,151 @@
+require 'ddtrace/diagnostics/health'
+require 'ddtrace/logger'
+require 'ddtrace/runtime/metrics'
+require 'ddtrace/tracer'
+require 'ddtrace/workers/runtime_metrics'
+
+module Datadog
+  module Configuration
+    # Global components for the trace library.
+    # rubocop:disable Metrics/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)
+          # 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(build_tracer_options(settings))
+
+          tracer
+        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[:hostname] = settings.hostname unless settings.hostname.nil?
+            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[:port] = settings.port unless settings.port.nil?
+            opts[:priority_sampling] = settings.priority_sampling unless settings.priority_sampling.nil?
+            opts[:sampler] = settings.sampler unless settings.sampler.nil?
+            opts[:transport_options] = settings.transport_options
+            opts[:writer] = settings.writer unless settings.writer.nil?
+            opts[:writer_options] = settings.writer_options if settings.writer.nil?
+          end
+        end
+      end
+
+      attr_reader \
+        :health_metrics,
+        :logger,
+        :runtime_metrics,
+        :tracer
+
+      def initialize(settings)
+        # Logger
+        @logger = self.class.build_logger(settings)
+
+        # Tracer
+        @tracer = self.class.build_tracer(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); 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 workers
+        runtime_metrics.enabled = false
+        runtime_metrics.stop(true)
+
+        # Shutdown the old metrics, unless they are still being used.
+        # (e.g. custom Statsd instances.)
+        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/option.rb

@@ -13,9 +13,10 @@ module Datadog
       end
 
       def set(value)
-        (@value = context_exec(value, &definition.setter)).tap do |v|
+        old_value = @value
+        (@value = context_exec(value, old_value, &definition.setter)).tap do |v|
           @is_set = true
-          context_exec(v, &definition.on_set) if definition.on_set
+          context_exec(v, old_value, &definition.on_set) if definition.on_set
         end
       end
 
@@ -25,7 +26,7 @@ module Datadog
         elsif definition.delegate_to
           context_eval(&definition.delegate_to)
         else
-          set(definition.default_value)
+          set(default_value)
         end
       end
 
@@ -41,6 +42,14 @@ module Datadog
                  end
       end
 
+      def default_value
+        if definition.lazy
+          context_eval(&definition.default)
+        else
+          definition.default
+        end
+      end
+
       private
 
       def context_exec(*args, &block)

data/lib/ddtrace/configuration/option_definition.rb

@@ -4,7 +4,7 @@ module Datadog
   module Configuration
     # Represents a definition for an integration configuration option
     class OptionDefinition
-      IDENTITY = ->(x) { x }
+      IDENTITY = ->(new_value, _old_value) { new_value }
 
       attr_reader \
         :default,
@@ -27,10 +27,6 @@ module Datadog
         @setter = meta[:setter] || block || IDENTITY
       end
 
-      def default_value
-        lazy ? @default.call : @default
-      end
-
       # Creates a new Option, bound to the context provided.
       def build(context)
         Option.new(self, context)