ddtrace 0.41.0 → 0.46.0

data/lib/ddtrace/ext/distributed.rb

@@ -20,8 +20,14 @@ module Datadog
       PROPAGATION_STYLE_DATADOG = 'Datadog'.freeze
       PROPAGATION_STYLE_B3 = 'B3'.freeze
       PROPAGATION_STYLE_B3_SINGLE_HEADER = 'B3 single header'.freeze
-      PROPAGATION_INJECT_STYLE_ENV = 'DD_PROPAGATION_INJECT_STYLE'.freeze
-      PROPAGATION_EXTRACT_STYLE_ENV = 'DD_PROPAGATION_EXTRACT_STYLE'.freeze
+      PROPAGATION_STYLE_INJECT_ENV = 'DD_PROPAGATION_STYLE_INJECT'.freeze
+      PROPAGATION_STYLE_EXTRACT_ENV = 'DD_PROPAGATION_STYLE_EXTRACT'.freeze
+      # NOTE: the below inject/extract values are deprecated and were defined erronously
+      # they were never part of the datadog language client standard or documentation
+      # some users may already be relying on them, but we should look to remove these in the future
+      # or before 1.0.
+      PROPAGATION_INJECT_STYLE_ENV_OLD = 'DD_PROPAGATION_INJECT_STYLE'.freeze
+      PROPAGATION_EXTRACT_STYLE_ENV_OLD = 'DD_PROPAGATION_EXTRACT_STYLE'.freeze
 
       # gRPC metadata keys for distributed tracing. https://github.com/grpc/grpc-go/blob/v1.10.x/Documentation/grpc-metadata.md
       GRPC_METADATA_TRACE_ID = 'x-datadog-trace-id'.freeze

data/lib/ddtrace/ext/git.rb

@@ -0,0 +1,11 @@
+module Datadog
+  module Ext
+    # Defines constants for Git tags
+    module Git
+      TAG_BRANCH = 'git.branch'.freeze
+      TAG_COMMIT_SHA = 'git.commit.sha'.freeze
+      TAG_REPOSITORY_URL = 'git.repository_url'.freeze
+      TAG_TAG = 'git.tag'.freeze
+    end
+  end
+end

data/lib/ddtrace/ext/http.rb

@@ -2,7 +2,7 @@ module Datadog
   module Ext
     module HTTP
       BASE_URL = 'http.base_url'.freeze
-      ERROR_RANGE = 500...600
+      ERROR_RANGE = (500...600).freeze
       METHOD = 'http.method'.freeze
       STATUS_CODE = 'http.status_code'.freeze
       TEMPLATE = 'template'.freeze

data/lib/ddtrace/ext/runtime.rb

@@ -5,11 +5,12 @@ module Datadog
     module Runtime
       # Identity
       LANG = 'ruby'.freeze
-      LANG_INTERPRETER = (RUBY_ENGINE + '-' + RUBY_PLATFORM).freeze
+      LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
       LANG_VERSION = RUBY_VERSION
       RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
       TRACER_VERSION = Datadog::VERSION::STRING
 
+      TAG_ID = 'runtime-id'.freeze
       TAG_LANG = 'language'.freeze
 
       # Metrics

data/lib/ddtrace/ext/test.rb

@@ -0,0 +1,24 @@
+module Datadog
+  module Ext
+    # Defines constants for test tags
+    module Test
+      TAG_ARGUMENTS = 'test.arguments'.freeze
+      TAG_FRAMEWORK = 'test.framework'.freeze
+      TAG_NAME = 'test.name'.freeze
+      TAG_SKIP_REASON = 'test.skip_reason'.freeze
+      TAG_STATUS = 'test.status'.freeze
+      TAG_SUITE = 'test.suite'.freeze
+      TAG_TRAITS = 'test.traits'.freeze
+      TAG_TYPE = 'test.type'.freeze
+
+      # TODO: is there a better place for SPAN_KIND?
+      TAG_SPAN_KIND = 'span.kind'.freeze
+
+      module Status
+        PASS = 'pass'.freeze
+        FAIL = 'fail'.freeze
+        SKIP = 'skip'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/forced_tracing.rb

