ddtrace 1.7.0 → 1.8.0

data/lib/datadog/tracing/span_operation.rb

@@ -7,10 +7,11 @@ require_relative '../core/environment/identity'
 require_relative '../core/utils'
 require_relative '../core/utils/time'
 
-require_relative 'metadata/ext'
 require_relative 'event'
-require_relative 'span'
 require_relative 'metadata'
+require_relative 'metadata/ext'
+require_relative 'span'
+require_relative 'utils'
 
 module Datadog
   module Tracing
@@ -61,9 +62,9 @@ module Datadog
         self.type = type
         self.resource = resource
 
-        @id = Core::Utils.next_id
+        @id = Tracing::Utils.next_id
         @parent_id = parent_id || 0
-        @trace_id = trace_id || Core::Utils.next_id
+        @trace_id = trace_id || Tracing::Utils.next_id
 
         @status = 0
 

data/lib/datadog/tracing/trace_digest.rb

@@ -6,6 +6,70 @@ module Datadog
     # Used to propagate context and continue traces across execution boundaries.
     # @public_api
     class TraceDigest
+      # @!attribute [r] span_id
+      #   Datadog id for the currently active span.
+      #   @return [Integer]
+      # @!attribute [r] span_name
+      #   The operation name of the currently active span.
+      #   @return [String]
+      # @!attribute [r] span_resource
+      #   The resource name of the currently active span.
+      #   @return [String]
+      # @!attribute [r] span_service
+      #   The service of the currently active span.
+      #   @return [String]
+      # @!attribute [r] span_type
+      #   The type of the currently active span.
+      #   @return [String]
+      # @!attribute [r] trace_distributed_tags
+      #   Datadog-specific tags that support richer distributed tracing association.
+      #   @return [Hash<String,String>]
+      # @!attribute [r] trace_hostname
+      #   The hostname of the currently active trace. Use to attribute traces to hosts.
+      #   @return [String]
+      # @!attribute [r] trace_id
+      #   Datadog id for the currently active trace.
+      #   @return [Integer]
+      # @!attribute [r] trace_name
+      #   Operation name for the currently active trace.
+      #   @return [Integer]
+      # @!attribute [r] trace_origin
+      #   Datadog-specific attribution of this trace's creation.
+      #   @return [String]
+      # @!attribute [r] trace_process_id
+      #   The OS-specific process id.
+      #   @return [Integer]
+      # @!attribute [r] trace_resource
+      #   The resource name of the currently active trace.
+      #   @return [String]
+      # @!attribute [r] trace_runtime_id
+      #   Unique id to this Ruby process. Used to differentiate traces coming from
+      #   child processes forked from same parent process.
+      #   @return [String]
+      # @!attribute [r] trace_sampling_priority
+      #   Datadog-specific sampling decision for the currently active trace.
+      #   @return [Integer]
+      # @!attribute [r] trace_service
+      #   The service of the currently active trace.
+      #   @return [String]
+      # @!attribute [r] trace_distributed_id
+      #   The trace id extracted from a distributed context, if different from `trace_id`.
+      #
+      #   The current use case is when the distributed context has a trace id integer larger than 64-bit:
+      #   This attribute will preserve the original id, while `trace_id` will only contain the lower 64 bits.
+      #   @return [Integer]
+      #   @see https://www.w3.org/TR/trace-context/#trace-id
+      # @!attribute [r] trace_tracestate
+      #   The W3C "tracestate" extracted from a distributed context.
+      #   This field is a string representing vendor-specific distribution data.
+      #   @return [String]
+      #   @see https://www.w3.org/TR/trace-context/#tracestate-header
+      # @!attribute [r] trace_flags
+      #   The W3C "trace-flags" extracted from a distributed context. This field is an 8-bit unsigned integer.
+      #   @return [Integer]
+      #   @see https://www.w3.org/TR/trace-context/#trace-flags
+      # TODO: The documentation for the last attribute above won't be rendered.
+      # TODO: This might be a YARD bug as adding an attribute, making it now second-last attribute, renders correctly.
       attr_reader \
         :span_id,
         :span_name,
@@ -21,7 +85,10 @@ module Datadog
         :trace_resource,
         :trace_runtime_id,
         :trace_sampling_priority,
