ddtrace 0.16.1 → 0.17.0

data/lib/ddtrace/contrib/grape/patcher.rb

@@ -1,48 +1,44 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/grape/ext'
+
 module Datadog
   module Contrib
     module Grape
-      SERVICE = 'grape'.freeze
-
-      # Patcher that introduces more instrumentation for Grape endpoints, so that
-      # new signals are executed at the beginning of each step (filters, render and run)
+      # Patcher enables patching of 'grape' module.
       module Patcher
-        include Base
-        register_as :grape, auto_patch: true
-        option :service_name, default: SERVICE
-
-        @patched = false
+        include Contrib::Patcher
 
         module_function
 
         def patched?
-          @patched
+          done?(:grape)
         end
 
         def patch
-          if !@patched && defined?(::Grape)
+          do_once(:grape) do
             begin
-              # do not require these by default, but only when actually patching
-              require 'ddtrace'
-              require 'ddtrace/ext/app_types'
               require 'ddtrace/contrib/grape/endpoint'
 
-              @patched = true
-              # patch all endpoints
-              patch_endpoint_run()
-              patch_endpoint_render()
+              # Patch all endpoints
+              patch_endpoint_run
+              patch_endpoint_render
 
-              # attach a PIN object globally and set the service once
-              service = get_option(:service_name)
-              pin = Datadog::Pin.new(service, app: 'grape', app_type: Datadog::Ext::AppTypes::WEB)
+              # Attach a Pin object globally and set the service once
+              pin = Datadog::Pin.new(
+                get_option(:service_name),
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::WEB,
+                tracer: get_option(:tracer)
+              )
               pin.onto(::Grape)
 
-              # subscribe to ActiveSupport events
-              Datadog::Contrib::Grape::Endpoint.subscribe()
+              # Subscribe to ActiveSupport events
+              Datadog::Contrib::Grape::Endpoint.subscribe
             rescue StandardError => e
               Datadog::Tracer.log.error("Unable to apply Grape integration: #{e}")
             end
           end
-          @patched
         end
 
         def patch_endpoint_run
@@ -69,6 +65,10 @@ module Datadog
             end
           end
         end
+
+        def get_option(option)
+          Datadog.configuration[:grape].get_option(option)
+        end
       end
     end
   end

data/lib/ddtrace/contrib/graphql/configuration/settings.rb

@@ -0,0 +1,20 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/graphql/ext'
+
+module Datadog
+  module Contrib
+    module GraphQL
+      module Configuration
+        # Custom settings for the GraphQL integration
+        class Settings < Contrib::Configuration::Settings
+          option :schemas
+          option :service_name, default: Ext::SERVICE_NAME, depends_on: [:tracer] do |value|
+            get_option(:tracer).set_service_info(value, Ext::APP, Datadog::Ext::AppTypes::WEB)
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/ext.rb

@@ -0,0 +1,11 @@
+module Datadog
+  module Contrib
+    module GraphQL
+      # GraphQL integration constants
+      module Ext
+        APP = 'ruby-graphql'.freeze
+        SERVICE_NAME = 'ruby-graphql'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/integration.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/graphql/configuration/settings'
+require 'ddtrace/contrib/graphql/patcher'
+
+module Datadog
+  module Contrib
+    module GraphQL
+      # Description of GraphQL integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :graphql, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version
+        end
+
+        def self.present?
+          super && defined?(::GraphQL)
+        end
+
+        def self.compatible?
+          super \
+            && defined?(::GraphQL::Tracing::DataDogTracing) \
+            && version >= Gem::Version.new('1.7.9')
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/patcher.rb

@@ -1,63 +1,55 @@
-require 'ddtrace/ext/app_types'
-require 'ddtrace/ext/http'
+require 'ddtrace/contrib/patcher'
 
 module Datadog
   module Contrib
     module GraphQL
       # Provides instrumentation for `graphql` through the GraphQL tracing framework
       module Patcher
-        include Base
-        register_as :graphql
+        include Contrib::Patcher
 
-        option :tracer, default: Datadog.tracer
-        option :service_name, default: 'ruby-graphql', depends_on: [:tracer] do |value|
-          get_option(:tracer).set_service_info(value, 'ruby-graphql', Ext::AppTypes::WEB)
-          value
-        end
-        option :schemas
+        module_function
 
-        class << self
-          def patch
-            return patched? if patched? || !compatible? || get_option(:schemas).nil?
+        def patched?
+          done?(:graphql)
+        end
 
-            get_option(:schemas).each { |s| patch_schema!(s) }
+        def patch
+          return if get_option(:schemas).nil?
 
-            @patched = true
+          do_once(:graphql) do
+            begin
+              require 'ddtrace/ext/app_types'
+              require 'ddtrace/ext/http'
+              get_option(:schemas).each { |s| patch_schema!(s) }
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply GraphQL integration: #{e}")
+            end
           end
+        end
 
