ddtrace 1.0.0 → 1.9.0

data/lib/datadog/core/telemetry/v1/host.rb

@@ -0,0 +1,51 @@
+module Datadog
+  module Core
+    module Telemetry
+      module V1
+        # Describes attributes for host object
+        class Host
+          attr_reader \
+            :container_id,
+            :hostname,
+            :kernel_name,
+            :kernel_release,
+            :kernel_version,
+            :os_version,
+            :os
+
+          # @param container_id [String] Docker container ID
+          # @param hostname [String] uname -n
+          # @param kernel_name [String] uname -s
+          # @param kernel_release [String] uname -r
+          # @param kernel_version [String] uname -v
+          # @param os [String] uname -o
+          # @param os_version [String] Version of OS running
+          def initialize(
+            container_id: nil, hostname: nil, kernel_name: nil, kernel_release: nil, kernel_version: nil,
+            os_version: nil, os: nil
+          )
+            @container_id = container_id
+            @hostname = hostname
+            @kernel_name = kernel_name
+            @kernel_release = kernel_release
+            @kernel_version = kernel_version
+            @os = os
+            @os_version = os_version
+          end
+
+          def to_h
+            {
+              container_id: @container_id,
+              hostname: @hostname,
+              kernel_name: @kernel_name,
+              kernel_release: @kernel_release,
+              kernel_version: @kernel_version,
+              os: @os,
+              os_version: @os_version,
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/v1/integration.rb

@@ -0,0 +1,58 @@
+module Datadog
+  module Core
+    module Telemetry
+      module V1
+        # Describes attributes for integration object
+        class Integration
+          ERROR_NIL_ENABLED_MESSAGE = ':enabled must not be nil'.freeze
+          ERROR_NIL_NAME_MESSAGE = ':name must not be nil'.freeze
+
+          attr_reader \
+            :auto_enabled,
+            :compatible,
+            :enabled,
+            :error,
+            :name,
+            :version
+
+          # @param enabled [Boolean] Whether integration is enabled at time of request
+          # @param name [String] Integration name
+          # @param auto_enabled [Boolean] If integration is not enabled by default, but by user choice
+          # @param compatible [Boolean] If integration is available, but incompatible
+          # @param error [String] Error message if integration fails to load
+          # @param version [String] Integration version (if specified in app-started, it should be for other events too)
+          def initialize(enabled:, name:, auto_enabled: nil, compatible: nil, error: nil, version: nil)
+            validate(enabled: enabled, name: name)
+            @auto_enabled = auto_enabled
+            @compatible = compatible
+            @enabled = enabled
+            @error = error
+            @name = name
+            @version = version
+          end
+
+          def to_h
+            {
+              auto_enabled: @auto_enabled,
+              compatible: @compatible,
+              enabled: @enabled,
+              error: @error,
+              name: @name,
+              version: @version
+            }
+          end
+
+          private
+
+          # Validates all required arguments passed to the class on initialization are not nil
+          #
+          # @!visibility private
+          def validate(enabled:, name:)
+            raise ArgumentError, ERROR_NIL_ENABLED_MESSAGE if enabled.nil?
+            raise ArgumentError, ERROR_NIL_NAME_MESSAGE if name.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/v1/product.rb

@@ -0,0 +1,28 @@
+module Datadog
+  module Core
+    module Telemetry
+      module V1
+        # Describes attributes for products object
+        class Product
+          attr_reader \
+            :appsec,
+            :profiler
+
+          # @param appsec [Telemetry::V1::AppSec] Holds custom information about the appsec product
+          # @param profiler [Telemetry::V1::Profiler] Holds custom information about the profiler product
+          def initialize(appsec: nil, profiler: nil)
+            @appsec = appsec
+            @profiler = profiler
+          end
+
+          def to_h
+            {
+              appsec: @appsec,
+              profiler: @profiler
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/v1/telemetry_request.rb

@@ -0,0 +1,100 @@
+module Datadog
+  module Core
+    module Telemetry
+      module V1
+        # Describes attributes for telemetry API request
+        class TelemetryRequest
+          ERROR_NIL_API_VERSION_MESSAGE = ':api_version must not be nil'.freeze
+          ERROR_NIL_APPLICATION_MESSAGE = ':application must not be nil'.freeze
+          ERROR_NIL_HOST_MESSAGE = ':host must not be nil'.freeze
+          ERROR_NIL_PAYLOAD_MESSAGE = ':payload must not be nil'.freeze
+          ERROR_NIL_REQUEST_TYPE_MESSAGE = ':request_type must not be nil'.freeze
+          ERROR_NIL_RUNTIME_ID_MESSAGE = ':runtime_id must not be nil'.freeze
+          ERROR_NIL_SEQ_ID_MESSAGE = ':seq_id must not be nil'.freeze
+          ERROR_NIL_TRACER_TIME_MESSAGE = ':tracer_time must not be nil'.freeze
+
+          attr_reader \
+            :api_version,
+            :application,
+            :debug,
+            :host,
+            :payload,
+            :request_type,
+            :runtime_id,
+            :seq_id,
+            :session_id,
+            :tracer_time
+
+          # @param api_version [String] Requested API version, `v1`
+          # @param application [Telemetry::V1::Application] Object that contains information about the environment of the
+          #   application
+          # @param host [Telemetry::V1::Host] Object that holds host related information
+          # @param payload [Telemetry::V1::AppEvent] The payload of the request, type impacted by :request_type
+          # @param request_type [String] Requested API function impacting the Payload type, `app-started`
+          # @param runtime_id [String] V4 UUID that represents a tracer session
+          # @param seq_id [Integer] Counter that should be auto incremented every time an API call is being made
+          # @param tracer_time [Integer] Unix timestamp (in seconds) of when the message is being sent
+          # @param debug [Boolean] Flag that enables payload debug mode
+          # @param session_id [String] V4 UUID that represents the session of the top level tracer process, often same\
+          #   as runtime_id
+          def initialize(
+            api_version:, application:, host:, payload:, request_type:, runtime_id:, seq_id:, tracer_time:,
+            debug: nil, session_id: nil
+          )
+            validate(
+              api_version: api_version,
+              application: application,
+              host: host,
+              payload: payload,
+              request_type: request_type,
+              runtime_id: runtime_id,
+              seq_id: seq_id,
+              tracer_time: tracer_time
+            )
+            @api_version = api_version
+            @application = application
+            @debug = debug
+            @host = host
+            @payload = payload
+            @request_type = request_type
+            @runtime_id = runtime_id
+            @seq_id = seq_id
+            @session_id = session_id
+            @tracer_time = tracer_time
+          end
+
+          def to_h
+            {
+              api_version: @api_version,
+              application: @application.to_h,
+              debug: @debug,
+              host: @host.to_h,
+              payload: @payload.to_h,
+              request_type: @request_type,
+              runtime_id: @runtime_id,
+              seq_id: @seq_id,
+              session_id: @session_id,
+              tracer_time: @tracer_time
+            }
+          end
+
+          private
+
+          # Validates all required arguments passed to the class on initialization are not nil
+          #
+          # @!visibility private
+          def validate(api_version:, application:, host:, payload:, request_type:, runtime_id:, seq_id:, tracer_time:)
+            raise ArgumentError, ERROR_NIL_API_VERSION_MESSAGE if api_version.nil?
+            raise ArgumentError, ERROR_NIL_APPLICATION_MESSAGE if application.nil?
+            raise ArgumentError, ERROR_NIL_HOST_MESSAGE if host.nil?
+            raise ArgumentError, ERROR_NIL_PAYLOAD_MESSAGE if payload.nil?
+            raise ArgumentError, ERROR_NIL_REQUEST_TYPE_MESSAGE if request_type.nil?
+            raise ArgumentError, ERROR_NIL_RUNTIME_ID_MESSAGE if runtime_id.nil?
+            raise ArgumentError, ERROR_NIL_SEQ_ID_MESSAGE if seq_id.nil?
+            raise ArgumentError, ERROR_NIL_TRACER_TIME_MESSAGE if tracer_time.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/utils/compression.rb

@@ -6,10 +6,13 @@ require 'zlib'
 module Datadog
   module Core
     module Utils
-      # Common database-related utility functions.
+      # Compression/decompression utility functions.
+      #
+      # @deprecated This is no longer used by ddtrace and will be removed in 2.0.
       module Compression
         module_function
 
+        # @deprecated This is no longer used by ddtrace and will be removed in 2.0.
         def gzip(string, level: nil, strategy: nil)
           sio = StringIO.new
           sio.binmode
@@ -19,6 +22,7 @@ module Datadog
           sio.string
         end
 
+        # @deprecated This is no longer used by ddtrace and will be removed in 2.0.
         def gunzip(string, encoding = ::Encoding::ASCII_8BIT)
           sio = StringIO.new(string)
           gz = Zlib::GzipReader.new(sio, encoding: encoding)

data/lib/datadog/core/utils/object_set.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core/utils/sequence'
+require_relative 'sequence'
 
 module Datadog
   module Core

data/lib/datadog/core/utils/sequence.rb

@@ -6,6 +6,7 @@ module Datadog
       # Generates values from a consistent sequence
       class Sequence
         def initialize(seed = 0, &block)
+          @seed = seed
           @current = seed
           @next_item = block
         end
@@ -15,6 +16,10 @@ module Datadog
           @current += 1
           next_item
         end
+
+        def reset!
+          @current = @seed
+        end
       end
     end
   end

data/lib/datadog/core/utils/string_table.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core/utils/sequence'
+require_relative 'sequence'
 
 module Datadog
   module Core

data/lib/datadog/core/utils/time.rb

@@ -36,10 +36,10 @@ module Datadog
           define_singleton_method(:now, &block)
         end
 
-        def measure
-          before = get_time
+        def measure(unit = :float_second)
+          before = get_time(unit)
           yield
-          after = get_time
+          after = get_time(unit)
           after - before
         end
 

data/lib/datadog/core/utils.rb

@@ -1,7 +1,6 @@
 # typed: true
 
-require 'datadog/core/utils/forking'
-require 'datadog/tracing/span'
+require_relative 'utils/forking'
 
 module Datadog
   module Core
@@ -11,26 +10,6 @@ module Datadog
       extend Forking
 
       EMPTY_STRING = ''.encode(::Encoding::UTF_8).freeze
-      # We use a custom random number generator because we want no interference
-      # with the default one. Using the default prng, we could break code that
-      # would rely on srand/rand sequences.
-
-      # Return a randomly generated integer, valid as a Span ID or Trace ID.
-      # This method is thread-safe and fork-safe.
-      def self.next_id
-        after_fork! { reset! }
-        id_rng.rand(Tracing::Span::RUBY_MAX_ID) # TODO: This should never return zero
-      end
-
-      def self.id_rng
-        @id_rng ||= Random.new
-      end
-
-      def self.reset!
-        @id_rng = Random.new
-      end
-
-      private_class_method :id_rng, :reset!
 
       # Stringifies `value` and ensures the outcome is
       # string is no longer than `size`.

data/lib/datadog/core/vendor/multipart-post/multipart/post/multipartable.rb

@@ -6,8 +6,8 @@
 # software license details.
 #++
 
-require 'datadog/core/vendor/multipart-post/multipart/post/parts'
-require 'datadog/core/vendor/multipart-post/multipart/post/composite_read_io'
+require_relative 'parts'
+require_relative 'composite_read_io'
 require 'securerandom'
 
 module Datadog

data/lib/datadog/core/vendor/multipart-post/net/http/post/multipart.rb

@@ -9,9 +9,9 @@
 require 'net/http'
 require 'stringio'
 require 'cgi'
-require 'datadog/core/vendor/multipart-post/multipart/post/parts'
-require 'datadog/core/vendor/multipart-post/multipart/post/composite_read_io'
-require 'datadog/core/vendor/multipart-post/multipart/post/multipartable'
+require_relative '../../../multipart/post/parts'
+require_relative '../../../multipart/post/composite_read_io'
+require_relative '../../../multipart/post/multipartable'
 
 module Datadog
   module Core

data/lib/datadog/core/workers/async.rb

@@ -1,6 +1,6 @@
 # typed: false
 
-require 'datadog/core/logger'
+require_relative '../logger'
 
 module Datadog
   module Core
@@ -8,7 +8,6 @@ module Datadog
       module Async
         # Adds threading behavior to workers
         # to run tasks asynchronously.
-        # rubocop:disable Metrics/ModuleLength
         module Thread
           FORK_POLICY_STOP = :stop
           FORK_POLICY_RESTART = :restart
@@ -138,7 +137,9 @@ module Datadog
               # rubocop:disable Lint/RescueException
               rescue Exception => e
                 @error = e
-                Datadog.logger.debug("Worker thread error. Cause #{e.message} Location: #{Array(e.backtrace).first}")
+                Datadog.logger.debug(
+                  "Worker thread error. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+                )
                 raise
               end
               # rubocop:enable Lint/RescueException
@@ -173,7 +174,6 @@ module Datadog
             end
           end
         end
-        # rubocop:enable Metrics/ModuleLength
       end
     end
   end

data/lib/datadog/core/workers/polling.rb

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/core/workers/async'
-require 'datadog/core/workers/interval_loop'
+require_relative 'async'
+require_relative 'interval_loop'
 
 module Datadog
   module Core

data/lib/datadog/core/workers/runtime_metrics.rb

@@ -1,19 +1,16 @@
 # typed: false
 
-require 'forwardable'
+require_relative '../runtime/metrics'
 
-require 'datadog/core/runtime/metrics'
-
-require 'datadog/core/worker'
-require 'datadog/core/workers/async'
-require 'datadog/core/workers/polling'
+require_relative '../worker'
+require_relative 'async'
+require_relative 'polling'
 
 module Datadog
   module Core
     module Workers
       # Emits runtime metrics asynchronously on a timed loop
       class RuntimeMetrics < Worker
-        extend Forwardable
         include Workers::Polling
 
         # In seconds

data/lib/datadog/core.rb

@@ -1,64 +1,36 @@
-# typed: strict
+# frozen_string_literal: true
+# typed: true
 
-# TODO: Move these requires to smaller modules.
-#       Would be better to lazy load these; not
-#       all of these components will be used in
-#       every application.
-# require 'datadog/core/buffer/cruby'
-# require 'datadog/core/buffer/random'
-# require 'datadog/core/buffer/thread_safe'
-# require 'datadog/core/chunker'
-# require 'datadog/core/configuration'
-# require 'datadog/core/diagnostics/environment_logger'
-# require 'datadog/core/diagnostics/ext'
-# require 'datadog/core/diagnostics/health'
-# require 'datadog/core/encoding'
-# require 'datadog/core/environment/cgroup'
-# require 'datadog/core/environment/class_count'
-# require 'datadog/core/environment/container'
-# require 'datadog/core/environment/ext'
-# require 'datadog/core/environment/gc'
-# require 'datadog/core/environment/identity'
-# require 'datadog/core/environment/socket'
-# require 'datadog/core/environment/thread_count'
-# require 'datadog/core/environment/variable_helpers'
-# require 'datadog/core/environment/vm_cache'
-# require 'datadog/core/error'
-# require 'datadog/core/event'
-# require 'datadog/core/git/ext'
-# require 'datadog/core/logger'
-# require 'datadog/core/metrics/client'
-# require 'datadog/core/metrics/ext'
-# require 'datadog/core/metrics/helpers'
-# require 'datadog/core/metrics/logging'
-# require 'datadog/core/metrics/metric'
-# require 'datadog/core/metrics/options'
-# require 'datadog/core/pin'
-# require 'datadog/core/quantization/hash'
-# require 'datadog/core/quantization/http'
-# require 'datadog/core/runtime/ext'
-# require 'datadog/core/runtime/metrics'
-# require 'datadog/core/utils'
-# require 'datadog/core/utils/compression'
-# require 'datadog/core/utils/database'
-# require 'datadog/core/utils/forking'
-# require 'datadog/core/utils/object_set'
-# require 'datadog/core/utils/only_once'
-# require 'datadog/core/utils/sequence'
-# require 'datadog/core/utils/string_table'
-# require 'datadog/core/utils/time'
-# require 'datadog/core/worker'
-# require 'datadog/core/workers/async'
-# require 'datadog/core/workers/interval_loop'
-# require 'datadog/core/workers/polling'
-# require 'datadog/core/workers/queue'
-# require 'datadog/core/workers/runtime_metrics'
-
-require 'datadog/core/extensions'
+require_relative 'core/extensions'
 
 # We must load core extensions to make certain global APIs
 # accessible: both for Datadog features and the core itself.
 module Datadog
+  # Common, lower level, internal code used (or usable) by two or more
+  # products. It is a dependency of each product. Contrast with Datadog::Kit
+  # for higher-level features.
+  module Core
+    class << self
+      # Records the occurrence of a deprecated operation in this library.
+      #
+      # Currently, these operations are logged to `Datadog.logger` at `warn` level.
+      #
+      # `disallowed_next_major` adds a message informing that the deprecated operation
+      # won't be allowed in the next major release.
+      #
+      # @yieldreturn [String] a String with the lazily evaluated deprecation message.
+      # @param [Boolean] disallowed_next_major whether this deprecation will be enforced in the next major release.
+      def log_deprecation(disallowed_next_major: true)
+        Datadog.logger.warn do
+          message = yield
+          message += ' This will be enforced in the next major release.' if disallowed_next_major
+          message
+        end
+        nil
+      end
+    end
+  end
+
   extend Core::Extensions
 
   # Add shutdown hook:

data/lib/datadog/kit/appsec/events.rb

@@ -0,0 +1,75 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative '../identity'
+
+module Datadog
+  module Kit
+    module AppSec
+      # Tracking events
+      module Events
+        LOGIN_SUCCESS_EVENT = 'users.login.success'
+        LOGIN_FAILURE_EVENT = 'users.login.failure'
+
+        # Attach login success event information to the trace
+        #
+        # This method is experimental and may change in the future.
+        #
+        # @param trace [TraceOperation] Trace to attach data to.
+        # @param user [Hash<Symbol, String>] User information to pass to
+        #   Datadog::Kit::Identity.set_user. Must contain at least :id as key.
+        # @param others [Hash<String || Symbol, String>] Additional free-form
+        #   event information to attach to the trace.
+        def self.track_login_success(trace, user:, **others)
+          track(LOGIN_SUCCESS_EVENT, trace, **others)
+
+          user_options = user.dup
+          user_id = user.delete(:id)
+
+          raise ArgumentError, 'missing required key: :user => { :id }' if user_id.nil?
+
+          Kit::Identity.set_user(trace, id: user_id, **user_options)
+        end
+
+        # Attach login failure event information to the trace
+        #
+        # This method is experimental and may change in the future.
+        #
+        # @param trace [TraceOperation] Trace to attach data to.
+        # @param user_id [String] User id that attempted login
+        # @param user_exists [bool] Whether the user id that did a login attempt exists.
+        # @param others [Hash<String || Symbol, String>] Additional free-form
+        #   event information to attach to the trace.
+        def self.track_login_failure(trace, user_id:, user_exists:, **others)
+          track(LOGIN_FAILURE_EVENT, trace, **others)
+
+          raise ArgumentError, 'user_id cannot be nil' if user_id.nil?
+
+          trace.set_tag('appsec.events.users.login.failure.usr.id', user_id)
+          trace.set_tag('appsec.events.users.login.failure.usr.exists', user_exists)
+        end
+
+        # Attach custom event information to the trace
+        #
+        # This method is experimental and may change in the future.
+        #
+        # @param event [String] Mandatory. Event code.
+        # @param trace [TraceOperation] Trace to attach data to.
+        # @param others [Hash<Symbol, String>] Additional free-form
+        #   event information to attach to the trace. Key must not
+        #   be :track.
+        def self.track(event, trace, **others)
+          trace.set_tag("appsec.events.#{event}.track", 'true')
+
+          others.each do |k, v|
+            raise ArgumentError, 'key cannot be :track' if k.to_sym == :track
+
+            trace.set_tag("appsec.events.#{event}.#{k}", v) unless v.nil?
+          end
+
+          trace.keep!
+        end
+      end
+    end
+  end
+end

data/lib/datadog/kit/enable_core_dumps.rb

@@ -0,0 +1,51 @@
+# typed: ignore
+# frozen_string_literal: true
+
+module Datadog
+  module Kit
+    # This helper is used to enable core dumps for the current Ruby app. This is useful when debugging native-level
+    # crashes.
+    #
+    # It can be enabled simply by adding `require 'datadog/kit/enable_core_dumps'` to start of the app.
+    module EnableCoreDumps
+      def self.call
+        current_size, maximum_size = Process.getrlimit(:CORE)
+        core_pattern =
+          begin
+            File.read('/proc/sys/kernel/core_pattern').strip
+          rescue
+            '(Could not open /proc/sys/kernel/core_pattern)'
+          end
+
+        if maximum_size <= 0
+          Kernel.warn("[DDTRACE] Could not enable core dumps on crash, maximum size is #{maximum_size} (disabled).")
+          return
+        elsif maximum_size == current_size
+          Kernel.warn('[DDTRACE] Core dumps already enabled, nothing to do!')
+          return
+        end
+
+        begin
+          Process.setrlimit(:CORE, maximum_size)
+        rescue => e
+          Kernel.warn(
+            "[DDTRACE] Failed to enable core dumps. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
+          )
+          return
+        end
+
+        if current_size == 0
+          Kernel.warn("[DDTRACE] Enabled core dumps. Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'")
+        else
+          Kernel.warn(
+            "[DDTRACE] Raised core dump limit. Old size: #{current_size} " \
+            "Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'"
+          )
+        end
+      end
+    end
+  end
+end
+
+Datadog::Kit::EnableCoreDumps.call