ddtrace 0.50.0 → 0.52.0

data/lib/ddtrace/correlation.rb

@@ -1,5 +1,6 @@
+# typed: false
 require 'ddtrace/ext/correlation'
-require 'ddtrace/environment'
+require 'datadog/core/environment/variable_helpers'
 
 module Datadog
   # Contains behavior for managing correlations with tracing

data/lib/ddtrace/diagnostics/environment_logger.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'date'
 require 'json'
 require 'rbconfig'
@@ -22,7 +23,7 @@ module Datadog
           log_environment!(data.to_json)
           log_error!('Agent Error'.freeze, data[:agent_error]) if data[:agent_error]
         rescue => e
-          Datadog.logger.warn("Failed to collect environment information: #{e} location: #{e.backtrace.first}")
+          Datadog.logger.warn("Failed to collect environment information: #{e} Location: #{Array(e.backtrace).first}")
         end
 
         private
@@ -73,14 +74,14 @@ module Datadog
 
       # @return [String] "ruby"
       def lang
-        Ext::Runtime::LANG
+        Core::Environment::Ext::LANG
       end
 
       # Supported Ruby language version.
       # Will be distinct from VM version for non-MRI environments.
       # @return [String]
       def lang_version
-        Ext::Runtime::LANG_VERSION
+        Core::Environment::Ext::LANG_VERSION
       end
 
       # @return [String] configured application environment

data/lib/ddtrace/diagnostics/health.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace/ext/diagnostics'
 require 'ddtrace/metrics'
 

data/lib/ddtrace/distributed_tracing/headers/b3.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/distributed'
 require 'ddtrace/distributed_tracing/headers/headers'
 require 'ddtrace/distributed_tracing/headers/helpers'

data/lib/ddtrace/distributed_tracing/headers/b3_single.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/distributed'
 require 'ddtrace/distributed_tracing/headers/headers'
 require 'ddtrace/distributed_tracing/headers/helpers'

data/lib/ddtrace/distributed_tracing/headers/datadog.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/distributed'
 require 'ddtrace/distributed_tracing/headers/headers'
 

data/lib/ddtrace/distributed_tracing/headers/headers.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/configuration'
 require 'ddtrace/span'
 require 'ddtrace/ext/distributed'

data/lib/ddtrace/distributed_tracing/headers/helpers.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/configuration'
 require 'ddtrace/span'
 require 'ddtrace/ext/priority'

data/lib/ddtrace/encoding.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'json'
 require 'msgpack'
 
@@ -6,6 +7,8 @@ module Datadog
   module Encoding
     # Encoder interface that provides the logic to encode traces and service
     module Encoder
+      include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
       def content_type
         raise NotImplementedError
       end

data/lib/ddtrace/error.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 # Datadog global namespace

data/lib/ddtrace/event.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/logger'
 
 module Datadog

data/lib/ddtrace/ext/analytics.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     # Defines constants for trace analytics

data/lib/ddtrace/ext/app_types.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module AppTypes

data/lib/ddtrace/ext/correlation.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Correlation

data/lib/ddtrace/ext/diagnostics.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Diagnostics

data/lib/ddtrace/ext/distributed.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module DistributedTracing

data/lib/ddtrace/ext/environment.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Environment
@@ -8,6 +9,13 @@ module Datadog
       ENV_TAGS = 'DD_TAGS'.freeze
       ENV_VERSION = 'DD_VERSION'.freeze
 
+      FALLBACK_SERVICE_NAME =
+        begin
+          File.basename($PROGRAM_NAME, '.*')
+        rescue StandardError
+          'ruby'
+        end.freeze
+
       TAG_ENV = 'env'.freeze
       TAG_SERVICE = 'service'.freeze
       TAG_VERSION = 'version'.freeze

data/lib/ddtrace/ext/errors.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Errors

data/lib/ddtrace/ext/forced_tracing.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/manual_tracing'
 require 'ddtrace/tracer'
 

data/lib/ddtrace/ext/git.rb

@@ -1,11 +1,20 @@
+# typed: true
 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
+
+      TAG_COMMIT_AUTHOR_DATE = 'git.commit.author.date'.freeze
+      TAG_COMMIT_AUTHOR_EMAIL = 'git.commit.author.email'.freeze
+      TAG_COMMIT_AUTHOR_NAME = 'git.commit.author.name'.freeze
+      TAG_COMMIT_COMMITTER_DATE = 'git.commit.committer.date'.freeze
+      TAG_COMMIT_COMMITTER_EMAIL = 'git.commit.committer.email'.freeze
+      TAG_COMMIT_COMMITTER_NAME = 'git.commit.committer.name'.freeze
+      TAG_COMMIT_MESSAGE = 'git.commit.message'.freeze
+      TAG_COMMIT_SHA = 'git.commit.sha'.freeze
     end
   end
 end

