ddtrace 1.0.0.beta1 → 1.1.0

data/lib/datadog/tracing/contrib/elasticsearch/quantize.rb

@@ -1,6 +1,7 @@
 require 'datadog/tracing/contrib/utils/quantization/hash'
 
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/ethon/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/ethon/ext'
 

data/lib/datadog/tracing/contrib/ethon/easy_patch.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'uri'
 
 require 'datadog/tracing'
@@ -157,7 +158,7 @@ module Datadog
             # rubocop:enable Lint/SuppressedException
 
             def load_datadog_configuration_for(host = :default)
-              @datadog_configuration = Datadog.configuration[:ethon, host]
+              @datadog_configuration = Datadog.configuration.tracing[:ethon, host]
             end
 
             def analytics_enabled?

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/ethon/integration.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 require 'datadog/tracing/contrib/ethon/configuration/settings'
 require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'

data/lib/datadog/tracing/contrib/ethon/multi_patch.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing'
 require 'datadog/tracing/metadata/ext'
 require 'datadog/tracing/propagation/http'
@@ -77,7 +78,7 @@ module Datadog
             end
 
             def datadog_configuration
-              Datadog.configuration[:ethon]
+              Datadog.configuration.tracing[:ethon]
             end
 
             def analytics_enabled?

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

@@ -1,5 +1,5 @@
 # typed: true
-require 'datadog/tracing/contrib/ethon/integration'
+
 require 'datadog/tracing/contrib/patcher'
 
 module Datadog

data/lib/datadog/tracing/contrib/excon/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/excon/ext'
 

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/excon/integration.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 require 'datadog/tracing/contrib/excon/configuration/settings'
 require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'

data/lib/datadog/tracing/contrib/excon/middleware.rb

@@ -1,4 +1,5 @@
 # typed: ignore
+
 require 'excon'
 
 require 'datadog/core'
@@ -160,7 +161,7 @@ module Datadog
           end
 
           def datadog_configuration(host = :default)
-            Datadog.configuration[:excon, host]
+            Datadog.configuration.tracing[:excon, host]
           end
         end
       end

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/patcher'
 
 module Datadog

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

@@ -1,11 +1,12 @@
 # typed: false
-require 'forwardable'
+
 require 'set'
 
 require 'datadog/core/configuration/settings'
-require 'datadog/tracing/contrib'
 
+# Datadog
 module Datadog
+  # Datadog tracing
   module Tracing
     module Contrib
       # Extensions that can be added to the base library
@@ -20,7 +21,12 @@ module Datadog
         def self.extend!
           Datadog.singleton_class.prepend Helpers
           Datadog.singleton_class.prepend Configuration
-          Core::Configuration::Settings.include Configuration::Settings
+
+          # DEV: We want settings to only apply to the `tracing` subgroup.
+          #      Until we have a better API of accessing that settings class,
+          #      we have to dig into it like this.
+          settings_class = Core::Configuration::Settings.options[:tracing].default.call.class
+          settings_class.include(Configuration::Settings)
         end
 
         # Helper methods for Datadog module.
@@ -60,10 +66,15 @@ module Datadog
             super(&block)
 
             # Activate integrations
-            configuration = self.configuration
+            configuration = self.configuration.tracing
 
             if configuration.respond_to?(:integrations_pending_activation)
-              reduce_verbosity = configuration.respond_to?(:reduce_verbosity?) ? configuration.reduce_verbosity? : false
+              ignore_integration_load_errors = if configuration.respond_to?(:ignore_integration_load_errors?)
+                                                 configuration.ignore_integration_load_errors?
+                                               else
+                                                 false
+                                               end
+
               configuration.integrations_pending_activation.each do |integration|
                 next unless integration.respond_to?(:patch)
 
@@ -74,7 +85,7 @@ module Datadog
 
                 # if patching failed, only log output if verbosity is unset
                 # or if patching failure is due to compatibility or integration specific reasons