-        :trace_service
+        :trace_service,
+        :trace_distributed_id,
+        :trace_flags,
+        :trace_state
 
       def initialize(
         span_id: nil,
@@ -38,7 +105,10 @@ module Datadog
         trace_resource: nil,
         trace_runtime_id: nil,
         trace_sampling_priority: nil,
-        trace_service: nil
+        trace_service: nil,
+        trace_distributed_id: nil,
+        trace_flags: nil,
+        trace_state: nil
       )
         @span_id = span_id
         @span_name = span_name && span_name.dup.freeze
@@ -55,6 +125,9 @@ module Datadog
         @trace_runtime_id = trace_runtime_id && trace_runtime_id.dup.freeze
         @trace_sampling_priority = trace_sampling_priority
         @trace_service = trace_service && trace_service.dup.freeze
+        @trace_distributed_id = trace_distributed_id
+        @trace_flags = trace_flags
+        @trace_state = trace_state && trace_state.dup.freeze
 
         freeze
       end

data/lib/datadog/tracing/trace_operation.rb

@@ -4,12 +4,13 @@ require_relative '../core'
 require_relative '../core/environment/identity'
 require_relative '../core/utils'
 
-require_relative 'sampling/ext'
 require_relative 'event'
+require_relative 'metadata/tagging'
+require_relative 'sampling/ext'
 require_relative 'span_operation'
-require_relative 'trace_segment'
 require_relative 'trace_digest'
-require_relative 'metadata/tagging'
+require_relative 'trace_segment'
+require_relative 'utils'
 
 module Datadog
   module Tracing
@@ -70,7 +71,7 @@ module Datadog
         metrics: nil
       )
         # Attributes
-        @id = id || Core::Utils.next_id
+        @id = id || Tracing::Utils.next_id
         @max_length = max_length || DEFAULT_MAX_LENGTH
         @parent_span_id = parent_span_id
         @sampled = sampled.nil? ? true : sampled

data/lib/datadog/tracing/utils.rb

@@ -0,0 +1,50 @@
+# typed: true
+
+require_relative '../core/utils/forking'
+
+module Datadog
+  module Tracing
+    # Utils contains low-level tracing utility functions.
+    # @public_api
+    module Utils
+      extend Datadog::Core::Utils::Forking
+
+      # The max value for a {Datadog::Tracing::Span} identifier.
+      # Span and trace identifiers should be strictly positive and strictly inferior to this limit.
+      #
+      # Limited to +2<<62-1+ positive integers, as Ruby is able to represent such numbers "inline",
+      # inside a +VALUE+ scalar, thus not requiring memory allocation.
+      #
+      # The range of IDs also has to consider portability across different languages and platforms.
+      RUBY_MAX_ID = (1 << 62) - 1
+
+      # Excludes zero from possible values
+      RUBY_ID_RANGE = (1..RUBY_MAX_ID).freeze
+
+      # While we only generate 63-bit integers due to limitations in other languages, we support
+      # parsing 64-bit integers for distributed tracing since an upstream system may generate one
+      EXTERNAL_MAX_ID = 1 << 64
+
+      # 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(RUBY_ID_RANGE)
+      end
+
+      def self.id_rng
+        @id_rng ||= Random.new
+      end
+
+      def self.reset!
+        @id_rng = Random.new
+      end
+
+      private_class_method :id_rng, :reset!
+    end
+  end
+end

data/lib/ddtrace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -102,6 +102,10 @@ files:
 - 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_dynamic_sampling_rate.c
+- ext/ddtrace_profiling_native_extension/collectors_dynamic_sampling_rate.h
+- ext/ddtrace_profiling_native_extension/collectors_idle_sampling_helper.c
+- ext/ddtrace_profiling_native_extension/collectors_idle_sampling_helper.h
 - ext/ddtrace_profiling_native_extension/collectors_stack.c
 - ext/ddtrace_profiling_native_extension/collectors_stack.h
 - ext/ddtrace_profiling_native_extension/extconf.rb
@@ -118,6 +122,8 @@ files:
 - ext/ddtrace_profiling_native_extension/setup_signal_handler.h
 - ext/ddtrace_profiling_native_extension/stack_recorder.c
 - ext/ddtrace_profiling_native_extension/stack_recorder.h
