ddtrace 1.13.1 → 1.14.0

data/lib/datadog/tracing/diagnostics/environment_logger.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'json'
+require 'rbconfig'
+require_relative '../../core/diagnostics/environment_logger'
+
+module Datadog
+  module Tracing
+    module Diagnostics
+      # Collects and logs Tracing diagnostic and error information
+      module EnvironmentLogger
+        extend Core::Diagnostics::EnvironmentLogging
+
+        def self.collect_and_log!(responses: nil)
+          log_once! do
+            env_data = EnvironmentCollector.collect_config!
+            log_configuration!('TRACING', env_data.to_json)
+
+            if responses
+              err_data = EnvironmentCollector.collect_errors!(responses)
+              err_data.reject! { |_, v| v.nil? } # Remove empty values from hash output
+              log_error!('TRACING', 'Agent Error', err_data.to_json) unless err_data.empty?
+            end
+          end
+        rescue => e
+          logger.warn("Failed to collect tracing environment information: #{e} Location: #{Array(e.backtrace).first}")
+        end
+      end
+
+      # Collects environment information for Tracing diagnostic logging
+      module EnvironmentCollector
+        class << self
+          def collect_config!
+            {
+              enabled: enabled,
+              agent_url: agent_url,
+              analytics_enabled: analytics_enabled,
+              sample_rate: sample_rate,
+              sampling_rules: sampling_rules,
+              integrations_loaded: integrations_loaded,
+              partial_flushing_enabled: partial_flushing_enabled,
+              priority_sampling_enabled: priority_sampling_enabled,
+              **instrumented_integrations_settings
+            }
+          end
+
+          def collect_errors!(responses)
+            {
+              agent_error: agent_error(responses)
+            }
+          end
+
+          # @return [Boolean, nil]
+          def enabled
+            !!Datadog.configuration.tracing.enabled
+          end
+
+          # @return [String, nil] target agent URL for trace flushing
+          def agent_url
+            # Retrieve the effect agent URL, regardless of how it was configured
+            transport = Tracing.send(:tracer).writer.transport
+
+            # return `nil` with IO transport
+            return unless transport.respond_to?(:client)
+
+            adapter = transport.client.api.adapter
+            adapter.url
+          end
+
+          # Error returned by Datadog agent during a tracer flush attempt
+          # @return [String] concatenated list of transport errors
+          def agent_error(responses)
+            error_responses = responses.reject(&:ok?)
+
+            return nil if error_responses.empty?
+
+            error_responses.map(&:inspect).join(',')
+          end
+
+          # @return [Boolean, nil] analytics enabled in configuration
+          def analytics_enabled
+            !!Datadog.configuration.tracing.analytics.enabled
+          end
+
+          # @return [Numeric, nil] tracer sample rate configured
+          def sample_rate
+            sampler = Datadog.configuration.tracing.sampler
+            return nil unless sampler
+
+            sampler.sample_rate(nil) rescue nil
+          end
+
+          # DEV: We currently only support SimpleRule instances.
+          # DEV: These are the most commonly used rules.
+          # DEV: We should expand support for other rules in the future,
+          # DEV: although it is tricky to serialize arbitrary rules.
+          #
+          # @return [Hash, nil] sample rules configured
+          def sampling_rules
+            sampler = Datadog.configuration.tracing.sampler
+            return nil unless sampler.is_a?(Tracing::Sampling::PrioritySampler) &&
+              sampler.priority_sampler.is_a?(Tracing::Sampling::RuleSampler)
+
+            sampler.priority_sampler.rules.map do |rule|
+              next unless rule.is_a?(Tracing::Sampling::SimpleRule)
+
+              {
+                name: rule.matcher.name,
+                service: rule.matcher.service,
+                sample_rate: rule.sampler.sample_rate(nil)
+              }
+            end.compact
+          end
+
+          # Concatenated list of integrations activated, with their gem version.
+          # Example: "rails@6.0.3,rack@2.2.3"
+          #
+          # @return [String, nil]
+          def integrations_loaded
+            integrations = instrumented_integrations
+            return if integrations.empty?
+
+            integrations.map { |name, integration| "#{name}@#{integration.class.version}" }.join(',')
+          end
+
+          # @return [Boolean, nil] partial flushing enabled in configuration
+          def partial_flushing_enabled
+            !!Datadog.configuration.tracing.partial_flush.enabled
+          end
+
+          # @return [Boolean, nil] priority sampling enabled in configuration
+          def priority_sampling_enabled
+            !!Datadog.configuration.tracing.priority_sampling
+          end
+
+          private
+
+          def instrumented_integrations
+            Datadog.configuration.tracing.instrumented_integrations
+          end
+
+          # Capture all active integration settings into "integrationName_settingName: value" entries.
+          def instrumented_integrations_settings
+            instrumented_integrations.flat_map do |name, integration|
+              integration.configuration.to_h.flat_map do |setting, value|
+                next [] if setting == :tracer # Skip internal Ruby objects
+
+                # Convert value to a string to avoid custom #to_json
+                # handlers possibly causing errors.
+                [[:"integration_#{name}_#{setting}", value.to_s]]
+              end
+            end.to_h
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -57,7 +57,7 @@ module Datadog
           end
         end
 
-        # TODO: Register `Datadog::Core::Diagnostics::EnvironmentLogger.log!`
+        # TODO: Register `Datadog::Tracing::Diagnostics::EnvironmentLogger.collect_and_log!`
         # TODO: as a flush_completed subscriber when the `TraceWriter`
         # TODO: instantiation code is implemented.
         def flush_completed

data/lib/ddtrace/version.rb

@@ -3,8 +3,8 @@
 module DDTrace
   module VERSION
     MAJOR = 1
-    MINOR = 13
-    PATCH = 1
+    MINOR = 14
+    PATCH = 0
     PRE = nil
     BUILD = nil
     # PRE and BUILD above are modified for dev gems during gem build GHA workflow

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -379,6 +379,7 @@ files:
 - lib/datadog/profiling/collectors/stack.rb
 - lib/datadog/profiling/collectors/thread_context.rb
 - lib/datadog/profiling/component.rb
+- lib/datadog/profiling/diagnostics/environment_logger.rb
 - lib/datadog/profiling/encoding/profile.rb
 - lib/datadog/profiling/event.rb
 - lib/datadog/profiling/events/stack.rb
@@ -801,6 +802,7 @@ 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/diagnostics/environment_logger.rb
 - lib/datadog/tracing/diagnostics/ext.rb
 - lib/datadog/tracing/diagnostics/health.rb
 - lib/datadog/tracing/distributed/b3_multi.rb
@@ -911,7 +913,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications