datadog 2.2.0 → 2.4.0

data/lib/datadog/tracing/span_operation.rb

@@ -35,7 +35,7 @@ module Datadog
         :start_time,
         :trace_id,
         :type
-      attr_accessor :links, :status
+      attr_accessor :links, :status, :span_events
 
       def initialize(
         name,
@@ -49,6 +49,7 @@ module Datadog
         trace_id: nil,
         type: nil,
         links: nil,
+        span_events: nil,
         id: nil
       )
         # Ensure dynamically created strings are UTF-8 encoded.
@@ -68,6 +69,8 @@ module Datadog
         @status = 0
         # stores array of span links
         @links = links || []
+        # stores array of span events
+        @span_events = span_events || []
 
         # start_time and end_time track wall clock. In Ruby, wall clock
         # has less accuracy than monotonic clock, so if possible we look to only use wall clock
@@ -265,7 +268,7 @@ module Datadog
 
       def set_error(e)
         @status = Metadata::Ext::Errors::STATUS
-        super
+        set_error_tags(e)
       end
 
       # Return a string representation of the span.
@@ -455,6 +458,7 @@ module Datadog
           type: @type,
           trace_id: @trace_id,
           links: @links,
+          events: @span_events,
           service_entry: parent.nil? || (service && parent.service != service)
         )
       end

data/lib/datadog/tracing/trace_operation.rb

@@ -2,7 +2,7 @@
 
 require_relative '../core/environment/identity'
 require_relative '../core/utils'
-
+require_relative 'tracer'
 require_relative 'event'
 require_relative 'metadata/tagging'
 require_relative 'sampling/ext'
@@ -75,7 +75,9 @@ module Datadog
         metrics: nil,
         trace_state: nil,
         trace_state_unknown_fields: nil,
-        remote_parent: false
+        remote_parent: false,
+        tracer: nil
+
       )
         # Attributes
         @id = id || Tracing::Utils::TraceId.next_id
@@ -98,6 +100,7 @@ module Datadog
         @profiling_enabled = profiling_enabled
         @trace_state = trace_state
         @trace_state_unknown_fields = trace_state_unknown_fields
+        @tracer = tracer
 
         # Generic tags
         set_tags(tags) if tags
@@ -161,6 +164,23 @@ module Datadog
         @resource || (root_span && root_span.resource)
       end
 
+      # When retrieving tags or metrics we need to include root span tags for sampling purposes
+      def get_tag(key)
+        super || (root_span && root_span.get_tag(key))
+      end
+
+      def get_metric(key)
+        super || (root_span && root_span.get_metric(key))
+      end
+
+      def tags
+        all_tags = {}
+        all_tags.merge!(root_span&.tags || {}) if root_span
+        all_tags.merge!(super)
+
+        all_tags
+      end
+
       # Returns true if the resource has been explicitly set
       #
       # @return [Boolean]
@@ -284,10 +304,14 @@ module Datadog
       # Returns a set of trace headers used for continuing traces.
       # Used for propagation across execution contexts.
       # Data should reflect the active state of the trace.
+      # DEV-3.0: Sampling is a side effect of generating the digest.
+      # We should move the sample call to inject and right before moving to new contexts(threads, forking etc.)
       def to_digest
         # Resolve current span ID
         span_id = @active_span && @active_span.id
         span_id ||= @parent_span_id unless finished?
+        # sample the trace_operation with the tracer
+        @tracer&.sample_trace(self) unless sampling_priority
 
         TraceDigest.new(
           span_id: span_id,

data/lib/datadog/tracing/tracer.rb

@@ -262,6 +262,17 @@ module Datadog
         context.activate!(trace, &block)
       end
 
+      # Sample a span, tagging the trace as appropriate.
+      def sample_trace(trace_op)
+        begin
+          @sampler.sample!(trace_op)
+        rescue StandardError => e
+          SAMPLE_TRACE_LOG_ONLY_ONCE.run do
+            Datadog.logger.warn { "Failed to sample trace: #{e.class.name} #{e} at #{Array(e.backtrace).first}" }
+          end
+        end
+      end
+
       # @!visibility private
       # TODO: make this private
       def trace_completed
@@ -331,12 +342,14 @@ module Datadog
             trace_state: digest.trace_state,
             trace_state_unknown_fields: digest.trace_state_unknown_fields,
             remote_parent: digest.span_remote,
+            tracer: self
           )
         else
           TraceOperation.new(
             hostname: hostname,
             profiling_enabled: profiling_enabled,
             remote_parent: false,
+            tracer: self
           )
         end
       end
