ddtrace 0.49.0 → 1.12.1

data/lib/datadog/core/environment/cgroup.rb

@@ -0,0 +1,51 @@
+require_relative 'ext'
+
+module Datadog
+  module Core
+    module Environment
+      # Reads information from Linux cgroups.
+      # This information is used to extract information
+      # about the current Linux container identity.
+      # @see https://man7.org/linux/man-pages/man7/cgroups.7.html
+      module Cgroup
+        LINE_REGEX = /^(\d+):([^:]*):(.+)$/.freeze
+
+        Descriptor = Struct.new(
+          :id,
+          :groups,
+          :path,
+          :controllers
+        )
+
+        module_function
+
+        def descriptors(process = 'self')
+          [].tap do |descriptors|
+            begin
+              filepath = "/proc/#{process}/cgroup"
+
+              if File.exist?(filepath)
+                File.foreach("/proc/#{process}/cgroup") do |line|
+                  line = line.strip
+                  descriptors << parse(line) unless line.empty?
+                end
+              end
+            rescue StandardError => e
+              Datadog.logger.error(
+                "Error while parsing cgroup. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+              )
+            end
+          end
+        end
+
+        def parse(line)
+          id, groups, path = line.scan(LINE_REGEX).first
+
+          Descriptor.new(id, groups, path).tap do |descriptor|
+            descriptor.controllers = groups.split(',') unless groups.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/class_count.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Retrieves number of classes from runtime
+      module ClassCount
+        module_function
+
+        def value
+          ::ObjectSpace.count_objects[:T_CLASS]
+        end
+
+        def available?
+          ::ObjectSpace.respond_to?(:count_objects) \
+           && ::ObjectSpace.count_objects.key?(:T_CLASS)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/container.rb

@@ -0,0 +1,89 @@
+require_relative 'cgroup'
+
+module Datadog
+  module Core
+    module Environment
+      # For container environments
+      module Container
+        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
+
+        PLATFORM_REGEX = /(?<platform>.*?)(?:.slice)?$/.freeze
+        POD_REGEX = /(?<pod>(pod)?#{UUID_PATTERN})(?:.slice)?$/.freeze
+        CONTAINER_REGEX = /(?<container>#{UUID_PATTERN}|#{CONTAINER_PATTERN})(?:.scope)?$/.freeze
+        FARGATE_14_CONTAINER_REGEX = /(?<container>[0-9a-f]{32}-[0-9]{1,10})/.freeze
+
+        Descriptor = Struct.new(
+          :platform,
+          :container_id,
+          :task_uid
+        )
+
+        module_function
+
+        def platform
+          descriptor.platform
+        end
+
+        def container_id
+          descriptor.container_id
+        end
+
+        def task_uid
+          descriptor.task_uid
+        end
+
+        def descriptor
+          @descriptor ||= Descriptor.new.tap do |descriptor|
+            begin
+              Cgroup.descriptors.each do |cgroup_descriptor|
+                # Parse container data from cgroup descriptor
+                path = cgroup_descriptor.path
+                next if path.nil?
+
+                # Split path into parts
+                parts = path.split('/')
+                parts.shift # Remove leading empty part
+
+                # Read info from path
+                next if parts.empty?
+
+                platform = parts[0][PLATFORM_REGEX, :platform]
+                container_id, task_uid = nil
+
+                case parts.length
+                when 0..1
+                  next
+                when 2
+                  container_id = parts[-1][CONTAINER_REGEX, :container] \
+                                || parts[-1][FARGATE_14_CONTAINER_REGEX, :container]
+                else
+                  if (container_id = parts[-1][CONTAINER_REGEX, :container])
+                    task_uid = parts[-2][POD_REGEX, :pod] || parts[1][POD_REGEX, :pod]
+                  else
+                    container_id = parts[-1][FARGATE_14_CONTAINER_REGEX, :container]
+                  end
+                end
+
+                # If container ID wasn't found, ignore.
+                # Path might describe a non-container environment.
+                next if container_id.nil?
+
+                descriptor.platform = platform
+                descriptor.container_id = container_id
+                descriptor.task_uid = task_uid
+
+                break
+              end
+            rescue StandardError => e
+              Datadog.logger.error(
+                "Error while parsing container info. Cause: #{e.class.name} #{e.message} " \
+                "Location: #{Array(e.backtrace).first}"
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/ext.rb

@@ -0,0 +1,44 @@
+require_relative '../../../ddtrace/version'
+
+module Datadog
+  module Core
+    module Environment
+      # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+      module Ext
+        # e.g for CRuby '3.0.1', for JRuby '9.2.19.0', for TruffleRuby '21.1.0'
+        ENGINE_VERSION = if defined?(RUBY_ENGINE_VERSION)
+                           RUBY_ENGINE_VERSION
+                         else
+                           # CRuby < 2.3 doesn't support RUBY_ENGINE_VERSION
+                           RUBY_VERSION
+                         end
+
+        ENV_API_KEY = 'DD_API_KEY'.freeze
+        ENV_ENVIRONMENT = 'DD_ENV'.freeze
+        ENV_SERVICE = 'DD_SERVICE'.freeze
+        ENV_SITE = 'DD_SITE'.freeze
+        ENV_TAGS = 'DD_TAGS'.freeze
+        ENV_VERSION = 'DD_VERSION'.freeze
+        FALLBACK_SERVICE_NAME =
+          begin
+            File.basename($PROGRAM_NAME, '.*')
+          rescue StandardError
+            'ruby'
+          end.freeze
+
+        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'
+        TAG_ENV = 'env'.freeze
+        TAG_SERVICE = 'service'.freeze
+        TAG_VERSION = 'version'.freeze
+
+        # TODO: Migrate to Datadog::Tracing
+        TRACER_VERSION = DDTrace::VERSION::STRING
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/gc.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Retrieves garbage collection statistics
+      module GC
+        module_function
+
+        def stat
+          ::GC.stat
+        end
+
+        def available?
+          defined?(::GC) && ::GC.respond_to?(:stat)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/identity.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative 'ext'
+require_relative '../utils/forking'
+
+module Datadog
+  module Core
+    module Environment
+      # For runtime identity
+      # @public_api
+      module Identity
+        extend Core::Utils::Forking
+
+        module_function
+
+        # Retrieves number of classes from runtime
+        def id
+          @id ||= ::SecureRandom.uuid.freeze
+
+          # Check if runtime has changed, e.g. forked.
+          after_fork! { @id = ::SecureRandom.uuid.freeze }
+
+          @id
+        end
+
+        def pid
+          ::Process.pid
+        end
+
+        def lang
+          Core::Environment::Ext::LANG
+        end
+
+        def lang_engine
+          Core::Environment::Ext::LANG_ENGINE
+        end
+
+        def lang_interpreter
+          Core::Environment::Ext::LANG_INTERPRETER
+        end
+
+        def lang_platform
+          Core::Environment::Ext::LANG_PLATFORM
+        end
+
+        def lang_version
+          Core::Environment::Ext::LANG_VERSION
+        end
+
+        # Returns tracer version, rubygems-style
+        def tracer_version
+          Core::Environment::Ext::TRACER_VERSION
+        end
+
+        # Returns tracer version, comforming to https://semver.org/spec/v2.0.0.html
+        def tracer_version_semver2
+          # from ddtrace/version.rb, we have MAJOR.MINOR.PATCH plus optional .PRE and .BUILD
+          # - transform .PRE to -PRE if present
+          # - transform .BUILD to +BUILD if present
+          # - keep triplet segments before that
+
+          m = SEMVER2_RE.match(tracer_version)
+
+          pre = "-#{m[:pre]}" if m[:pre]
+          build = "+gha#{m[:gha_run_id]}.g#{m[:git_sha]}.#{m[:branch].tr('.', '-')}" if m[:build]
+
+          "#{m[:major]}.#{m[:minor]}.#{m[:patch]}#{pre}#{build}"
+        end
+
+        SEMVER2_RE = /
+          ^
+          # mandatory segments
+          (?<major>\d+)
+          \.
+          (?<minor>\d+)
+          \.
+          (?<patch>\d+)
+
+          # pre segments start with a value
+          # - containing at least one alpha
+          # - that is not part of our build segments expected values
+          # and stop with a value that is not part of our build segments expected values
+          (?:
+            \.
+            (?<pre>
+              (?!gha)
+              [a-zA-Z0-9]*[a-zA-Z][a-zA-Z0-9]*
+              (?:
+                \.
+                (?!gha)
+                [a-zA-Z0-9]+
+              )*
+            )
+          )?
+
+          # build segments: ours include CI info (`gha`), then git (`g`), then branch name
+          (?:
+            \.
+            (?<build>
+              gha(?<gha_run_id>\d+)
+              \.
+              g(?<git_sha>[a-f0-9]+)
+              \.
+              (?<branch>(?:[a-zA-Z0-9.])+)
+            )
+          )?
+          $
+        /xm.freeze
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/platform.rb

@@ -0,0 +1,38 @@
+require 'etc'
+
+require_relative 'identity'
+
+module Datadog
+  module Core
+    module Environment
+      # For gathering information about the platform
+      module Platform
+        module_function
+
+        # @return [String] name of host; `uname -n`
+        def hostname
+          Identity.lang_version >= '2.2' ? Etc.uname[:nodename] : nil
+        end
+
+        # @return [String] name of kernel; `uname -s`
+        def kernel_name
+          Identity.lang_version >= '2.2' ? Etc.uname[:sysname] : Gem::Platform.local.os.capitalize
+        end
+
+        # @return [String] kernel release; `uname -r`
+        def kernel_release
+          if Identity.lang_engine == 'jruby'
+            Etc.uname[:version] # Java's `os.version` maps to `uname -r`
+          elsif Identity.lang_version >= '2.2'
+            Etc.uname[:release]
+          end
+        end
+
+        # @return [String] kernel version; `uname -v`
+        def kernel_version
+          Etc.uname[:version] if Identity.lang_engine != 'jruby' && Identity.lang_version >= '2.2'
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/socket.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'socket'
+require_relative '../utils/forking'
+
+module Datadog
+  module Core
+    module Environment
+      # For runtime identity
+      module Socket
+        extend Core::Utils::Forking
+
+        module_function
+
+        def hostname
+          # Check if runtime has changed, e.g. forked.
+          after_fork! { @hostname = ::Socket.gethostname.freeze }
+
+          @hostname ||= ::Socket.gethostname.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/thread_count.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Retrieves number of threads from runtime
+      module ThreadCount
+        module_function
+
+        def value
+          Thread.list.count
+        end
+
+        def available?
+          Thread.respond_to?(:list)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/variable_helpers.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    # Namespace for handling application environment
+    module Environment
+      # Defines helper methods for environment
+      # @public_api
+      module VariableHelpers
+        extend self
+
+        # Reads an environment variable as a Boolean.
+        #
+        # @param [String] var environment variable
+        # @param [Array<String>] var list of environment variables
+        # @param [Boolean] default the default value if the keys in `var` are not present in the environment
+        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
+        #   the first key in `var` is not used.
+        # @return [Boolean] if the environment value is the string `true` or `1`
+        # @return [default] if the environment value is not found
+        def env_to_bool(var, default = nil, deprecation_warning: true)
+          var = decode_array(var, deprecation_warning)
+          if var && ENV.key?(var)
+            value = ENV[var].to_s.strip
+            value.downcase!
+            value == 'true' || value == '1' # rubocop:disable Style/MultipleComparison
+          else
+            default
+          end
+        end
+
+        # Reads an environment variable as an Integer.
+        #
+        # @param [String] var environment variable
+        # @param [Array<String>] var list of environment variables
+        # @param [Integer] default the default value if the keys in `var` are not present in the environment
+        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
+        #   the first key in `var` is not used.
+        # @return [Integer] if the environment value is a valid Integer
+        # @return [default] if the environment value is not found
+        def env_to_int(var, default = nil, deprecation_warning: true)
+          var = decode_array(var, deprecation_warning)
+          var && ENV.key?(var) ? ENV[var].to_i : default
+        end
+
+        # Reads an environment variable as a Float.
+        #
+        # @param [String] var environment variable
+        # @param [Array<String>] var list of environment variables
+        # @param [Float] default the default value if the keys in `var` are not present in the environment
+        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
+        #   the first key in `var` is not used.
+        # @return [Float] if the environment value is a valid Float
+        # @return [default] if the environment value is not found
+        def env_to_float(var, default = nil, deprecation_warning: true)
+          var = decode_array(var, deprecation_warning)
+          var && ENV.key?(var) ? ENV[var].to_f : default
+        end
+
+        # Parses comma- or space-separated lists.
+        #
+        # If a comma is present, then the list is considered comma-separated.
+        # Otherwise, it is considered space-separated.
+        #
+        # After the entries are separated, commas and whitespaces that are
+        # either trailing or leading are trimmed.
+        #
+        # Empty entries, after trimmed, are also removed from the result.
+        #
+        # @param [String] var environment variable
+        # @param [Array<String>] var list of environment variables
+        # @param [Array<Object>] default the default value if the keys in `var` are not present in the environment
+        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
+        #   the first key in `var` is not used.
+        # @return [Array<Object>] if the environment value is a valid list
+        # @return [default] if the environment value is not found
+        def env_to_list(var, default = [], comma_separated_only:, deprecation_warning: true)
+          var = decode_array(var, deprecation_warning)
+          if var && ENV.key?(var)
+            value = ENV[var]
+
+            values = if value.include?(',') || comma_separated_only
+                       value.split(',')
+                     else
+                       value.split(' ') # rubocop:disable Style/RedundantArgument
+                     end
+
+            values.map! do |v|
+              v.gsub!(/\A[\s,]*|[\s,]*\Z/, '')
+
+              v.empty? ? nil : v
+            end
+
+            values.compact!
+            values
+          else
+            default
+          end
+        end
+
+        private
+
+        def decode_array(var, deprecation_warning)
+          if var.is_a?(Array)
+            var.find.with_index do |env_var, i|
+              found = ENV.key?(env_var)
+
+              # Check if we are using a non-preferred environment variable
+              if deprecation_warning && found && i != 0
+                Datadog::Core.log_deprecation { "#{env_var} environment variable is deprecated, use #{var.first} instead." }
+              end
+
+              found
+            end
+          else
+            var
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/environment/vm_cache.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Reports Ruby VM cache performance statistics.
+      # This currently encompasses cache invalidation counters and is CRuby-specific.
+      #
+      # JRuby emulates some CRuby global cache statistics, but they are synthetic and don't
+      # provide actionable performance information in the same way CRuby does.
+      # @see https://github.com/jruby/jruby/issues/4384#issuecomment-267069314
+      #
+      # TruffleRuby does not have a global runtime cache invalidation cache.
+      # @see http://archive.today/2021.09.10-205702/https://medium.com/graalvm/precise-method-and-constant-invalidation-in-truffleruby-4dd56c6bac1a
+      module VMCache
+        module_function
+
+        # Global constant cache "generation" counter.
+        #
+        # Whenever a constant creation busts the global constant cache
+        # this value is incremented. This has a measurable performance impact
+        # and thus show be avoided after application warm up.
+        #
+        # This was removed in Ruby 3.2.
+        # @see https://github.com/ruby/ruby/blob/master/doc/NEWS/NEWS-3.2.0.md#implementation-improvements
+        def global_constant_state
+          ::RubyVM.stat[:global_constant_state]
+        end
+
+        # Global method cache "generation" counter.
+        #
+        # Whenever a method creation busts the global method cache
+        # this value is incremented. This has a measurable performance impact
+        # and thus show be avoided after application warm up.
+        #
+        # Since Ruby 3.0, the method class is kept on a per-class basis,
+        # largely mitigating global method cache busting. `global_method_state`
+        # is thus not available since Ruby 3.0.
+        # @see https://bugs.ruby-lang.org/issues/16614
+        def global_method_state
+          ::RubyVM.stat[:global_method_state]
+        end
+
+        # Introduced in Ruby 3.2 to match an improved cache implementation.
+        #
+        # @see https://bugs.ruby-lang.org/issues/18589
+        def constant_cache_invalidations
+          ::RubyVM.stat[:constant_cache_invalidations]
+        end
+
+        # Introduced in Ruby 3.2 to match an improved cache implementation.
+        #
+        # @see https://bugs.ruby-lang.org/issues/18589
+        def constant_cache_misses
+          ::RubyVM.stat[:constant_cache_misses]
+        end
+
+        def available?
+          defined?(::RubyVM) && ::RubyVM.respond_to?(:stat)
+        end
+      end
+    end
+  end
+end