ddtrace 0.20.0 → 0.21.0

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

@@ -8,7 +8,7 @@ module Datadog
         # Custom settings for the DelayedJob integration
         class Settings < Contrib::Configuration::Settings
           option  :analytics_enabled,
-                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENALBED, nil) },
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
                   lazy: true
 
           option  :analytics_sample_rate,

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

@@ -4,7 +4,7 @@ module Datadog
       # DelayedJob integration constants
       module Ext
         APP = 'delayed_job'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'delayed_job'.freeze
         SPAN_JOB = 'delayed_job'.freeze

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the Elasticsearch integration
         class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           option :quantize, default: {}
           option :service_name, default: Ext::SERVICE_NAME
         end

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

@@ -4,10 +4,10 @@ module Datadog
       # Elasticsearch integration constants
       module Ext
         APP = 'elasticsearch'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'elasticsearch'.freeze
-
         SPAN_QUERY = 'elasticsearch.query'.freeze
-
         TAG_BODY = 'elasticsearch.body'.freeze
         TAG_METHOD = 'elasticsearch.method'.freeze
         TAG_PARAMS = 'elasticsearch.params'.freeze

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/net'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/elasticsearch/ext'
 
 module Datadog
@@ -83,11 +84,16 @@ module Datadog
                   params = JSON.generate(params) if params && !params.is_a?(String)
                   body = JSON.generate(body) if body && !body.is_a?(String)
 
+                  # Set analytics sample rate
+                  if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+                    Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+                  end
+
                   span.set_tag(Datadog::Contrib::Elasticsearch::Ext::TAG_METHOD, method)
                   span.set_tag(Datadog::Contrib::Elasticsearch::Ext::TAG_URL, url)
                   span.set_tag(Datadog::Contrib::Elasticsearch::Ext::TAG_PARAMS, params) if params
                   if body
-                    quantize_options = Datadog.configuration[:elasticsearch][:quantize]
+                    quantize_options = datadog_configuration[:quantize]
                     quantized_body = Datadog::Contrib::Elasticsearch::Quantize.format_body(body, quantize_options)
                     span.set_tag(Datadog::Contrib::Elasticsearch::Ext::TAG_BODY, quantized_body)
                   end
@@ -106,6 +112,10 @@ module Datadog
               end
               response
             end
+
+            def datadog_configuration
+              Datadog.configuration[:elasticsearch]
+            end
           end
         end
       end

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the Excon integration
         class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           option :distributed_tracing, default: true
           option :error_handler, default: nil
           option :service_name, default: Ext::SERVICE_NAME

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

@@ -4,8 +4,9 @@ module Datadog
       # Excon integration constants
       module Ext
         APP = 'excon'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_EXCON_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_EXCON_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'excon'.freeze
-
         SPAN_REQUEST = 'excon.request'.freeze
       end
     end

data/lib/ddtrace/contrib/excon/middleware.rb

@@ -3,6 +3,7 @@ require 'ddtrace/ext/http'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/excon/ext'
 
 module Datadog
@@ -82,6 +83,14 @@ module Datadog
           @options[:tracer]
         end
 
+        def analytics_enabled?
+          Contrib::Analytics.enabled?(@options[:analytics_enabled])
+        end
+
+        def analytics_sample_rate
+          @options[:analytics_sample_rate]
+        end
+
         def distributed_tracing?
           @options[:distributed_tracing] == true && tracer.enabled
         end
@@ -98,6 +107,12 @@ module Datadog
           span.resource = datum[:method].to_s.upcase
           span.service = service_name(datum)
           span.span_type = Datadog::Ext::HTTP::TYPE
+
+          # Set analytics sample rate
+          if analytics_enabled?
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+          end
+
           span.set_tag(Datadog::Ext::HTTP::URL, datum[:path])
           span.set_tag(Datadog::Ext::HTTP::METHOD, datum[:method].to_s.upcase)
           span.set_tag(Datadog::Ext::NET::TARGET_HOST, datum[:host])

data/lib/ddtrace/contrib/extensions.rb

@@ -0,0 +1,62 @@
+require 'ddtrace/contrib/registry'
+
+module Datadog
+  module Contrib
+    # Extensions that can be added to the base library
+    # Adds registry, configuration access for integrations.
+    module Extensions
+      def self.extended(base)
+        Datadog.send(:extend, Helpers)
+        Datadog::Configuration::Settings.send(:include, Configuration)
+      end
+
+      # Helper methods for Datadog module.
+      module Helpers
+        def registry
+          configuration.registry
+        end
+      end
+
+      # Extensions for Datadog::Configuration::Settings
+      module Configuration
+        InvalidIntegrationError = Class.new(StandardError)
+
+        def self.included(base)
+          # Add the additional options to the global configuration settings
+          base.instance_eval do
+            option :registry, default: Registry.new
+          end
+        end
+
+        def initialize(options = {})
+          super
+          set_option(:registry, options[:registry]) if options.key?(:registry)
+        end
+
+        def [](integration_name, configuration_name = :default)
+          integration = fetch_integration(integration_name)
+          integration.configuration(configuration_name) unless integration.nil?
+        end
+
+        def use(integration_name, options = {}, &block)
+          integration = fetch_integration(integration_name)
+
+          unless integration.nil?
+            configuration_name = options[:describes] || :default
+            filtered_options = options.reject { |k, _v| k == :describes }
+            integration.configure(configuration_name, filtered_options, &block)
+          end
+
+          integration.patch if integration.respond_to?(:patch)
+        end
+
+        private
+
+        def fetch_integration(name)
+          get_option(:registry)[name] ||
+            raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,14 @@ module Datadog
             Datadog::Ext::HTTP::ERROR_RANGE.cover?(env[:status])
           end
 
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           option :distributed_tracing, default: true
           option :error_handler, default: DEFAULT_ERROR_HANDLER
           option :service_name, default: Ext::SERVICE_NAME

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