-          def patch_schema!(schema)
-            tracer = get_option(:tracer)
-            service_name = get_option(:service_name)
-
-            if schema.respond_to?(:use)
-              schema.use(
+        def patch_schema!(schema)
+          tracer = get_option(:tracer)
+          service_name = get_option(:service_name)
+
+          if schema.respond_to?(:use)
+            schema.use(
+              ::GraphQL::Tracing::DataDogTracing,
+              tracer: tracer,
+              service: service_name
+            )
+          else
+            schema.define do
+              use(
                 ::GraphQL::Tracing::DataDogTracing,
                 tracer: tracer,
                 service: service_name
               )
-            else
-              schema.define do
-                use(
-                  ::GraphQL::Tracing::DataDogTracing,
-                  tracer: tracer,
-                  service: service_name
-                )
-              end
             end
           end
+        end
 
-          def patched?
-            return @patched if defined?(@patched)
-            @patched = false
-          end
-
-          private
-
-          def compatible?
-            defined?(::GraphQL) \
-              && defined?(::GraphQL::Tracing::DataDogTracing) \
-              && Gem.loaded_specs['graphql'].version >= Gem::Version.new('1.7.9')
-          end
+        def get_option(option)
+          Datadog.configuration[:graphql].get_option(option)
         end
       end
     end

data/lib/ddtrace/contrib/grpc/configuration/settings.rb

@@ -0,0 +1,15 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      module Configuration
+        # Custom settings for the gRPC integration
+        class Settings < Contrib::Configuration::Settings
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/datadog_interceptor/client.rb

@@ -1,3 +1,6 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/grpc/ext'
+
 module Datadog
   module Contrib
     module GRPC
@@ -11,12 +14,12 @@ module Datadog
             keywords[:metadata] ||= {}
 
             options = {
-              span_type: Datadog::Ext::GRPC::TYPE,
+              span_type: Datadog::Ext::HTTP::TYPE,
               service: datadog_pin.service_name,
               resource: format_resource(keywords[:method])
             }
 
-            tracer.trace('grpc.client', options) do |span|
+            tracer.trace(Ext::SPAN_CLIENT, options) do |span|
               annotate!(span, keywords[:metadata])
 
               yield

data/lib/ddtrace/contrib/grpc/datadog_interceptor/server.rb

@@ -1,3 +1,6 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/grpc/ext'
+
 module Datadog
   module Contrib
     module GRPC
@@ -10,7 +13,7 @@ module Datadog
         class Server < Base
           def trace(keywords)
             options = {
-              span_type: Datadog::Ext::GRPC::TYPE,
+              span_type: Datadog::Ext::HTTP::TYPE,
               service: datadog_pin.service_name,
               resource: format_resource(keywords[:method])
             }
@@ -18,7 +21,7 @@ module Datadog
 
             set_distributed_context!(tracer, metadata)
 
-            tracer.trace('grpc.service', options) do |span|
+            tracer.trace(Ext::SPAN_SERVICE, options) do |span|
               annotate!(span, metadata)
 
               yield

data/lib/ddtrace/contrib/grpc/ext.rb

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module GRPC
+      # gRPC integration constants
+      module Ext
+        APP = 'grpc'.freeze
+        SERVICE_NAME = 'grpc'.freeze
+
+        SPAN_CLIENT = 'grpc.client'.freeze
+        SPAN_SERVICE = 'grpc.service'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/integration.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/grpc/configuration/settings'
+require 'ddtrace/contrib/grpc/patcher'
+
+module Datadog
+  module Contrib
+    module GRPC
+      # Description of gRPC integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :grpc, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['grpc'] && Gem.loaded_specs['grpc'].version
+        end
+
+        def self.present?
+          super && defined?(::GRPC)
+        end
+
+        def self.compatible?
+          super \
+            && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0') \
+            && version >= Gem::Version.new('0.10.0')
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/patcher.rb

@@ -1,60 +1,50 @@
-# requirements should be kept minimal as Patcher is a shared requirement.
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/grpc/ext'
 
 module Datadog
   module Contrib
     module GRPC
-      SERVICE = 'grpc'.freeze
-
       # Patcher enables patching of 'grpc' module.
       module Patcher
-        include Base
-        register_as :grpc, auto_patch: true
-        option :tracer, default: Datadog.tracer
-        option :service_name, default: SERVICE
-
-        @patched = false
+        include Contrib::Patcher
 
         module_function
 
-        def patch
-          return false unless compatible?
-          return @patched if @patched
-
-          require 'ddtrace/ext/grpc'
-          require 'ddtrace/propagation/grpc_propagator'
-          require 'ddtrace/contrib/grpc/datadog_interceptor'
-          require 'ddtrace/contrib/grpc/intercept_with_datadog'
-
-          add_pin
-          prepend_interceptor
-
-          @patched = true
-        rescue StandardError => e
-          Datadog::Tracer.log.error("Unable to apply gRPC integration: #{e}")
-        ensure
-          @patched
-        end
-
-        def compatible?
-          defined?(::GRPC::VERSION) && Gem::Version.new(::GRPC::VERSION) >= Gem::Version.new('0.10.0')
+        def patched?
+          done?(:grpc)
         end
 
-        def patched?
-          @patched
+        def patch
+          do_once(:grpc) do
+            begin
+              require 'ddtrace/propagation/grpc_propagator'
+              require 'ddtrace/contrib/grpc/datadog_interceptor'
+              require 'ddtrace/contrib/grpc/intercept_with_datadog'
+
+              add_pin
+              prepend_interceptor
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply gRPC integration: #{e}")
+            end
+          end
         end
 
         def add_pin
           Pin.new(
             get_option(:service_name),
-            app: 'grpc',
-            app_type: 'grpc',
+            app: Ext::APP,
+            app_type: Datadog::Ext::AppTypes::WEB,
             tracer: get_option(:tracer)
           ).onto(::GRPC)
         end
 
         def prepend_interceptor
           ::GRPC::InterceptionContext
-            .prepend(Datadog::Contrib::GRPC::InterceptWithDatadog)
+            .send(:prepend, Datadog::Contrib::GRPC::InterceptWithDatadog)
+        end
+
+        def get_option(option)
+          Datadog.configuration[:grpc].get_option(option)
         end
       end
     end