data/lib/ddtrace/ext/http.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module HTTP

data/lib/ddtrace/ext/integration.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Integration

data/lib/ddtrace/ext/manual_tracing.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     # Defines constants for manual tracing

data/lib/ddtrace/ext/metrics.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Metrics

data/lib/ddtrace/ext/net.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module NET

data/lib/ddtrace/ext/priority.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Datadog
   module Ext
     # Priority is a hint given to the backend so that it knows which traces to reject or kept.

data/lib/ddtrace/ext/profiling.rb

@@ -1,14 +1,17 @@
+# typed: true
 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
+      ENV_AGENTLESS = 'DD_PROFILING_AGENTLESS'.freeze
 
       module Pprof
         LABEL_KEY_SPAN_ID = 'span id'.freeze
         LABEL_KEY_THREAD_ID = 'thread id'.freeze
         LABEL_KEY_TRACE_ID = 'trace id'.freeze
+        LABEL_KEY_TRACE_ENDPOINT = 'trace endpoint'.freeze
         SAMPLE_VALUE_NO_VALUE = 0
         VALUE_TYPE_CPU = 'cpu-time'.freeze
         VALUE_TYPE_WALL = 'wall-time'.freeze

data/lib/ddtrace/ext/runtime.rb

@@ -1,17 +1,9 @@
+# typed: true
 require 'ddtrace/version'
 
 module Datadog
   module Ext
     module Runtime
-      # Identity
-      LANG = 'ruby'.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
-
       TAG_ID = 'runtime-id'.freeze
       TAG_LANG = 'language'.freeze
 

data/lib/ddtrace/ext/sampling.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Sampling

data/lib/ddtrace/ext/sql.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module SQL

data/lib/ddtrace/ext/test.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     # Defines constants for test behavior

data/lib/ddtrace/ext/transport.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Transport

data/lib/ddtrace/forced_tracing.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/manual_tracing'
 require 'ddtrace/ext/priority'
 

data/lib/ddtrace/logger.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'logger'
 
 module Datadog

data/lib/ddtrace/metrics.rb

@@ -1,9 +1,10 @@
+# typed: false
 require 'ddtrace/ext/metrics'
 
 require 'set'
 require 'logger'
-require 'ddtrace/environment'
-require 'ddtrace/runtime/identity'
+require 'datadog/core/environment/identity'
+require 'ddtrace/ext/environment'
 require 'ddtrace/utils/only_once'
 require 'ddtrace/utils/time'
 
@@ -13,22 +14,24 @@ module Datadog
   class Metrics
     attr_reader :statsd
 
-    def initialize(options = {})
-      @statsd = options.fetch(:statsd) { default_statsd_client if supported? }
-      @enabled = options.fetch(:enabled, true)
+    def initialize(statsd: nil, enabled: true, **_)
+      @statsd =
+        if supported?
+          statsd || default_statsd_client
+        else
+          ignored_statsd_warning if statsd
+          nil
+        end
+      @enabled = enabled
     end
 
     def supported?
-      version = (
-          defined?(Datadog::Statsd::VERSION) &&
-          Datadog::Statsd::VERSION &&
-          Gem::Version.new(Datadog::Statsd::VERSION)
-        ) || (
-          Gem.loaded_specs['dogstatsd-ruby'] &&
-          Gem.loaded_specs['dogstatsd-ruby'].version
-        )
+      version = dogstatsd_version
 
-      !version.nil? && (version >= Gem::Version.new('3.3.0'))
+      !version.nil? && version >= Gem::Version.new('3.3.0') &&
+        # dogstatsd-ruby >= 5.0 & < 5.2.0 has known issues with process forks
+        # and do not support the single thread mode we use to avoid this problem.
+        !(version >= Gem::Version.new('5.0') && version < Gem::Version.new('5.2'))
     end
 
     def enabled?
@@ -50,10 +53,23 @@ module Datadog
     def default_statsd_client
       require 'datadog/statsd'
 
-      incompatible_statsd_warning
-
       # Create a StatsD client that points to the agent.
-      Datadog::Statsd.new(default_hostname, default_port)
+      #
+      # We use `single_thread: true`, as dogstatsd-ruby >= 5.0 creates a background thread
+      # by default, but does not handle forks correctly, causing resource leaks.
+      #
+      # Using dogstatsd-ruby >= 5.0 is still valuable, as it supports
+      # transparent batch metric submission, which reduces submission
+      # overhead.
+      #
+      # Versions < 5.0 are always single-threaded, but do not have the kwarg option.
+      options = if dogstatsd_version >= Gem::Version.new('5.2')
+                  { single_thread: true }
+                else
+                  {}
+                end
+
+      Datadog::Statsd.new(default_hostname, default_port, **options)
     end
 
     def configure(options = {})
@@ -73,7 +89,7 @@ module Datadog
 
       statsd.count(stat, value, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send count stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send count stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def distribution(stat, value = nil, options = nil, &block)
@@ -84,7 +100,7 @@ module Datadog
 
       statsd.distribution(stat, value, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send distribution stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send distribution stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def increment(stat, options = nil)
@@ -94,7 +110,7 @@ module Datadog
 
       statsd.increment(stat, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send increment stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send increment stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def gauge(stat, value = nil, options = nil, &block)
@@ -105,7 +121,7 @@ module Datadog
 
       statsd.gauge(stat, value, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send gauge stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send gauge stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def time(stat, options = nil)
@@ -121,7 +137,7 @@ module Datadog
           distribution(stat, ((finished - start) * 1000), options)
         end
       rescue StandardError => e
-        Datadog.logger.error("Failed to send time stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+        Datadog.logger.error("Failed to send time stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
       end
     end
 
@@ -144,10 +160,10 @@ module Datadog
     module Options
       DEFAULT = {
         tags: DEFAULT_TAGS = [
-          "#{Ext::Metrics::TAG_LANG}:#{Runtime::Identity.lang}".freeze,
-          "#{Ext::Metrics::TAG_LANG_INTERPRETER}:#{Runtime::Identity.lang_interpreter}".freeze,
-          "#{Ext::Metrics::TAG_LANG_VERSION}:#{Runtime::Identity.lang_version}".freeze,
-          "#{Ext::Metrics::TAG_TRACER_VERSION}:#{Runtime::Identity.tracer_version}".freeze
+          "#{Ext::Metrics::TAG_LANG}:#{Core::Environment::Identity.lang}".freeze,
+          "#{Ext::Metrics::TAG_LANG_INTERPRETER}:#{Core::Environment::Identity.lang_interpreter}".freeze,
+          "#{Ext::Metrics::TAG_LANG_VERSION}:#{Core::Environment::Identity.lang_version}".freeze,
+          "#{Ext::Metrics::TAG_TRACER_VERSION}:#{Core::Environment::Identity.tracer_version}".freeze
         ].freeze
       }.freeze
 
@@ -238,16 +254,27 @@ module Datadog
 
     private
 
-    INCOMPATIBLE_STATSD_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-    private_constant :INCOMPATIBLE_STATSD_ONLY_ONCE
+    def dogstatsd_version
+      return @dogstatsd_version if instance_variable_defined?(:@dogstatsd_version)
+
+      @dogstatsd_version = (
+        defined?(Datadog::Statsd::VERSION) &&
+          Datadog::Statsd::VERSION &&
+          Gem::Version.new(Datadog::Statsd::VERSION)
+      ) || (
+        Gem.loaded_specs['dogstatsd-ruby'] &&
+          Gem.loaded_specs['dogstatsd-ruby'].version
+      )
+    end
 
-    def incompatible_statsd_warning
-      return if Gem.loaded_specs['dogstatsd-ruby'].version < Gem::Version.new('5.0')
+    IGNORED_STATSD_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    private_constant :IGNORED_STATSD_ONLY_ONCE
 
-      INCOMPATIBLE_STATSD_ONLY_ONCE.run do
+    def ignored_statsd_warning
+      IGNORED_STATSD_ONLY_ONCE.run do
         Datadog.logger.warn(
-          'This version of `ddtrace` is incompatible with `dogstastd-ruby` version >= 5.0 and can ' \
-          'cause unbounded memory usage. Please use `dogstastd-ruby` version < 5.0 instead.'
+          'Ignoring user-supplied statsd instance as currently-installed version of dogstastd-ruby is incompatible. ' \
+          "To fix this, ensure that you have `gem 'dogstatsd-ruby', '~> 5.2'` on your Gemfile or gems.rb file."
         )
       end
     end