+- ext/ddtrace_profiling_native_extension/time_helpers.c
+- ext/ddtrace_profiling_native_extension/time_helpers.h
 - lib/datadog/appsec.rb
 - lib/datadog/appsec/assets.rb
 - lib/datadog/appsec/assets/blocked.html
@@ -204,6 +210,7 @@ files:
 - lib/datadog/core/configuration/base.rb
 - lib/datadog/core/configuration/components.rb
 - lib/datadog/core/configuration/dependency_resolver.rb
+- lib/datadog/core/configuration/ext.rb
 - lib/datadog/core/configuration/option.rb
 - lib/datadog/core/configuration/option_definition.rb
 - lib/datadog/core/configuration/option_definition_set.rb
@@ -211,7 +218,6 @@ files:
 - lib/datadog/core/configuration/options.rb
 - lib/datadog/core/configuration/settings.rb
 - lib/datadog/core/diagnostics/environment_logger.rb
-- lib/datadog/core/diagnostics/ext.rb
 - lib/datadog/core/diagnostics/health.rb
 - lib/datadog/core/encoding.rb
 - lib/datadog/core/environment/cgroup.rb
@@ -307,6 +313,8 @@ files:
 - 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/dynamic_sampling_rate.rb
+- lib/datadog/profiling/collectors/idle_sampling_helper.rb
 - lib/datadog/profiling/collectors/old_stack.rb
 - lib/datadog/profiling/collectors/stack.rb
 - lib/datadog/profiling/encoding/profile.rb
@@ -344,6 +352,7 @@ files:
 - lib/datadog/tracing/buffer.rb
 - lib/datadog/tracing/client_ip.rb
 - lib/datadog/tracing/configuration/ext.rb
+- lib/datadog/tracing/configuration/settings.rb
 - lib/datadog/tracing/context.rb
 - lib/datadog/tracing/context_provider.rb
 - lib/datadog/tracing/contrib.rb
@@ -631,6 +640,7 @@ files:
 - lib/datadog/tracing/contrib/redis/patcher.rb
 - lib/datadog/tracing/contrib/redis/quantize.rb
 - lib/datadog/tracing/contrib/redis/tags.rb
+- lib/datadog/tracing/contrib/redis/trace_middleware.rb
 - lib/datadog/tracing/contrib/redis/vendor/LICENSE
 - lib/datadog/tracing/contrib/redis/vendor/resolver.rb
 - lib/datadog/tracing/contrib/registerable.rb
@@ -698,14 +708,18 @@ files:
 - lib/datadog/tracing/contrib/utils/quantization/hash.rb
 - lib/datadog/tracing/contrib/utils/quantization/http.rb
 - lib/datadog/tracing/correlation.rb
-- lib/datadog/tracing/distributed/b3.rb
+- lib/datadog/tracing/diagnostics/ext.rb
+- lib/datadog/tracing/diagnostics/health.rb
+- lib/datadog/tracing/distributed/b3_multi.rb
 - lib/datadog/tracing/distributed/b3_single.rb
 - lib/datadog/tracing/distributed/datadog.rb
 - lib/datadog/tracing/distributed/datadog_tags_codec.rb
 - lib/datadog/tracing/distributed/fetcher.rb
 - lib/datadog/tracing/distributed/headers/ext.rb
 - lib/datadog/tracing/distributed/helpers.rb
+- lib/datadog/tracing/distributed/none.rb
 - lib/datadog/tracing/distributed/propagation.rb
+- lib/datadog/tracing/distributed/trace_context.rb
 - lib/datadog/tracing/event.rb
 - lib/datadog/tracing/flush.rb
 - lib/datadog/tracing/metadata.rb
@@ -741,6 +755,7 @@ files:
 - lib/datadog/tracing/trace_operation.rb
 - lib/datadog/tracing/trace_segment.rb
 - lib/datadog/tracing/tracer.rb
+- lib/datadog/tracing/utils.rb
 - lib/datadog/tracing/workers.rb
 - lib/datadog/tracing/workers/trace_writer.rb
 - lib/datadog/tracing/writer.rb
@@ -801,7 +816,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications