ddtrace 0.54.2 → 1.2.0

data/lib/datadog/core/encoding.rb

@@ -0,0 +1,76 @@
+# typed: true
+
+require 'json'
+require 'msgpack'
+
+module Datadog
+  module Core
+    # Encoding module that encodes data for the AgentTransport
+    module Encoding
+      # Encoder interface that provides the logic to encode traces and service
+      # @abstract
+      module Encoder
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
+        def content_type
+          raise NotImplementedError
+        end
+
+        # Concatenates a list of elements previously encoded by +#encode+.
+        def join(encoded_elements)
+          raise NotImplementedError
+        end
+
+        # Serializes a single trace into a String suitable for network transmission.
+        def encode(_)
+          raise NotImplementedError
+        end
+      end
+
+      # Encoder for the JSON format
+      module JSONEncoder
+        extend Encoder
+
+        CONTENT_TYPE = 'application/json'.freeze
+
+        module_function
+
+        def content_type
+          CONTENT_TYPE
+        end
+
+        def encode(obj)
+          JSON.dump(obj)
+        end
+
+        def join(encoded_data)
+          "[#{encoded_data.join(',')}]"
+        end
+      end
+
+      # Encoder for the Msgpack format
+      module MsgpackEncoder
+        extend Encoder
+
+        module_function
+
+        CONTENT_TYPE = 'application/msgpack'.freeze
+
+        def content_type
+          CONTENT_TYPE
+        end
+
+        def encode(obj)
+          MessagePack.pack(obj)
+        end
+
+        def join(encoded_data)
+          packer = MessagePack::Packer.new
+          packer.write_array_header(encoded_data.size)
+
+          (packer.buffer.to_a + encoded_data).join
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/environment/ext'
 
 module Datadog
@@ -34,7 +35,9 @@ module Datadog
                 end
               end
             rescue StandardError => e
-              Datadog.logger.error("Error while parsing cgroup. Cause: #{e.message} Location: #{Array(e.backtrace).first}")
+              Datadog.logger.error(
+                "Error while parsing cgroup. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+              )
             end
           end
         end

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Environment

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/environment/cgroup'
 
 module Datadog
@@ -80,7 +81,8 @@ module Datadog
               end
             rescue StandardError => e
               Datadog.logger.error(
-                "Error while parsing container info. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+                "Error while parsing container info. Cause: #{e.class.name} #{e.message} " \
+                "Location: #{Array(e.backtrace).first}"
               )
             end
           end

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

@@ -1,19 +1,12 @@
 # typed: true
+
 require 'ddtrace/version'
 
 module Datadog
   module Core
     module Environment
+      # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
       module Ext
-        # 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
-
         # 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
@@ -21,6 +14,32 @@ module Datadog
                            # 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

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Environment

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

@@ -1,27 +1,34 @@
 # typed: false
+
 require 'securerandom'
+
 require 'datadog/core/environment/ext'
-require 'ddtrace/utils/forking'
+require 'datadog/core/utils/forking'
 
 module Datadog
   module Core
     module Environment
       # For runtime identity
+      # @public_api
       module Identity
-        extend Datadog::Utils::Forking
+        extend Core::Utils::Forking
 
         module_function
 
         # Retrieves number of classes from runtime
         def id
-          @id ||= SecureRandom.uuid
+          @id ||= ::SecureRandom.uuid.freeze
 
           # Check if runtime has changed, e.g. forked.
-          after_fork! { @id = SecureRandom.uuid }
+          after_fork! { @id = ::SecureRandom.uuid.freeze }
 
           @id
         end
 
+        def pid
+          ::Process.pid
+        end
+
         def lang
           Core::Environment::Ext::LANG
         end

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

@@ -0,0 +1,40 @@
+# typed: false
+
+require 'etc'
+
+require 'datadog/core/environment/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

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

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Environment

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

@@ -1,9 +1,11 @@
 # typed: false
+
 module Datadog
   module Core
     # Namespace for handling application environment
     module Environment
       # Defines helper methods for environment
+      # @public_api
       module VariableHelpers
         extend self
 
@@ -22,10 +24,34 @@ module Datadog
           var && ENV.key?(var) ? ENV[var].to_f : default
         end
 
-        def env_to_list(var, default = [])
+        # 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.
+        def env_to_list(var, default = [], comma_separated_only:)
           var = decode_array(var)
           if var && ENV.key?(var)
-            ENV[var].split(',').map(&:strip)
+            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

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Environment

data/lib/datadog/core/error.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/core/utils'
+
+module Datadog
+  module Core
+    # Error is a value-object responsible for sanitizing/encapsulating error data
+    class Error
+      attr_reader :type, :message, :backtrace
+
+      class << self
+        def build_from(value)
+          case value
+          when Error then value
+          when Array then new(*value)
+          when Exception then new(value.class, value.message, full_backtrace(value))
+          when ContainsMessage then new(value.class, value.message)
+          else BlankError
+          end
+        end
+
+        private
+
+        # Returns a stack trace with nested error causes and details.
+        #
+        # This manually implements Ruby >= 2.6 error output for two reasons:
+        #
+        # 1. It is not available in Ruby < 2.6.
+        # 2. It's measurably faster to manually implement it in Ruby.
+        #
+        # This method mimics the exact output of
+        # `ex.full_message(highlight: false, order: :top)`
+        # but it's around 3x faster in our benchmark test
+        # at `error_spec.rb`.
+        def full_backtrace(ex)
+          backtrace = String.new
+          backtrace_for(ex, backtrace)
+
+          # Avoid circular causes
+          causes = {}
+          causes[ex] = true
+
+          cause = ex
+          while (cause = cause.cause) && !causes.key?(cause)
+            backtrace_for(cause, backtrace)
+            causes[cause] = true
+          end
+
+          backtrace
+        end
+
+        # Outputs the following format for exceptions:
+        #
+        # ```
+        # error_spec.rb:55:in `wrapper': wrapper layer (RuntimeError)
+        # 	from error_spec.rb:40:in `wrapper'
+        # 	from error_spec.rb:61:in `caller'
+        #   ...
+        # ```
+        def backtrace_for(ex, backtrace)
+          trace = ex.backtrace
+          return unless trace
+
+          if trace[0]
+            # Add Exception information to error line
+            backtrace << trace[0]
+            backtrace << ': '
+            backtrace << ex.message.to_s
+            backtrace << ' ('
+            backtrace << ex.class.to_s
+            backtrace << ')'
+          end
+
+          if trace[1]
+            # Ident stack trace for caller lines, to separate
+            # them from the main error lines.
+            trace[1..-1].each do |line|
+              backtrace << "\n\tfrom "
+              backtrace << line
+            end
+          end
+
+          backtrace << "\n"
+        end
+      end
+
+      def initialize(type = nil, message = nil, backtrace = nil)
+        backtrace = Array(backtrace).join("\n") unless backtrace.is_a?(String)
+
+        @type = Utils.utf8_encode(type)
+        @message = Utils.utf8_encode(message)
+        @backtrace = Utils.utf8_encode(backtrace)
+      end
+
+      BlankError = Error.new
+      ContainsMessage = ->(v) { v.respond_to?(:message) }
+    end
+  end
+end

data/lib/datadog/core/extensions.rb

@@ -0,0 +1,16 @@
+# typed: true
+
+require 'datadog/core/configuration'
+
+# Global namespace that includes all Datadog functionality.
+# @public_api
+module Datadog
+  module Core
+    # Used to decorate Datadog module with additional behavior
+    module Extensions
+      def self.extended(base)
+        base.extend(Core::Configuration)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# typed: true
+
+module Datadog
+  module Core
+    module Git
+      # Defines constants for Git tags
+      module Ext
+        TAG_BRANCH = 'git.branch'.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
+
+        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'.freeze
+        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'.freeze
+        ENV_BRANCH = 'DD_GIT_BRANCH'.freeze
+        ENV_TAG = 'DD_GIT_TAG'.freeze
+        ENV_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE'.freeze
+        ENV_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME'.freeze
+        ENV_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL'.freeze
+        ENV_COMMIT_AUTHOR_DATE = 'DD_GIT_COMMIT_AUTHOR_DATE'.freeze
+        ENV_COMMIT_COMMITTER_NAME = 'DD_GIT_COMMIT_COMMITTER_NAME'.freeze
+        ENV_COMMIT_COMMITTER_EMAIL = 'DD_GIT_COMMIT_COMMITTER_EMAIL'.freeze
+        ENV_COMMIT_COMMITTER_DATE = 'DD_GIT_COMMIT_COMMITTER_DATE'.freeze
+      end
+    end
+  end
+end

data/lib/datadog/core/logger.rb

@@ -0,0 +1,46 @@
+# typed: true
+
+require 'logger'
+
+module Datadog
+  module Core
+    # A custom logger with minor enhancements:
+    # - progname defaults to ddtrace to clearly identify Datadog dd-trace-rb related messages
+    # - adds last caller stack-trace info to know where the message comes from
+    # @public_api
+    class Logger < ::Logger
+      # TODO: Consider renaming this to 'datadog'
+      PREFIX = 'ddtrace'.freeze
+
+      def initialize(*args, &block)
+        super
+        self.progname = PREFIX
+        self.level = ::Logger::INFO
+      end
+
+      def add(severity, message = nil, progname = nil, &block)
+        where = ''
+
+        # We are in debug mode, or this is an error, add stack trace to help debugging
+        if debug? || severity >= ::Logger::ERROR
+          c = caller
+          where = "(#{c[1]}) " if c.length > 1
+        end
+
+        if message.nil?
+          if block
+            super(severity, message, progname) do
+              "[#{self.progname}] #{where}#{yield}"
+            end
+          else
+            super(severity, message, "[#{self.progname}] #{where}#{progname}")
+          end
+        else
+          super(severity, "[#{self.progname}] #{where}#{message}")
+        end
+      end
+
+      alias log add
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Datadog
+  module Core
+    module Logging
+      module Ext
+        # The technology from which the log originated.
+        # @see https://docs.datadoghq.com/api/latest/logs/#send-logs
+        DD_SOURCE = 'ruby'.freeze
+      end
+    end
+  end
+end