-                next unless !reduce_verbosity ||
+                next unless !ignore_integration_load_errors ||
                             ((patch_results[:available] && patch_results[:loaded]) &&
                             (!patch_results[:compatible] || !patch_results[:patchable]))
 
@@ -97,37 +108,52 @@ module Datadog
           module Settings
             InvalidIntegrationError = Class.new(StandardError)
 
-            # For the provided `integration_name`, resolves a matching configuration
-            # for the provided integration from an integration-specific `key`.
+            # Applies instrumentation for the provided `integration_name`.
             #
-            # How the matching is performed is integration-specific.
+            # Options may be provided, that are specific to that instrumentation.
+            # See the instrumentation's settings file for a list of available options.
             #
             # @example
-            #   Datadog.configuration[:integration_name]
+            #   Datadog.configure { |c| c.tracing.instrument :integration_name }
             # @example
-            #   Datadog.configuration[:integration_name][:sub_configuration]
+            #   Datadog.configure { |c| c.tracing.instrument :integration_name, option_key: :option_value }
             # @param [Symbol] integration_name the integration name
-            # @param [Object] key the integration-specific lookup key
-            # @return [Datadog::Tracing::Contrib::Configuration::Settings]
-            def [](integration_name, key = :default)
+            # @param [Hash] options the integration-specific configuration settings
+            # @return [Datadog::Tracing::Contrib::Integration]
+            def instrument(integration_name, options = {}, &block)
               integration = fetch_integration(integration_name)
-              integration.resolve(key) unless integration.nil?
+
+              unless integration.nil? || !integration.default_configuration.enabled
+                configuration_name = options[:describes] || :default
+                filtered_options = options.reject { |k, _v| k == :describes }
+                integration.configure(configuration_name, filtered_options, &block)
+                instrumented_integrations[integration_name] = integration
+
+                # Add to activation list
+                integrations_pending_activation << integration
+              end
+
+              integration
             end
 
-            # For the provided `integration_name`, retrieves a configuration previously
-            # stored by `#instrument`. Specifically, `describes` should be
-            # the same value provided in the `describes:` option for `#instrument`.
+            # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
+            alias_method :use, :instrument
+
+            # For the provided `integration_name`, resolves a matching configuration
+            # for the provided integration from an integration-specific `key`.
             #
-            # If no `describes` value is provided, the default configuration is returned.
+            # How the matching is performed is integration-specific.
             #
+            # @example
+            #   Datadog.configuration.tracing[:integration_name]
+            # @example
+            #   Datadog.configuration.tracing[:integration_name][:sub_configuration]
             # @param [Symbol] integration_name the integration name
-            # @param [Object] describes the previously configured `describes:` object. If `nil`,
-            #   fetches the default configuration
+            # @param [Object] key the integration-specific lookup key
             # @return [Datadog::Tracing::Contrib::Configuration::Settings]
-            # @!visibility private
-            def configuration(integration_name, describes = nil)
+            def [](integration_name, key = :default)
               integration = fetch_integration(integration_name)
-              integration.configuration(describes) unless integration.nil?
+              integration.resolve(key) unless integration.nil?
             end
 
             # @!visibility private
@@ -153,32 +179,19 @@ module Datadog
             end
 
             # @!visibility private
-            def reduce_verbosity?
-              defined?(@reduce_verbosity) ? @reduce_verbosity : false
-            end
-
-            def reduce_log_verbosity
-              @reduce_verbosity ||= true
+            def ignore_integration_load_errors?
+              defined?(@ignore_integration_load_errors) ? @ignore_integration_load_errors == true : false
             end
 
-            private
-
-            def instrument(integration_name, options = {}, &block)
-              integration = fetch_integration(integration_name)
-
-              unless integration.nil? || !integration.default_configuration.enabled
-                configuration_name = options[:describes] || :default
-                filtered_options = options.reject { |k, _v| k == :describes }
-                integration.configure(configuration_name, filtered_options, &block)
-                instrumented_integrations[integration_name] = integration
-
-                # Add to activation list
-                integrations_pending_activation << integration
-              end
+            def ignore_integration_load_errors=(value)
+              @ignore_integration_load_errors = value
             end
           end
         end
       end
     end
   end
+
+  # Load built-in Datadog integrations
+  Tracing::Contrib::Extensions.extend!
 end

data/lib/datadog/tracing/contrib/faraday/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/faraday/ext'
 

data/lib/datadog/tracing/contrib/faraday/connection.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/faraday/integration.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'
 require 'datadog/tracing/contrib/faraday/configuration/settings'

data/lib/datadog/tracing/contrib/faraday/middleware.rb

@@ -1,4 +1,5 @@
 # typed: ignore
+
 require 'faraday'
 
 require 'datadog/tracing'
@@ -83,7 +84,7 @@ module Datadog
           end
 
           def datadog_configuration(host = :default)
-            Datadog.configuration[:faraday, host]
+            Datadog.configuration.tracing[:faraday, host]
           end
         end
       end

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

@@ -1,7 +1,7 @@
 # typed: false
+
 require 'datadog/tracing/contrib/faraday/connection'
 require 'datadog/tracing/contrib/faraday/ext'
-require 'datadog/tracing/contrib/faraday/integration'
 require 'datadog/tracing/contrib/faraday/rack_builder'
 require 'datadog/tracing/contrib/patcher'
 

data/lib/datadog/tracing/contrib/faraday/rack_builder.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/grape/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/grape/ext'
 require 'datadog/tracing/contrib/status_code_matcher'

data/lib/datadog/tracing/contrib/grape/endpoint.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core'
 require 'datadog/tracing'
 require 'datadog/tracing/metadata/ext'
@@ -236,11 +237,12 @@ module Datadog
             end
 
             def enabled?
-              datadog_configuration[:enabled] == true
+              Datadog.configuration.tracing.enabled && \
+                datadog_configuration[:enabled] == true
             end
 
             def datadog_configuration
-              Datadog.configuration[:grape]
+              Datadog.configuration.tracing[:grape]
             end
           end
         end

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/grape/integration.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 require 'datadog/tracing/contrib/grape/configuration/settings'
 require 'datadog/tracing/contrib/grape/patcher'

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

@@ -1,8 +1,8 @@
 # typed: true
+
 require 'datadog/tracing/contrib/grape/endpoint'
 require 'datadog/tracing/contrib/grape/ext'
 require 'datadog/tracing/contrib/grape/instrumentation'
-require 'datadog/tracing/contrib/grape/integration'
 require 'datadog/tracing/contrib/patcher'
 
 module Datadog

data/lib/datadog/tracing/contrib/graphql/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/graphql/ext'
 

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -6,11 +7,11 @@ module Datadog
         # GraphQL integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          APP = 'ruby-graphql'.freeze
           ENV_ENABLED = 'DD_TRACE_GRAPHQL_ENABLED'.freeze
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'.freeze
-          SERVICE_NAME = 'ruby-graphql'.freeze
+          SERVICE_NAME = 'graphql'.freeze
+          TAG_COMPONENT = 'graphql'.freeze
         end
       end
     end

data/lib/datadog/tracing/contrib/graphql/integration.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 require 'datadog/tracing/contrib/graphql/configuration/settings'
 require 'datadog/tracing/contrib/graphql/patcher'

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

@@ -1,7 +1,7 @@
 # typed: false
+
 require 'datadog/tracing'
 require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/graphql/integration'
 require 'datadog/tracing/contrib/patcher'
 
 module Datadog
@@ -19,9 +19,11 @@ module Datadog
           end
 
           def patch
-            return if get_option(:schemas).nil?
+            if (schemas = get_option(:schemas))
+              schemas.each { |s| patch_schema!(s) }
+            end
 
-            get_option(:schemas).each { |s| patch_schema!(s) }
+            patch_legacy_gem!
           end
 
           def patch_schema!(schema)
@@ -54,8 +56,33 @@ module Datadog
             end
           end
 