@@ -4,8 +4,9 @@ module Datadog
       # Faraday integration constants
       module Ext
         APP = 'faraday'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_FARADAY_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'faraday'.freeze
-
         SPAN_REQUEST = 'faraday.request'.freeze
       end
     end

data/lib/ddtrace/contrib/faraday/middleware.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/net'
 require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/faraday/ext'
 
 module Datadog
@@ -33,6 +34,12 @@ module Datadog
           span.resource = env[:method].to_s.upcase
           span.service = service_name(env)
           span.span_type = Datadog::Ext::HTTP::TYPE
+
+          # Set analytics sample rate
+          if analytics_enabled?
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+          end
+
           span.set_tag(Datadog::Ext::HTTP::URL, env[:url].path)
           span.set_tag(Datadog::Ext::HTTP::METHOD, env[:method].to_s.upcase)
           span.set_tag(Datadog::Ext::NET::TARGET_HOST, env[:url].host)
@@ -65,6 +72,14 @@ module Datadog
           options[:service_name]
         end
 
+        def analytics_enabled?
+          Contrib::Analytics.enabled?(options[:analytics_enabled])
+        end
+
+        def analytics_sample_rate
+          options[:analytics_sample_rate]
+        end
+
         def setup_service!
           return if options[:service_name] == datadog_configuration[:service_name]
 

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

@@ -8,6 +8,14 @@ module Datadog
       module Configuration
         # Custom settings for the Grape integration
         class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           option :enabled, default: true
           option :service_name, default: Ext::SERVICE_NAME
         end

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

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/errors'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/rack/ext'
 
 module Datadog
@@ -79,6 +80,11 @@ module Datadog
                 request_span.resource = resource
               end
 
+              # Set analytics sample rate
+              if analytics_enabled?
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+              end
+
               # catch thrown exceptions
               span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
 
@@ -145,6 +151,11 @@ module Datadog
             )
 
             begin
+              # Set analytics sample rate
+              if analytics_enabled?
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+              end
+
               # catch thrown exceptions
               span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
               span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
@@ -166,6 +177,14 @@ module Datadog
             datadog_configuration[:service_name]
           end
 
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
+
           def enabled?
             datadog_configuration[:enabled] == true
           end

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

@@ -4,12 +4,12 @@ module Datadog
       # Grape integration constants
       module Ext
         APP = 'grape'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_GRAPE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_GRAPE_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'grape'.freeze
-
         SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'.freeze
         SPAN_ENDPOINT_RUN = 'grape.endpoint_run'.freeze
         SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'.freeze
-
         TAG_FILTER_TYPE = 'grape.filter.type'.freeze
         TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'.freeze
         TAG_ROUTE_PATH = 'grape.route.path'.freeze

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

@@ -8,6 +8,14 @@ module Datadog
       module Configuration
         # Custom settings for the GraphQL integration
         class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           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)

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

@@ -4,6 +4,8 @@ module Datadog
       # GraphQL integration constants
       module Ext
         APP = 'ruby-graphql'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_GRAPHQL_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_GRAPHQL_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'ruby-graphql'.freeze
       end
     end

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

@@ -30,19 +30,25 @@ module Datadog
         def patch_schema!(schema)
           tracer = get_option(:tracer)
           service_name = get_option(:service_name)
+          analytics_enabled = Contrib::Analytics.enabled?(get_option(:analytics_enabled))
+          analytics_sample_rate = get_option(:analytics_sample_rate)
 
           if schema.respond_to?(:use)
             schema.use(
               ::GraphQL::Tracing::DataDogTracing,
               tracer: tracer,
-              service: service_name
+              service: service_name,
+              analytics_enabled: analytics_enabled,
+              analytics_sample_rate: analytics_sample_rate
             )
           else
             schema.define do
               use(
                 ::GraphQL::Tracing::DataDogTracing,
                 tracer: tracer,
-                service: service_name
+                service: service_name,
+                analytics_enabled: analytics_enabled,
+                analytics_sample_rate: analytics_sample_rate
               )
             end
           end

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the gRPC integration
         class Settings < Contrib::Configuration::Settings
+          option  :analytics_enabled,
+                  default: -> { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) },
+                  lazy: true
+
+          option  :analytics_sample_rate,
+                  default: -> { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) },
+                  lazy: true
+
           option :service_name, default: Ext::SERVICE_NAME
         end
       end

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

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/grpc/ext'
 
 module Datadog
@@ -55,6 +56,14 @@ module Datadog
           def service_name
             (datadog_pin && datadog_pin.service_name) || datadog_configuration[:service_name]
           end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
         end
 
         require_relative 'datadog_interceptor/client'

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

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/http'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/grpc/ext'
 
 module Datadog
@@ -33,6 +34,9 @@ module Datadog
               span.set_tag(header, value)
             end
 
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
             Datadog::GRPCPropagator
               .inject!(span.context, metadata)
           rescue StandardError => e