@@ -347,7 +360,6 @@ module Datadog
         events.span_before_start.subscribe do |event_span_op, event_trace_op|
           event_trace_op.service ||= @default_service
           event_span_op.service ||= @default_service
-          sample_trace(event_trace_op) if event_span_op && event_span_op.parent_id == 0
         end
 
         events.span_finished.subscribe do |event_span, event_trace_op|
@@ -463,17 +475,6 @@ module Datadog
         end
       end
 
-      # Sample a span, tagging the trace as appropriate.
-      def sample_trace(trace_op)
-        begin
-          @sampler.sample!(trace_op)
-        rescue StandardError => e
-          SAMPLE_TRACE_LOG_ONLY_ONCE.run do
-            Datadog.logger.warn { "Failed to sample trace: #{e.class.name} #{e} at #{Array(e.backtrace).first}" }
-          end
-        end
-      end
-
       SAMPLE_TRACE_LOG_ONLY_ONCE = Core::Utils::OnlyOnce.new
       private_constant :SAMPLE_TRACE_LOG_ONLY_ONCE
 
@@ -492,6 +493,7 @@ module Datadog
 
       # Flush finished spans from the trace buffer, send them to writer.
       def flush_trace(trace_op)
+        sample_trace(trace_op) unless trace_op.sampling_priority
         begin
           trace = @trace_flush.consume!(trace_op)
           write(trace) if trace && !trace.empty?

data/lib/datadog/tracing/transport/http/client.rb

@@ -38,6 +38,7 @@ module Datadog
             if stats.consecutive_errors > 0
               Datadog.logger.debug(message)
             else
+              # Not to report telemetry logs
               Datadog.logger.error(message)
             end
 

data/lib/datadog/tracing/transport/io/client.rb

@@ -49,6 +49,7 @@ module Datadog
             if stats.consecutive_errors > 0
               Datadog.logger.debug(message)
             else
+              # Not to report telemetry logs
               Datadog.logger.error(message)
             end
 

data/lib/datadog/tracing/transport/serializable_trace.rb

@@ -72,6 +72,9 @@ module Datadog
             packer.write_map_header(number_of_elements_to_write) # Set header with how many elements in the map
           end
 
+          # serialize span events as meta tags
+          span.set_tag('events', span.events.map(&:to_hash).to_json) if span.events.any?
+
           # DEV: We use strings as keys here, instead of symbols, as
           # DEV: MessagePack will ultimately convert them to strings.
           # DEV: By providing strings directly, we skip this indirection operation.

data/lib/datadog/tracing/workers/trace_writer.rb

@@ -43,7 +43,7 @@ module Datadog
           traces = process_traces(traces)
           flush_traces(traces)
         rescue StandardError => e