+          # Before https://github.com/rmosolgo/graphql-ruby/pull/4038 was introduced,
+          # we were left with incompatibilities between ddtrace 1.0 and older graphql gem versions.
+          def patch_legacy_gem!
+            return unless Gem::Version.new(::GraphQL::VERSION) <= Gem::Version.new('2.0.6')
+
+            ::GraphQL::Tracing::DataDogTracing.prepend(PatchLegacyGem)
+          end
+
           def get_option(option)
-            Datadog.configuration[:graphql].get_option(option)
+            Datadog.configuration.tracing[:graphql].get_option(option)
+          end
+
+          # Patches the graphql gem to support ddtrace 1.0.
+          # This is not necessary in versions containing https://github.com/rmosolgo/graphql-ruby/pull/4038.
+          module PatchLegacyGem
+            # Ensure invocation to #trace method targets the new namespaced public API object,
+            # instead of the old global Datadog.trace.
+            # This is fixed in graphql > 2.0.3.
+            def tracer
+              options.fetch(:tracer, Datadog::Tracing) # GraphQL will invoke #trace on the returned object
+            end
+
+            # Ensure resource name is not left as `nil`.
+            # This is fixed in graphql > 2.0.6.
+            def fallback_transaction_name(context)
+              context[:tracing_fallback_transaction_name] || 'execute.graphql'
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/grpc/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/span_operation'
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/grpc/ext'

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

@@ -1,4 +1,5 @@
 # typed: ignore
+
 require 'datadog/tracing'
 require 'datadog/tracing/metadata/ext'
 require 'datadog/tracing/contrib/analytics'

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

@@ -1,4 +1,5 @@
 # typed: ignore
+
 require 'datadog/tracing'
 require 'datadog/tracing/distributed/headers/ext'
 require 'datadog/tracing/metadata/ext'

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

@@ -1,4 +1,5 @@
 # typed: ignore
+
 require 'datadog/tracing'
 require 'datadog/tracing/contrib/analytics'
 require 'datadog/tracing/contrib/grpc/ext'
@@ -41,7 +42,7 @@ module Datadog
             private
 
             def datadog_configuration
-              Datadog.configuration[:grpc]
+              Datadog.configuration.tracing[:grpc]
             end
 
             def service_name
@@ -80,7 +81,7 @@ module Datadog
                 define_method(option) do
                   return @options[option] if @options.key?(option)
 
-                  Datadog.configuration[:grpc][option]
+                  Datadog.configuration.tracing[:grpc][option]
                 end
               end
 

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 require 'datadog/tracing/contrib/grpc/configuration/settings'
 require 'datadog/tracing/contrib/grpc/patcher'

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require_relative 'datadog_interceptor'
 
 module Datadog

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

@@ -1,6 +1,6 @@
 # typed: true
+
 require 'datadog/tracing/contrib/grpc/ext'
-require 'datadog/tracing/contrib/grpc/integration'
 require 'datadog/tracing/contrib/patcher'
 
 module Datadog

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing'
 require 'ddtrace/transport/ext'
 
@@ -34,7 +35,7 @@ module Datadog
           def should_skip_distributed_tracing?(client_config)
             return !client_config[:distributed_tracing] if client_config && client_config.key?(:distributed_tracing)
 
-            !Datadog.configuration[:http][:distributed_tracing]
+            !Datadog.configuration.tracing[:http][:distributed_tracing]
           end
         end
       end

data/lib/datadog/tracing/contrib/http/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/http/ext'
 

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'uri'
 
 require 'datadog/tracing'
@@ -120,7 +121,7 @@ module Datadog
             end
 
             def datadog_configuration(host = :default)
-              Datadog.configuration[:http, host]
+              Datadog.configuration.tracing[:http, host]
             end
 
             def analytics_enabled?(request_options)

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'
 require 'datadog/tracing/contrib/http/circuit_breaker'
 require 'datadog/tracing/contrib/http/configuration/settings'

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/contrib/patcher'
 require 'datadog/tracing/contrib/http/ext'
 require 'datadog/tracing/contrib/http/instrumentation'

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/tracing/contrib/httpclient/ext'