@@ -7,11 +7,13 @@ module Datadog
     class << self
       def keep(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_KEEP
       end
 
       def drop(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_REJECT
       end
     end

data/lib/ddtrace/logger.rb

@@ -23,7 +23,7 @@ module Datadog
       end
 
       if message.nil?
-        if block_given?
+        if block
           super(severity, message, progname) do
             "[#{self.progname}] #{where}#{yield}"
           end

data/lib/ddtrace/metrics.rb

@@ -41,7 +41,7 @@ module Datadog
     end
 
     def default_statsd_client
-      require 'datadog/statsd' unless defined?(::Datadog::Statsd)
+      require 'datadog/statsd'
 
       # Create a StatsD client that points to the agent.
       Datadog::Statsd.new(default_hostname, default_port)
@@ -58,7 +58,8 @@ module Datadog
 
     def count(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:count)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.count(stat, value, metric_options(options))
@@ -68,7 +69,8 @@ module Datadog
 
     def distribution(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:distribution)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.distribution(stat, value, metric_options(options))
@@ -78,6 +80,7 @@ module Datadog
 
     def increment(stat, options = nil)
       return unless send_stats? && statsd.respond_to?(:increment)
+
       options = yield if block_given?
 
       statsd.increment(stat, metric_options(options))
@@ -87,7 +90,8 @@ module Datadog
 
     def gauge(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:gauge)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.gauge(stat, value, metric_options(options))
@@ -100,7 +104,7 @@ module Datadog
 
       # Calculate time, send it as a distribution.
       start = Utils::Time.get_time
-      return yield
+      yield
     ensure
       begin
         if send_stats? && !start.nil?
@@ -186,7 +190,7 @@ module Datadog
         attr_accessor :logger
 
         def initialize(logger = nil)
-          @logger = logger || Logger.new(STDOUT).tap do |l|
+          @logger = logger || Logger.new($stdout).tap do |l|
             l.level = Logger::INFO
             l.progname = nil
             l.formatter = proc do |_severity, datetime, _progname, msg|

data/lib/ddtrace/opentracer/distributed_headers.rb

@@ -29,8 +29,10 @@ module Datadog
         # It's important to make a difference between no header,
         # and a header defined to zero.
         return unless hdr
+
         value = hdr.to_i
         return if value < 0
+
         value
       end
 
@@ -45,6 +47,7 @@ module Datadog
       def id(header)
         value = @carrier[header].to_i
         return if value.zero? || value >= Datadog::Span::EXTERNAL_MAX_ID
+
         value < 0 ? value + 0x1_0000_0000_0000_0000 : value
       end
     end

data/lib/ddtrace/opentracer/span.rb

@@ -73,9 +73,7 @@ module Datadog
         super # Log deprecation warning
 
         # If the fields specify an error
-        if fields.key?(:'error.object')
-          datadog_span.set_error(fields[:'error.object'])
-        end
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
       end
 
       # Add a log entry to this span
@@ -83,9 +81,7 @@ module Datadog
       # @param fields [Hash] Additional information to log
       def log_kv(timestamp: Time.now, **fields)
         # If the fields specify an error
-        if fields.key?(:'error.object')
-          datadog_span.set_error(fields[:'error.object'])
-        end
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
       end
 
       # Finish the {Span}

data/lib/ddtrace/opentracer/thread_local_scope.rb

@@ -22,6 +22,7 @@ module Datadog
       # undefined behavior.
       def close
         return unless equal?(manager.active)
+
         span.finish if finish_on_close
         manager.send(:set_scope, @previous_scope)
       end

data/lib/ddtrace/patcher.rb

@@ -24,9 +24,7 @@ module Datadog
       def do_once(key = nil, options = {})
         # If already done, don't do again
         @done_once ||= Hash.new { |h, k| h[k] = {} }
-        if @done_once.key?(key) && @done_once[key].key?(options[:for])
-          return @done_once[key][options[:for]]
-        end
+        return @done_once[key][options[:for]] if @done_once.key?(key) && @done_once[key].key?(options[:for])
 
         # Otherwise 'do'
         yield.tap do
@@ -37,6 +35,7 @@ module Datadog
 
       def done?(key, options = {})
         return false unless instance_variable_defined?(:@done_once)
+
         !@done_once.nil? && @done_once.key?(key) && @done_once[key].key?(options[:for])
       end
     end

data/lib/ddtrace/pin.rb

@@ -9,17 +9,11 @@ module Datadog
   class Pin
     def self.get_from(obj)
       return nil unless obj.respond_to? :datadog_pin
+
       obj.datadog_pin
     end
 
-    attr_accessor :app
-    attr_accessor :app_type
-    attr_accessor :config
-    attr_accessor :name
-    attr_accessor :service_name
-    attr_accessor :tags
-    attr_reader :tracer
-    attr_accessor :writer
+    attr_accessor :app, :app_type, :config, :name, :service_name, :tags, :writer
 
     alias service= service_name=
     alias service service_name
@@ -42,6 +36,7 @@ module Datadog
 
     def enabled?
       return tracer.enabled if tracer
+
       false
     end
 
@@ -91,48 +86,4 @@ module Datadog
       end
     end
   end
-
-  # Modification to Pin which logs deprecation warnings if accessed.
-  # Will be used by integrations which are phasing out the direct use of #datadog_pin.
-  module DeprecatedPin
-    include Datadog::Patcher
-
-    DEPRECATION_WARNING = %(
-      Use of Datadog::Pin is DEPRECATED.
-      Upgrade to the configuration API using the migration guide here:
-      https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
-
-    # Raise a deprecation warning when #datadog_pin or #datadog_pin= is accessed.
-    def onto(obj)
-      obj.instance_exec(self) do |pin|
-        @datadog_deprecated_pin = pin
-
-        unless respond_to? :datadog_pin=
-          def datadog_pin=(pin)
-            @datadog_deprecated_pin.log_deprecation_warning('#datadog_pin=')
-            @datadog_pin = pin
-          end
-        end
-
-        unless respond_to? :datadog_pin
-          def datadog_pin
-            @datadog_deprecated_pin.log_deprecation_warning('#datadog_pin')
-            @datadog_pin
-          end
-        end
-
-        # Set instance variable to avoid deprecation warnings
-        @datadog_pin = @datadog_deprecated_pin
-      end
-
-      self
-    end
-
-    def log_deprecation_warning(method_name)
-      # Only log each deprecation warning once (safeguard against log spam)
-      do_once(method_name) do
-        Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}")
-      end
-    end
-  end
 end

data/lib/ddtrace/pipeline/span_filter.rb

@@ -10,7 +10,7 @@ module Datadog
         @criteria = filter || block
       end
 
-      # Note: this SpanFilter implementation only handles traces in which child spans appear
+      # NOTE: this SpanFilter implementation only handles traces in which child spans appear
       # after parent spans in the trace array. If in the future child spans can be before
       # parent spans, then the code below will need to be updated.
       def call(trace)

data/lib/ddtrace/propagation/grpc_propagator.rb

@@ -19,6 +19,7 @@ module Datadog
     def self.extract(metadata)
       metadata = Carrier.new(metadata)
       return Datadog::Context.new unless metadata.valid?
+
       Datadog::Context.new(trace_id: metadata.trace_id,
                            span_id: metadata.parent_id,
                            sampling_priority: metadata.sampling_priority,
@@ -38,24 +39,36 @@ module Datadog
       end
 
       def trace_id
-        value = @metadata[GRPC_METADATA_TRACE_ID].to_i
+        value = metadata_for_key(GRPC_METADATA_TRACE_ID).to_i
         value if (1..Span::EXTERNAL_MAX_ID).cover? value
       end
 
       def parent_id
-        value = @metadata[GRPC_METADATA_PARENT_ID].to_i
+        value = metadata_for_key(GRPC_METADATA_PARENT_ID).to_i
         value if (1..Span::EXTERNAL_MAX_ID).cover? value
       end
 
       def sampling_priority
-        value = @metadata[GRPC_METADATA_SAMPLING_PRIORITY]
+        value = metadata_for_key(GRPC_METADATA_SAMPLING_PRIORITY)
         value && value.to_i
       end
 
       def origin
-        value = @metadata[GRPC_METADATA_ORIGIN]
+        value = metadata_for_key(GRPC_METADATA_ORIGIN)
         value if value != ''
       end
+
+      private
+
+      def metadata_for_key(key)
+        # metadata values can be arrays (multiple headers with the same key)
+        value = @metadata[key]
+        if value.is_a?(Array)
+          value.first
+        else
+          value
+        end
+      end
     end
   end
 end

data/lib/ddtrace/propagation/http_propagator.rb

@@ -26,7 +26,14 @@ module Datadog
       # Inject all configured propagation styles
       ::Datadog.configuration.distributed_tracing.propagation_inject_style.each do |style|
         propagator = PROPAGATION_STYLES[style]
-        propagator.inject!(context, env) unless propagator.nil?
+        begin
+          propagator.inject!(context, env) unless propagator.nil?
+        rescue => e
+          Datadog.logger.error(
+            'Error injecting propagated context into the environment. ' \
+            "Cause: #{e} Location: #{e.backtrace.first}"
+          )
+        end
       end
     end
 
@@ -42,7 +49,15 @@ module Datadog
 
         # Extract context
         # DEV: `propagator.extract` will return `nil`, where `HTTPPropagator#extract` will not
-        extracted_context = propagator.extract(env)
+        begin
+          extracted_context = propagator.extract(env)
+        rescue => e
+          Datadog.logger.error(
+            'Error extracting propagated context from the environment. ' \
+            "Cause: #{e} Location: #{e.backtrace.first}"
+          )
+        end
+
         # Skip this style if no valid headers were found
         next if extracted_context.nil?
 

data/lib/ddtrace/quantization/http.rb

@@ -61,6 +61,7 @@ module Datadog
       # e.g. Reduces "foo&bar=bar&bar=bar&foo" to "foo&bar=bar&bar=bar"
       def collect_query(query, options = {})
         return query unless block_given?
+
         uniq = options[:uniq].nil? ? false : options[:uniq]
         keys = Set.new
 

data/lib/ddtrace/runtime/cgroup.rb

@@ -4,7 +4,7 @@ module Datadog
   module Runtime
     # For control groups
     module Cgroup
-      LINE_REGEX = /^(\d+):([^:]*):(.+)$/
+      LINE_REGEX = /^(\d+):([^:]*):(.+)$/.freeze
 
       Descriptor = Struct.new(
         :id,

data/lib/ddtrace/runtime/container.rb

@@ -8,8 +8,8 @@ module Datadog
       UUID_PATTERN = '[0-9a-f]{8}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{12}'.freeze
       CONTAINER_PATTERN = '[0-9a-f]{64}'.freeze
 
-      POD_REGEX = /(pod)?(#{UUID_PATTERN})(?:.slice)?$/
-      CONTAINER_REGEX = /(#{UUID_PATTERN}|#{CONTAINER_PATTERN})(?:.scope)?$/
+      POD_REGEX = /(pod)?(#{UUID_PATTERN})(?:.slice)?$/.freeze
+      CONTAINER_REGEX = /(#{UUID_PATTERN}|#{CONTAINER_PATTERN})(?:.scope)?$/.freeze
 
       Descriptor = Struct.new(
         :platform,

data/lib/ddtrace/runtime/identity.rb

@@ -1,22 +1,21 @@
 require 'securerandom'
 require 'ddtrace/ext/runtime'
+require 'ddtrace/utils/forking'
 
 module Datadog
   module Runtime
     # For runtime identity
     module Identity
+      extend Datadog::Utils::Forking
+
       module_function
 
       # Retrieves number of classes from runtime
       def id
-        @pid ||= Process.pid
         @id ||= SecureRandom.uuid
 
         # Check if runtime has changed, e.g. forked.
-        if Process.pid != @pid
-          @pid = Process.pid
-          @id = SecureRandom.uuid
-        end
+        after_fork! { @id = SecureRandom.uuid }
 
         @id
       end