ddtrace 1.3.0 → 1.4.0

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/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/profiling/collectors/cpu_and_wall_time_worker.rb

@@ -0,0 +1,74 @@
+# typed: false
+
+module Datadog
+  module Profiling
+    module Collectors
+      # Used to trigger the periodic execution of Collectors::CpuAndWallTime, which implements all of the sampling logic
+      # itself; this class only implements the "doing it periodically" part.
+      # Almost all of this class is implemented as native code.
+      #
+      # Methods prefixed with _native_ are implemented in `collectors_cpu_and_wall_time_worker.c`
+      class CpuAndWallTimeWorker
+        private
+
+        attr_accessor :failure_exception
+
+        public
+
+        def initialize(
+          recorder:,
+          max_frames:,
+          cpu_and_wall_time_collector: CpuAndWallTime.new(recorder: recorder, max_frames: max_frames)
+        )
+          self.class._native_initialize(self, cpu_and_wall_time_collector)
+          @worker_thread = nil
+          @failure_exception = nil
+          @start_stop_mutex = Mutex.new
+        end
+
+        def start
+          @start_stop_mutex.synchronize do
+            return if @worker_thread
+
+            Datadog.logger.debug { "Starting thread for: #{self}" }
+            @worker_thread = Thread.new do
+              begin
+                Thread.current.name = self.class.name unless Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
+
+                self.class._native_sampling_loop(self)
+
+                Datadog.logger.debug('CpuAndWallTimeWorker thread stopping cleanly')
+              rescue Exception => e # rubocop:disable Lint/RescueException
+                @failure_exception = e
+                Datadog.logger.warn(
+                  "Worker thread error. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+                )
+              end
+            end
+          end
+
+          true
+        end
+
+        # TODO: Provided only for compatibility with the API for Collectors::OldStack used in the Profiler class.
+        # Can be removed once we remove OldStack.
+        def enabled=(_); end
+
+        def stop(*_)
+          @start_stop_mutex.synchronize do
+            Datadog.logger.debug('Requesting CpuAndWallTimeWorker thread shut down')
+
+            return unless @worker_thread
+
+            @worker_thread.kill
+            self.class._native_stop(self)
+
+            @worker_thread.join
+            @worker_thread = nil
+            @failure_exception = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/profiling/stack_recorder.rb

@@ -13,7 +13,7 @@ module Datadog
         # This isn't something we expect to happen normally, but because it would break the assumptions of the
         # C-level mutexes (that there is a single serializer thread), we add it here as an extra safeguard against it
         # accidentally happening.
-        @no_concurrent_synchronize_mutex = Thread::Mutex.new
+        @no_concurrent_synchronize_mutex = Mutex.new
       end
 
       def serialize

data/lib/datadog/profiling.rb

@@ -148,6 +148,7 @@ module Datadog
       require_relative 'profiling/ext/forking'
       require_relative 'profiling/collectors/code_provenance'
       require_relative 'profiling/collectors/cpu_and_wall_time'
+      require_relative 'profiling/collectors/cpu_and_wall_time_worker'
       require_relative 'profiling/collectors/old_stack'
       require_relative 'profiling/collectors/stack'
       require_relative 'profiling/stack_recorder'

data/lib/datadog/tracing/contrib/extensions.rb

@@ -97,6 +97,8 @@ module Datadog
                 Datadog.logger.warn("Unable to patch #{patch_results[:name]} (#{desc})")
               end
 
+              components.telemetry.integrations_change! if configuration.integrations_pending_activation
+
               configuration.integrations_pending_activation.clear
             end
 

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/client.rb

@@ -44,6 +44,9 @@ module Datadog
               host, _port = find_host_port(call)
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host) if host
 
+              deadline = find_deadline(call)
+              span.set_tag(Ext::TAG_CLIENT_DEADLINE, deadline) if deadline
+
               # Set analytics sample rate
               Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
@@ -60,6 +63,12 @@ module Datadog
                 .join('.')
             end
 
+            def find_deadline(call)
+              return unless call.respond_to?(:deadline) && call.deadline.is_a?(Time)
+
+              call.deadline.utc.iso8601(3)
+            end
+
             def find_host_port(call)
               return unless call
 

data/lib/datadog/tracing/contrib/grpc/ext.rb

@@ -13,6 +13,7 @@ module Datadog
           DEFAULT_PEER_SERVICE_NAME = 'grpc'.freeze
           SPAN_CLIENT = 'grpc.client'.freeze
           SPAN_SERVICE = 'grpc.service'.freeze
+          TAG_CLIENT_DEADLINE = 'grpc.client.deadline'.freeze
           TAG_COMPONENT = 'grpc'.freeze
           TAG_OPERATION_CLIENT = 'client'.freeze
           TAG_OPERATION_SERVICE = 'service'.freeze

data/lib/datadog/tracing/contrib/patcher.rb

@@ -19,6 +19,10 @@ module Datadog
         # Prepended instance methods for all patchers
         # @public_api
         module CommonMethods
+          attr_accessor \
+            :patch_error_result,
+            :patch_successful
+
           def patch_name
             self.class != Class && self.class != Module ? self.class.name : name
           end
@@ -35,6 +39,7 @@ module Datadog
                 super.tap do
                   # Emit a metric
                   Datadog.health_metrics.instrumentation_patched(1, tags: default_tags)
+                  @patch_successful = true
                 end
               rescue StandardError => e
                 on_patch_error(e)
@@ -48,6 +53,12 @@ module Datadog
             # Log the error
             Datadog.logger.error("Failed to apply #{patch_name} patch. Cause: #{e} Location: #{Array(e.backtrace).first}")
 
+            @patch_error_result = {
+              type: e.class.name,
+              message: e.message,
+              line: Array(e.backtrace).first
+            }
+
             # Emit a metric
             tags = default_tags
             tags << "error:#{e.class.name}"

data/lib/datadog/tracing/contrib/rack/patcher.rb

@@ -104,6 +104,14 @@ module Datadog
           def get_option(option)
             Datadog.configuration.tracing[:rack].get_option(option)
           end
+
+          def patch_successful
+            MiddlewarePatcher.patch_successful || MiddlewareNamePatcher.patch_successful
+          end
+
+          def patch_error_result
+            MiddlewarePatcher.patch_error_result || MiddlewareNamePatcher.patch_error_result
+          end
         end
       end
     end

data/lib/ddtrace/auto_instrument.rb

@@ -7,3 +7,10 @@ require_relative '../ddtrace'
 require_relative '../datadog/tracing/contrib/auto_instrument'
 
 Datadog::Profiling.start_if_enabled
+
+module Datadog
+  module AutoInstrument
+    # Flag to determine if Auto Instrumentation was used
+    LOADED = true
+  end
+end

data/lib/ddtrace/transport/ext.rb

@@ -9,7 +9,6 @@ module Datadog
         ADAPTER = :net_http # DEV: Rename to simply `:http`, as Net::HTTP is an implementation detail.
         DEFAULT_HOST = '127.0.0.1'.freeze
         DEFAULT_PORT = 8126
-        DEFAULT_TIMEOUT_SECONDS = 1
 
         HEADER_CONTAINER_ID = 'Datadog-Container-ID'.freeze
         HEADER_DD_API_KEY = 'DD-API-KEY'.freeze

data/lib/ddtrace/transport/http/adapters/net.rb

@@ -15,6 +15,7 @@ module Datadog
             :timeout,
             :ssl
 
+          # in seconds
           DEFAULT_TIMEOUT = 30
 
           # @deprecated Positional parameters are deprecated. Use named parameters instead.

data/lib/ddtrace/version.rb

@@ -3,7 +3,7 @@
 module DDTrace
   module VERSION
     MAJOR = 1
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0.1.0
+        version: 0.7.0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0.1.0
+        version: 0.7.0.1.1
 description: |
   ddtrace is Datadog's tracing client for Ruby. It is used to trace requests
   as they flow across web servers, databases and microservices so that developers
@@ -95,6 +95,7 @@ files:
 - ext/ddtrace_profiling_native_extension/clock_id_noop.c
 - ext/ddtrace_profiling_native_extension/collectors_cpu_and_wall_time.c
 - ext/ddtrace_profiling_native_extension/collectors_cpu_and_wall_time.h
+- ext/ddtrace_profiling_native_extension/collectors_cpu_and_wall_time_worker.c
 - ext/ddtrace_profiling_native_extension/collectors_stack.c
 - ext/ddtrace_profiling_native_extension/collectors_stack.h
 - ext/ddtrace_profiling_native_extension/extconf.rb
@@ -227,6 +228,25 @@ files:
 - lib/datadog/core/pin.rb
 - lib/datadog/core/runtime/ext.rb
 - lib/datadog/core/runtime/metrics.rb
+- lib/datadog/core/telemetry/client.rb
+- lib/datadog/core/telemetry/collector.rb
+- lib/datadog/core/telemetry/emitter.rb
+- lib/datadog/core/telemetry/event.rb
+- lib/datadog/core/telemetry/ext.rb
+- lib/datadog/core/telemetry/heartbeat.rb
+- lib/datadog/core/telemetry/http/adapters/net.rb
+- lib/datadog/core/telemetry/http/env.rb
+- lib/datadog/core/telemetry/http/ext.rb
+- lib/datadog/core/telemetry/http/response.rb
+- lib/datadog/core/telemetry/http/transport.rb
+- lib/datadog/core/telemetry/v1/app_event.rb
+- lib/datadog/core/telemetry/v1/application.rb
+- lib/datadog/core/telemetry/v1/configuration.rb
+- lib/datadog/core/telemetry/v1/dependency.rb
+- lib/datadog/core/telemetry/v1/host.rb
+- lib/datadog/core/telemetry/v1/integration.rb
+- lib/datadog/core/telemetry/v1/product.rb
+- lib/datadog/core/telemetry/v1/telemetry_request.rb
 - lib/datadog/core/utils.rb
 - lib/datadog/core/utils/compression.rb
 - lib/datadog/core/utils/forking.rb
@@ -274,6 +294,7 @@ files:
 - lib/datadog/profiling/buffer.rb
 - lib/datadog/profiling/collectors/code_provenance.rb
 - lib/datadog/profiling/collectors/cpu_and_wall_time.rb
+- lib/datadog/profiling/collectors/cpu_and_wall_time_worker.rb
 - lib/datadog/profiling/collectors/old_stack.rb
 - lib/datadog/profiling/collectors/stack.rb
 - lib/datadog/profiling/encoding/profile.rb