ddtrace 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845f4614c8e20a84d26d9d14a22b5cddde0e1b27aeb7e093b5addf7a0cbd7490
-  data.tar.gz: 829de76d1ac7aa04f1eb9a1bd36ef3ff5fec7bfc5657015cea291fe8219ea162
+  metadata.gz: 77f5ce82c1888cc91b59b92651e262367f416298b668da0ed48ff06ec6f6fb49
+  data.tar.gz: 17857f0840b31f08f505661bf07764c79a507e670ef6d378e8bc2688b6be13eb
 SHA512:
-  metadata.gz: 6a3ed99fb7b1ddf340fa2f343f70d0f2ba456f6f45f62cd6f1a3250b05dafa2f44f18784899bd898d213eab37ca4921b618581b8faf0134c2bed325febb20c30
-  data.tar.gz: 6ef24c9b3559eb34705a4b43d325d4582bef7279627563641cae3675e26978ce92e5f953c277991866389083e57540622d232b58a44d44e4ede4fb370ff93b68
+  metadata.gz: cbfce752c4991fe0d71df92527eb3774483dbd4a669d6ff21e3483e2e4dd5caeb0da2a350fb09fd074639c9bdf032dfc166e2e1f60c8493eb98a45e14cf6d523
+  data.tar.gz: 83de702f81507366ac6afdc37b26df8e1b2df8e283a195e5e8ed5088871e0b3f7ab3035519c3cebd1f15e09935c54119e6093e3d3da010429468a6ecb4710841

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## [Unreleased]
 
