ddtrace 0.44.0 → 0.49.0

data/lib/ddtrace/ext/distributed.rb

@@ -22,7 +22,7 @@ module Datadog
       PROPAGATION_STYLE_B3_SINGLE_HEADER = 'B3 single header'.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
+      # 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.

data/lib/ddtrace/ext/git.rb

@@ -4,7 +4,6 @@ module Datadog
     module Git
       TAG_BRANCH = 'git.branch'.freeze
       TAG_COMMIT_SHA = 'git.commit.sha'.freeze
-      TAG_DEPRECATED_COMMIT_SHA = 'git.commit_sha'.freeze
       TAG_REPOSITORY_URL = 'git.repository_url'.freeze
       TAG_TAG = 'git.tag'.freeze
     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/profiling.rb

@@ -0,0 +1,53 @@
+module Datadog
+  module Ext
+    module Profiling
+      ENV_ENABLED = 'DD_PROFILING_ENABLED'.freeze
+      ENV_UPLOAD_TIMEOUT = 'DD_PROFILING_UPLOAD_TIMEOUT'.freeze
+      ENV_MAX_FRAMES = 'DD_PROFILING_MAX_FRAMES'.freeze
+
+      module Pprof
+        LABEL_KEY_SPAN_ID = 'span id'.freeze
+        LABEL_KEY_THREAD_ID = 'thread id'.freeze
+        LABEL_KEY_TRACE_ID = 'trace id'.freeze
+        SAMPLE_VALUE_NO_VALUE = 0
+        VALUE_TYPE_CPU = 'cpu-time'.freeze
+        VALUE_TYPE_WALL = 'wall-time'.freeze
+        VALUE_UNIT_NANOSECONDS = 'nanoseconds'.freeze
+      end
+
+      module Transport
+        module HTTP
+          URI_TEMPLATE_DD_API = 'https://intake.profile.%s/'.freeze
+
+          FORM_FIELD_DATA = 'data[0]'.freeze
+          FORM_FIELD_FORMAT = 'format'.freeze
+          FORM_FIELD_FORMAT_PPROF = 'pprof'.freeze
+          FORM_FIELD_RECORDING_END = 'recording-end'.freeze
+          FORM_FIELD_RECORDING_START = 'recording-start'.freeze
+          FORM_FIELD_RUNTIME = 'runtime'.freeze
+          FORM_FIELD_RUNTIME_ID = 'runtime-id'.freeze
+          FORM_FIELD_TAG_ENV = 'env'.freeze
+          FORM_FIELD_TAG_HOST = 'host'.freeze
+          FORM_FIELD_TAG_LANGUAGE = 'language'.freeze
+          FORM_FIELD_TAG_PID = 'pid'.freeze
+          FORM_FIELD_TAG_PROFILER_VERSION = 'profiler_version'.freeze
+          FORM_FIELD_TAG_RUNTIME = 'runtime'.freeze
+          FORM_FIELD_TAG_RUNTIME_ENGINE = 'runtime_engine'.freeze
+          FORM_FIELD_TAG_RUNTIME_ID = 'runtime-id'.freeze
+          FORM_FIELD_TAG_RUNTIME_PLATFORM = 'runtime_platform'.freeze
+          FORM_FIELD_TAG_RUNTIME_VERSION = 'runtime_version'.freeze
+          FORM_FIELD_TAG_SERVICE = 'service'.freeze
+          FORM_FIELD_TAG_VERSION = 'version'.freeze
+          FORM_FIELD_TAGS = 'tags'.freeze
+          FORM_FIELD_TYPES = 'types[0]'.freeze
+          FORM_FIELD_TYPES_AUTO = 'auto'.freeze
+
+          HEADER_CONTENT_TYPE = 'Content-Type'.freeze
+          HEADER_CONTENT_TYPE_OCTET_STREAM = 'application/octet-stream'.freeze
+
+          PPROF_DEFAULT_FILENAME = 'profile.pb.gz'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/ext/runtime.rb

@@ -5,7 +5,9 @@ module Datadog
     module Runtime
       # Identity
       LANG = 'ruby'.freeze
-      LANG_INTERPRETER = (RUBY_ENGINE + '-' + RUBY_PLATFORM).freeze
+      LANG_ENGINE = RUBY_ENGINE
+      LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
+      LANG_PLATFORM = RUBY_PLATFORM
       LANG_VERSION = RUBY_VERSION
       RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
       TRACER_VERSION = Datadog::VERSION::STRING

data/lib/ddtrace/ext/transport.rb

@@ -4,10 +4,12 @@ module Datadog
       module HTTP
         DEFAULT_HOST = '127.0.0.1'.freeze
         DEFAULT_PORT = 8126
+        DEFAULT_TIMEOUT_SECONDS = 1
         ENV_DEFAULT_HOST = 'DD_AGENT_HOST'.freeze
         ENV_DEFAULT_PORT = 'DD_TRACE_AGENT_PORT'.freeze
         ENV_DEFAULT_URL = 'DD_TRACE_AGENT_URL'.freeze
         HEADER_CONTAINER_ID = 'Datadog-Container-ID'.freeze
+        HEADER_DD_API_KEY = 'DD-API-KEY'.freeze
         HEADER_META_LANG = 'Datadog-Meta-Lang'.freeze
         HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'.freeze
         HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'.freeze

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?
@@ -116,6 +120,10 @@ module Datadog
       metrics.each { |m| send(m.type, *[m.name, m.value, m.options].compact) }
     end
 
+    def close
+      @statsd.close if @statsd && @statsd.respond_to?(:close)
+    end
+
     Metric = Struct.new(:type, :name, :value, :options) do
       def initialize(*args)
         super
@@ -186,7 +194,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

@@ -1,7 +1,21 @@
+require 'ddtrace/utils/only_once'
+
 module Datadog
-  # Defines some useful patching methods for integrations
+  # Deprecated: This module should no longer be included. It's only being kept around for backwards compatibility
+  # concerns regarding customer usage.
   module Patcher
+    INCLUDED_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    DO_ONCE_USAGE_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     def self.included(base)
+      INCLUDED_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'Including Datadog::Patcher is deprecated. ' \
+          'For the #do_once behavior, use Datadog::Utils::OnlyOnce instead. ' \
+          'For the #without_warnings behavior, use Datadog::Patcher.without_warnings { ... } as a module function.'
+        )
+      end
+
       base.send(:extend, CommonMethods)
       base.send(:include, CommonMethods)
     end
@@ -22,11 +36,13 @@ module Datadog
       end
 
       def do_once(key = nil, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#do_once is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         # 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
@@ -36,7 +52,12 @@ module Datadog
       end
 
       def done?(key, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#done? is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         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

@@ -1,4 +1,5 @@
 require 'ddtrace/patcher'
+require 'ddtrace/utils/only_once'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
 module Datadog
@@ -7,19 +8,15 @@ module Datadog
   # This is useful if you wanted to, say, trace two different
   # database clusters.
   class Pin
+    DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     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 +39,7 @@ module Datadog
 
     def enabled?
       return tracer.enabled if tracer
+
       false
     end
 
@@ -79,59 +77,8 @@ module Datadog
       ).freeze
 
     def deprecation_warning
-      log_deprecation_warning('Datadog::Pin.new')
-    end
-
-    include Datadog::Patcher
-
-    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
-
-  # 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}")
+      DEPRECATION_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn("Datadog::Pin.new:#{DEPRECATION_WARNING}")
       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/profiling.rb

@@ -0,0 +1,105 @@
+module Datadog
+  # Contains profiler for generating stack profiles, etc.
+  module Profiling
+    module_function
+
+    GOOGLE_PROTOBUF_MINIMUM_VERSION = Gem::Version.new('3.0')
+    private_constant :GOOGLE_PROTOBUF_MINIMUM_VERSION
+
+    def supported?
+      unsupported_reason.nil?
+    end
+
+    def unsupported_reason
+      # NOTE: Only the first matching reason is returned, so try to keep a nice order on reasons -- e.g. tell users
+      # first that they can't use this on JRuby before telling them that they are missing protobuf
+
+      ruby_engine_unsupported? || ruby_version_unsupported? ||
+        protobuf_gem_unavailable? || protobuf_version_unsupported? || protobuf_failed_to_load?
+    end
+
+    def self.ruby_engine_unsupported?
+      'JRuby is not supported' if RUBY_ENGINE == 'jruby'
+    end
+    private_class_method :ruby_engine_unsupported?
+
+    def self.ruby_version_unsupported?
+      'Ruby >= 2.1 is required' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1')
+    end
+    private_class_method :ruby_version_unsupported?
+
+    def self.protobuf_gem_unavailable?
+      if Gem.loaded_specs['google-protobuf'].nil?
+        "Missing google-protobuf dependency; please add `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
+      end
+    end
+    private_class_method :protobuf_gem_unavailable?
+
+    def self.protobuf_version_unsupported?
+      if Gem.loaded_specs['google-protobuf'].version < GOOGLE_PROTOBUF_MINIMUM_VERSION
+        'Your google-protobuf is too old; ensure that you have google-protobuf >= 3.0 by ' \
+        "adding `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
+      end
+    end
+    private_class_method :protobuf_version_unsupported?
+
+    def self.protobuf_failed_to_load?
+      unless protobuf_loaded_successfully?
+        'There was an error loading the google-protobuf library; see previous warning message for details'
+      end
+    end
+    private_class_method :protobuf_failed_to_load?
+
+    # The `google-protobuf` gem depends on a native component, and its creators helpfully tried to provide precompiled
+    # versions of this extension on rubygems.org.
+    #
+    # Unfortunately, for a long time, the supported Ruby versions metadata on these precompiled versions of the extension
+    # was not correctly set. (This is fixed in newer versions -- but not all Ruby versions we want to support can use
+    # these.)
+    #
+    # Thus, the gem can still be installed, but can be in a broken state. To avoid breaking customer applications, we
+    # use this helper to load it and gracefully handle failures.
+    def self.protobuf_loaded_successfully?
+      return @protobuf_loaded if defined?(@protobuf_loaded)
+
+      begin
+        require 'google/protobuf'
+        @protobuf_loaded = true
+      rescue LoadError => e
+        Kernel.warn(
+          "[DDTRACE] Error while loading google-protobuf gem. Cause: '#{e.message}' Location: '#{e.backtrace.first}'. " \
+          'This can happen when google-protobuf is missing its native components. ' \
+          'To fix this, try removing and reinstalling the gem, forcing it to recompile the components: ' \
+          '`gem uninstall google-protobuf -a; BUNDLE_FORCE_RUBY_PLATFORM=true bundle install`. ' \
+          'If the error persists, please contact support via <https://docs.datadoghq.com/help/> or ' \
+          'file a bug at <https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug>.'
+        )
+        @protobuf_loaded = false
+      end
+    end
+    private_class_method :protobuf_loaded_successfully?
+
+    def self.load_profiling
+      return false unless supported?
+
+      require 'ddtrace/profiling/ext/cpu'
+      require 'ddtrace/profiling/ext/forking'
+
+      require 'ddtrace/profiling/collectors/stack'
+      require 'ddtrace/profiling/exporter'
+      require 'ddtrace/profiling/recorder'
+      require 'ddtrace/profiling/scheduler'
+      require 'ddtrace/profiling/tasks/setup'
+      require 'ddtrace/profiling/transport/io'
+      require 'ddtrace/profiling/transport/http'
+      require 'ddtrace/profiling/profiler'
+
+      require 'ddtrace/profiling/pprof/pprof_pb'
+
+      true
+    end
+    private_class_method :load_profiling
+
+    load_profiling if supported?
+  end
+end