-          Datadog.logger.error(
+          Datadog.logger.warn(
             "Error while writing traces: dropped #{traces.length} items. Cause: #{e} Location: #{Array(e.backtrace).first}"
           )
         end

data/lib/datadog/tracing/workers.rb

@@ -56,7 +56,7 @@ module Datadog
             # ensures that the thread will not die because of an exception.
             # TODO[manu]: findout the reason and reschedule the send if it's not
             # a fatal exception
-            Datadog.logger.error(
+            Datadog.logger.warn(
               "Error during traces flush: dropped #{traces.length} items. Cause: #{e} Location: #{Array(e.backtrace).first}"
             )
           end

data/lib/datadog/version.rb

@@ -3,7 +3,7 @@
 module Datadog
   module VERSION
     MAJOR = 2
-    MINOR = 2
+    MINOR = 4
     PATCH = 0
     PRE = nil
     BUILD = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0.1.0
+        version: 12.0.0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0.1.0
+        version: 12.0.0.1.0
 description: |
   datadog is Datadog's client library for Ruby. It includes a suite of tools
   which provide visibility into the performance and security of Ruby applications,
@@ -77,6 +77,7 @@ executables:
 extensions:
 - ext/datadog_profiling_native_extension/extconf.rb
 - ext/datadog_profiling_loader/extconf.rb
+- ext/libdatadog_api/extconf.rb
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
@@ -106,8 +107,11 @@ files:
 - ext/datadog_profiling_native_extension/collectors_stack.h
 - ext/datadog_profiling_native_extension/collectors_thread_context.c
 - ext/datadog_profiling_native_extension/collectors_thread_context.h
-- ext/datadog_profiling_native_extension/crashtracker.c
+- ext/datadog_profiling_native_extension/datadog_ruby_common.c
+- ext/datadog_profiling_native_extension/datadog_ruby_common.h
 - ext/datadog_profiling_native_extension/extconf.rb
+- ext/datadog_profiling_native_extension/gvl_profiling_helper.c
+- ext/datadog_profiling_native_extension/gvl_profiling_helper.h
 - ext/datadog_profiling_native_extension/heap_recorder.c
 - ext/datadog_profiling_native_extension/heap_recorder.h
 - ext/datadog_profiling_native_extension/helpers.h
@@ -126,6 +130,12 @@ files:
 - ext/datadog_profiling_native_extension/stack_recorder.h
 - ext/datadog_profiling_native_extension/time_helpers.c
 - ext/datadog_profiling_native_extension/time_helpers.h
+- ext/libdatadog_api/crashtracker.c
+- ext/libdatadog_api/datadog_ruby_common.c
+- ext/libdatadog_api/datadog_ruby_common.h
+- ext/libdatadog_api/extconf.rb
+- ext/libdatadog_api/macos_development.md
+- ext/libdatadog_extconf_helpers.rb
 - lib/datadog.rb
 - lib/datadog/appsec.rb
 - lib/datadog/appsec/assets.rb
@@ -148,8 +158,15 @@ files:
 - lib/datadog/appsec/contrib/devise/patcher.rb
 - lib/datadog/appsec/contrib/devise/patcher/authenticatable_patch.rb
 - lib/datadog/appsec/contrib/devise/patcher/registration_controller_patch.rb
+- lib/datadog/appsec/contrib/devise/patcher/rememberable_patch.rb
 - lib/datadog/appsec/contrib/devise/resource.rb
 - lib/datadog/appsec/contrib/devise/tracking.rb
+- lib/datadog/appsec/contrib/graphql/appsec_trace.rb
+- lib/datadog/appsec/contrib/graphql/gateway/multiplex.rb
+- lib/datadog/appsec/contrib/graphql/gateway/watcher.rb
+- lib/datadog/appsec/contrib/graphql/integration.rb
+- lib/datadog/appsec/contrib/graphql/patcher.rb
+- lib/datadog/appsec/contrib/graphql/reactive/multiplex.rb
 - lib/datadog/appsec/contrib/integration.rb
 - lib/datadog/appsec/contrib/patcher.rb
 - lib/datadog/appsec/contrib/rack/ext.rb
@@ -223,6 +240,9 @@ files:
 - lib/datadog/core/configuration/option_definition.rb
 - lib/datadog/core/configuration/options.rb
 - lib/datadog/core/configuration/settings.rb
+- lib/datadog/core/crashtracking/agent_base_url.rb
+- lib/datadog/core/crashtracking/component.rb
+- lib/datadog/core/crashtracking/tag_builder.rb
 - lib/datadog/core/deprecations.rb
 - lib/datadog/core/diagnostics/environment_logger.rb
 - lib/datadog/core/diagnostics/health.rb
@@ -254,6 +274,7 @@ files:
 - lib/datadog/core/metrics/metric.rb
 - lib/datadog/core/metrics/options.rb
 - lib/datadog/core/pin.rb
+- lib/datadog/core/rate_limiter.rb
 - lib/datadog/core/remote.rb
 - lib/datadog/core/remote/client.rb
 - lib/datadog/core/remote/client/capabilities.rb
@@ -291,6 +312,8 @@ files:
 - 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/logger.rb
+- lib/datadog/core/telemetry/logging.rb
 - lib/datadog/core/telemetry/metric.rb
 - lib/datadog/core/telemetry/metrics_collection.rb
 - lib/datadog/core/telemetry/metrics_manager.rb
@@ -310,6 +333,7 @@ files:
 - lib/datadog/core/transport/request.rb
 - lib/datadog/core/transport/response.rb
 - lib/datadog/core/utils.rb
+- lib/datadog/core/utils/at_fork_monkey_patch.rb
 - lib/datadog/core/utils/base64.rb
 - lib/datadog/core/utils/duration.rb
 - lib/datadog/core/utils/forking.rb
@@ -335,6 +359,16 @@ files:
 - lib/datadog/core/workers/polling.rb
 - lib/datadog/core/workers/queue.rb
 - lib/datadog/core/workers/runtime_metrics.rb
+- lib/datadog/di.rb
+- lib/datadog/di/code_tracker.rb
+- lib/datadog/di/configuration.rb
+- lib/datadog/di/configuration/settings.rb
+- lib/datadog/di/error.rb
+- lib/datadog/di/extensions.rb
+- lib/datadog/di/probe.rb
+- lib/datadog/di/probe_builder.rb
+- lib/datadog/di/redactor.rb
+- lib/datadog/di/serializer.rb
 - lib/datadog/kit.rb
 - lib/datadog/kit/appsec/events.rb
 - lib/datadog/kit/enable_core_dumps.rb
@@ -357,11 +391,9 @@ files:
 - lib/datadog/profiling/collectors/stack.rb
 - lib/datadog/profiling/collectors/thread_context.rb
 - lib/datadog/profiling/component.rb
-- lib/datadog/profiling/crashtracker.rb
 - lib/datadog/profiling/exporter.rb
 - lib/datadog/profiling/ext.rb
 - lib/datadog/profiling/ext/dir_monkey_patches.rb
-- lib/datadog/profiling/ext/forking.rb
 - lib/datadog/profiling/flush.rb
 - lib/datadog/profiling/http_transport.rb
 - lib/datadog/profiling/load_native_extension.rb
@@ -374,6 +406,7 @@ files:
 - lib/datadog/profiling/tasks/exec.rb
 - lib/datadog/profiling/tasks/help.rb
 - lib/datadog/profiling/tasks/setup.rb
+- lib/datadog/single_step_instrument.rb
 - lib/datadog/tracing.rb
 - lib/datadog/tracing/analytics.rb
 - lib/datadog/tracing/buffer.rb
@@ -407,6 +440,8 @@ files:
 - lib/datadog/tracing/contrib/action_mailer/patcher.rb
 - lib/datadog/tracing/contrib/action_pack/action_controller/instrumentation.rb
 - lib/datadog/tracing/contrib/action_pack/action_controller/patcher.rb
+- lib/datadog/tracing/contrib/action_pack/action_dispatch/instrumentation.rb
+- lib/datadog/tracing/contrib/action_pack/action_dispatch/patcher.rb
 - lib/datadog/tracing/contrib/action_pack/configuration/settings.rb
 - lib/datadog/tracing/contrib/action_pack/ext.rb
 - lib/datadog/tracing/contrib/action_pack/integration.rb
@@ -807,7 +842,6 @@ files:
 - lib/datadog/tracing/sampling/priority_sampler.rb
 - lib/datadog/tracing/sampling/rate_by_key_sampler.rb
 - lib/datadog/tracing/sampling/rate_by_service_sampler.rb
-- lib/datadog/tracing/sampling/rate_limiter.rb
 - lib/datadog/tracing/sampling/rate_sampler.rb
 - lib/datadog/tracing/sampling/rule.rb
 - lib/datadog/tracing/sampling/rule_sampler.rb
@@ -818,6 +852,7 @@ files:
 - lib/datadog/tracing/sampling/span/rule_parser.rb
 - lib/datadog/tracing/sampling/span/sampler.rb
 - lib/datadog/tracing/span.rb
+- lib/datadog/tracing/span_event.rb
 - lib/datadog/tracing/span_link.rb
 - lib/datadog/tracing/span_operation.rb
 - lib/datadog/tracing/sync_writer.rb
@@ -852,8 +887,8 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/DataDog/dd-trace-rb/blob/v2.2.0/CHANGELOG.md
-  source_code_uri: https://github.com/DataDog/dd-trace-rb/tree/v2.2.0
+  changelog_uri: https://github.com/DataDog/dd-trace-rb/blob/v2.4.0/CHANGELOG.md
+  source_code_uri: https://github.com/DataDog/dd-trace-rb/tree/v2.4.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -872,7 +907,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications

data/lib/datadog/profiling/crashtracker.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'libdatadog'
-
-module Datadog
-  module Profiling
-    # Used to report Ruby VM crashes.
-    # The interesting bits are implemented as native code and using libdatadog.
-    #
-    # NOTE: The crashtracker native state is a singleton; so even if you create multiple instances of `Crashtracker`
-    # and start them, it only works as "last writer wins". Same for stop -- there's only one state, so calling stop
-    # on it will stop the crash tracker, regardless of which instance started it.
-    #
-    # Methods prefixed with _native_ are implemented in `crashtracker.c`
-    class Crashtracker
-      private
-
-      attr_reader \
-        :exporter_configuration,
-        :tags_as_array,
-        :path_to_crashtracking_receiver_binary,
-        :ld_library_path,
-        :upload_timeout_seconds
-
-      public
-
-      def initialize(
-        exporter_configuration:,
-        tags:,
-        upload_timeout_seconds:,
-        path_to_crashtracking_receiver_binary: Libdatadog.path_to_crashtracking_receiver_binary,
-        ld_library_path: Libdatadog.ld_library_path
-      )
-        @exporter_configuration = exporter_configuration
-        @tags_as_array = tags.to_a
-        @upload_timeout_seconds = upload_timeout_seconds
-        @path_to_crashtracking_receiver_binary = path_to_crashtracking_receiver_binary
-        @ld_library_path = ld_library_path
-      end
-
-      def start
-        start_or_update_on_fork(action: :start)
-      end
-
-      def reset_after_fork
-        start_or_update_on_fork(action: :update_on_fork)
-      end
-
-      def stop
-        begin
-          self.class._native_stop
-          Datadog.logger.debug('Crash tracking stopped successfully')
-        rescue => e
-          Datadog.logger.error("Failed to stop crash tracking: #{e.message}")
-        end
-      end
-
-      private
-
-      def start_or_update_on_fork(action:)
-        unless path_to_crashtracking_receiver_binary
-          Datadog.logger.warn(
-            "Cannot #{action} profiling crash tracking as no path_to_crashtracking_receiver_binary was found"
-          )
-          return
-        end
-
-        unless ld_library_path
-          Datadog.logger.warn(
-            "Cannot #{action} profiling crash tracking as no ld_library_path was found"
-          )
-          return
-        end
-
-        begin
-          self.class._native_start_or_update_on_fork(
-            action: action,
-            exporter_configuration: exporter_configuration,
-            path_to_crashtracking_receiver_binary: path_to_crashtracking_receiver_binary,
-            ld_library_path: ld_library_path,
-            tags_as_array: tags_as_array,
-            upload_timeout_seconds: Integer(upload_timeout_seconds),
-          )
-          Datadog.logger.debug("Crash tracking #{action} successful")
-        rescue => e
-          Datadog.logger.error("Failed to #{action} crash tracking: #{e.message}")
-        end
-      end
-    end
-  end
-end

data/lib/datadog/profiling/ext/forking.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module Datadog
-  module Profiling
-    module Ext
-      # Monkey patches `Kernel#fork`, adding a `Kernel#at_fork` callback mechanism which is used to restore
-      # profiling abilities after the VM forks.
-      #
-      # Known limitations: Does not handle `BasicObject`s that include `Kernel` directly; e.g.
-      # `Class.new(BasicObject) { include(::Kernel); def call; fork { }; end }.new.call`.
-      #
-      # This will be fixed once we moved to hooking into `Process._fork`
-      module Forking
-        def self.supported?
-          Process.respond_to?(:fork)
-        end
-
-        def self.apply!
-          return false unless supported?
-
-          [
-            ::Process.singleton_class, # Process.fork
-            ::Kernel.singleton_class,  # Kernel.fork
-            ::Object,                  # fork without explicit receiver (it's defined as a method in ::Kernel)
-            # Note: Modifying Object as we do here is irreversible. During tests, this
-            # change will stick around even if we otherwise stub `Process` and `Kernel`
-          ].each { |target| target.prepend(Kernel) }
-
-          ::Process.singleton_class.prepend(ProcessDaemonPatch)
-        end
-
-        # Extensions for kernel
-        #
-        # TODO: Consider hooking into `Process._fork` on Ruby 3.1+ instead, see
-        #       https://github.com/ruby/ruby/pull/5017 and https://bugs.ruby-lang.org/issues/17795
-        module Kernel
-          def fork
-            # If a block is provided, it must be wrapped to trigger callbacks.
-            child_block = if block_given?
-                            proc do
-                              # Trigger :child callback
-                              datadog_at_fork_blocks[:child].each(&:call) if datadog_at_fork_blocks.key?(:child)
-
-                              # Invoke original block
-                              yield
-                            end
-                          end
-
-            # Start fork
-            # If a block is provided, use the wrapped version.
-            result = child_block.nil? ? super : super(&child_block)
-
-            # Trigger correct callbacks depending on whether we're in the parent or child.
-            # If we're in the fork, result = nil: trigger child callbacks.
-            # If we're in the parent, result = fork PID: trigger parent callbacks.
-            datadog_at_fork_blocks[:child].each(&:call) if result.nil? && datadog_at_fork_blocks.key?(:child)
-
-            # Return PID from #fork
-            result
-          end
-
-          def at_fork(stage, &block)
-            raise ArgumentError, 'Bad \'stage\' for ::at_fork' unless stage == :child
-
-            datadog_at_fork_blocks[stage] = [] unless datadog_at_fork_blocks.key?(stage)
-            datadog_at_fork_blocks[stage] << block
-          end
-
-          module_function
-
-          def datadog_at_fork_blocks
-            # Blocks should be shared across all users of this module,
-            # e.g. Process#fork, Kernel#fork, etc. should all invoke the same callbacks.
-            # rubocop:disable Style/ClassVars
-            @@datadog_at_fork_blocks ||= {}
-            # rubocop:enable Style/ClassVars
-          end
-        end
-
-        # A call to Process.daemon ( https://rubyapi.org/3.1/o/process#method-c-daemon ) forks the current process and
-        # keeps executing code in the child process, killing off the parent, thus effectively replacing it.
-        #
-        # This monkey patch makes the `Kernel#at_fork` mechanism defined above also work in this situation.
-        module ProcessDaemonPatch
-          def daemon(*args)
-            datadog_at_fork_blocks = Datadog::Profiling::Ext::Forking::Kernel.datadog_at_fork_blocks
-
-            result = super
-
-            datadog_at_fork_blocks[:child].each(&:call) if datadog_at_fork_blocks.key?(:child)
-
-            result
-          end
-        end
-      end
-    end
-  end
-end