+## [1.13.1] - 2023-08-14
+
+### Fixed
+
+* Tracing: `net/http` instrumentation excludes query string for `http.url` tag ([#3045][])
+* Tracing: Remove `log_tags` warning when given hash for log injection ([#3022][])
+* Tracing: Fix OpenSearch integration loading ([#3019][])
+* Core: Fix default hostname/port when mixing http and uds configuration ([#3037][])
+* Core: Disable Telemetry and Remote Configuration in development environments ([#3039][])
+* Profiling: Improve `Datadog::Profiling::HttpTransport` error logging ([#3038][])
+* Docs: Document known issues with hanging Resque workers ([#3033][])
+
 ## [1.13.0] - 2023-07-31
 
 ### Added
@@ -2503,7 +2515,8 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.3.1
 
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 
-[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v1.13.0...master
+[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v1.13.1...master
+[1.13.1]: https://github.com/DataDog/dd-trace-rb/compare/v1.13.0...1.13.1
 [1.13.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.12.1...v1.13.0
 [1.12.1]: https://github.com/DataDog/dd-trace-rb/compare/v1.12.0...v1.12.1
 [1.12.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.11.1...v1.12.0
@@ -3638,6 +3651,13 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#3005]: https://github.com/DataDog/dd-trace-rb/issues/3005
 [#3007]: https://github.com/DataDog/dd-trace-rb/issues/3007
 [#3011]: https://github.com/DataDog/dd-trace-rb/issues/3011
+[#3019]: https://github.com/DataDog/dd-trace-rb/issues/3019
+[#3022]: https://github.com/DataDog/dd-trace-rb/issues/3022
+[#3033]: https://github.com/DataDog/dd-trace-rb/issues/3033
+[#3037]: https://github.com/DataDog/dd-trace-rb/issues/3037
+[#3038]: https://github.com/DataDog/dd-trace-rb/issues/3038
+[#3039]: https://github.com/DataDog/dd-trace-rb/issues/3039
+[#3045]: https://github.com/DataDog/dd-trace-rb/issues/3045
 [@AdrianLC]: https://github.com/AdrianLC
 [@Azure7111]: https://github.com/Azure7111
 [@BabyGroot]: https://github.com/BabyGroot

data/lib/datadog/core/configuration/agent_settings_resolver.rb

@@ -95,7 +95,7 @@ module Datadog
         end
 
         def adapter
-          if should_use_uds? && !mixed_http_and_uds?
+          if should_use_uds?
             Datadog::Transport::Ext::UnixSocket::ADAPTER
           else
             Datadog::Transport::Ext::HTTP::ADAPTER
@@ -222,6 +222,10 @@ module Datadog
         end
 
         def should_use_uds?
+          can_use_uds? && !mixed_http_and_uds?
+        end
+
+        def can_use_uds?
           parsed_url && unix_scheme?(parsed_url) ||
             # If no agent settings have been provided, we try to connect using a local unix socket.
             # We only do so if the socket is present when `ddtrace` runs.
@@ -272,7 +276,7 @@ module Datadog
             'Configuration mismatch: values differ between ' \
             "#{detected_configurations_in_priority_order
               .map { |config| "#{config.friendly_name} (#{config.value.inspect})" }.join(' and ')}" \
-            ". Using #{detected_configurations_in_priority_order.first.value.inspect}."
+            ". Using #{detected_configurations_in_priority_order.first.value.inspect} and ignoring other configuration."
           )
         end
 
@@ -297,18 +301,18 @@ module Datadog
         def mixed_http_and_uds?
           return @mixed_http_and_uds if defined?(@mixed_http_and_uds)
 
-          @mixed_http_and_uds = (configured_hostname || configured_port) && should_use_uds?
+          @mixed_http_and_uds = (configured_hostname || configured_port) && can_use_uds?
 
           if @mixed_http_and_uds
             warn_if_configuration_mismatch(
               [
                 DetectedConfiguration.new(
                   friendly_name: 'configuration of hostname/port for http/https use',
-                  value: "hostname: '#{configured_hostname}', port: #{configured_port.inspect}",
+                  value: "hostname: '#{hostname}', port: '#{port}'",
                 ),
                 DetectedConfiguration.new(
                   friendly_name: 'configuration for unix domain socket',
-                  value: "unix://#{uds_path}",
+                  value: parsed_url.to_s,
                 ),
               ]
             )

data/lib/datadog/core/configuration/settings.rb

@@ -2,6 +2,7 @@ require 'logger'
 
 require_relative 'base'
 require_relative 'ext'
+require_relative '../environment/execution'
 require_relative '../environment/ext'
 require_relative '../runtime/ext'
 require_relative '../telemetry/ext'
@@ -559,10 +560,21 @@ module Datadog
           #
           # @default `DD_INSTRUMENTATION_TELEMETRY_ENABLED` environment variable, otherwise `true`.
           #   Can be disabled as documented [here](https://docs.datadoghq.com/tracing/configure_data_security/#telemetry-collection).
+          #   By default, telemetry is disabled in development environments.
           # @return [Boolean]
           option :enabled do |o|
             o.env Core::Telemetry::Ext::ENV_ENABLED
-            o.default true
+            o.default do
+              if Datadog::Core::Environment::Execution.development?
+                Datadog.logger.debug do
+                  'Development environment detected, disabling Telemetry. ' \
+                    'You can enable it with DD_INSTRUMENTATION_TELEMETRY_ENABLED=true.'
+                end
+                false
+              else
+                true
+              end
+            end
             o.type :bool
           end
 
@@ -586,10 +598,21 @@ module Datadog
           # Enable remote configuration. This allows fetching of remote configuration for live updates.
           #
           # @default `DD_REMOTE_CONFIGURATION_ENABLED` environment variable, otherwise `true`.
+          #   By default, remote configuration is disabled in development environments.
           # @return [Boolean]
           option :enabled do |o|
             o.env Core::Remote::Ext::ENV_ENABLED
-            o.default true
+            o.default do
+              if Datadog::Core::Environment::Execution.development?
+                Datadog.logger.debug do
+                  'Development environment detected, disabling Remote Configuration. ' \
+                    'You can enable it with DD_REMOTE_CONFIGURATION_ENABLED=true.'
+                end
+                false
+              else
+                true
+              end
+            end
             o.type :bool
           end
 

data/lib/datadog/core/environment/execution.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Provides information about the execution environment on the current process.
+      module Execution
+        class << self
+          # Is this process running in a development environment?
+          # This can be used to make decisions about when to enable
+          # background systems like worker threads or telemetry.
+          def development?
+            !!(repl? || test?)
+          end
+
+          private
+
+          # Is this process running a test?
+          def test?
+            rspec? || minitest?
+          end
+
+          # Is this process running inside on a Read–eval–print loop?
+          # DEV: REPLs always set the program name to the exact REPL name.
+          def repl?
+            REPL_PROGRAM_NAMES.include?($PROGRAM_NAME)
+          end
+
+          REPL_PROGRAM_NAMES = %w[irb pry].freeze
+          private_constant :REPL_PROGRAM_NAMES
+
+          # RSpec always runs using the `rspec` file https://github.com/rspec/rspec-core/blob/main/exe/rspec
+          def rspec?
+            $PROGRAM_NAME.end_with?(RSPEC_PROGRAM_NAME)
+          end
+
+          RSPEC_PROGRAM_NAME = '/rspec'
+          private_constant :RSPEC_PROGRAM_NAME
+
+          # Check if Minitest is present and installed to run.
+          def minitest?
+            # Minitest >= 5
+            (defined?(::Minitest) &&
+              ::Minitest.class_variable_defined?(:@@installed_at_exit) &&
+              ::Minitest.class_variable_get(:@@installed_at_exit)) ||
+              # Minitest < 5
+              (defined?(::Minitest::Unit) &&
+                ::Minitest::Unit.class_variable_defined?(:@@installed_at_exit) &&
+                ::Minitest::Unit.class_variable_get(:@@installed_at_exit))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/profiling/http_transport.rb

@@ -48,11 +48,14 @@ module Datadog
             Datadog.logger.debug('Successfully reported profiling data')
             true
           else
-            Datadog.logger.error("Failed to report profiling data: server returned unexpected HTTP #{result} status code")
+            Datadog.logger.error(
+              "Failed to report profiling data (#{config_without_api_key}): " \
+              "server returned unexpected HTTP #{result} status code"
+            )
             false
           end
         else
-          Datadog.logger.error("Failed to report profiling data: #{result}")
+          Datadog.logger.error("Failed to report profiling data (#{config_without_api_key}): #{result}")
           false
         end
       end
@@ -128,6 +131,10 @@ module Datadog
           internal_metadata_json,
         )
       end
+
+      def config_without_api_key
+        [@exporter_configuration[0..1]].to_h
+      end
     end
   end
 end

data/lib/datadog/tracing/contrib/http/instrumentation.rb

@@ -3,6 +3,7 @@ require 'uri'
 require_relative '../../metadata/ext'
 require_relative '../analytics'
 require_relative '../http_annotation_helper'
+require_relative '../utils/quantization/http'
 
 module Datadog
   module Tracing
@@ -79,8 +80,10 @@ module Datadog
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
-
-              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, request.path)
+              span.set_tag(
+                Tracing::Metadata::Ext::HTTP::TAG_URL,
+                Contrib::Utils::Quantization::HTTP.url(request.path, { query: { exclude: :all } })
+              )
               span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request.method)
 
               host, port = host_and_port(request)

data/lib/datadog/tracing/contrib/rails/log_injection.rb

@@ -8,9 +8,12 @@ module Datadog
           module_function
 
           # Use `app.config.log_tags` to inject propagation tags into the default Rails logger.
-          def configure_log_tags(app)
-            app.config.log_tags ||= [] # Can be nil, we initialized it if so
-            app.config.log_tags << proc { Tracing.log_correlation if Datadog.configuration.tracing.log_injection }
+          def configure_log_tags(app_config)
+            # When using SemanticLogger, app_config.log_tags could be a Hash and should not be modified here
+            return unless app_config.log_tags.nil? || app_config.log_tags.respond_to?(:<<)
+
+            app_config.log_tags ||= [] # Can be nil, we initialized it if so
+            app_config.log_tags << proc { Tracing.log_correlation if Datadog.configuration.tracing.log_injection }
           rescue StandardError => e
             Datadog.logger.warn(
               "Unable to add Datadog Trace context to ActiveSupport::TaggedLogging: #{e.class.name} #{e.message}"

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

@@ -41,7 +41,7 @@ module Datadog
               # Sometimes we don't want to activate middleware e.g. OpenTracing, etc.
               add_middleware(app) if Datadog.configuration.tracing[:rails][:middleware]
 
-              Rails::LogInjection.configure_log_tags(app)
+              Rails::LogInjection.configure_log_tags(app.config)
             end
           end
 

data/lib/datadog/tracing/contrib.rb

@@ -58,6 +58,7 @@ require_relative 'contrib/kafka/integration'
 require_relative 'contrib/lograge/integration'
 require_relative 'contrib/mongodb/integration'
 require_relative 'contrib/mysql2/integration'
+require_relative 'contrib/opensearch/integration'
 require_relative 'contrib/pg/integration'
 require_relative 'contrib/presto/integration'
 require_relative 'contrib/qless/integration'

data/lib/ddtrace/version.rb

@@ -4,7 +4,7 @@ module DDTrace
   module VERSION
     MAJOR = 1
     MINOR = 13
-    PATCH = 0
+    PATCH = 1
     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.0
+  version: 1.13.1
 platform: ruby
 authors:
 - Datadog, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -244,6 +244,7 @@ files:
 - lib/datadog/core/environment/cgroup.rb
 - lib/datadog/core/environment/class_count.rb
 - lib/datadog/core/environment/container.rb
+- lib/datadog/core/environment/execution.rb
 - lib/datadog/core/environment/ext.rb
 - lib/datadog/core/environment/gc.rb
 - lib/datadog/core/environment/identity.rb
@@ -892,7 +893,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   changelog_uri: https://github.com/DataDog/dd-trace-rb/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -910,8 +911,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.4.15
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications
 test_files: []