ddtrace 0.20.0 → 0.21.0

data/lib/ddtrace/contrib/rails/utils.rb

@@ -1,3 +1,5 @@
+require 'ddtrace/contrib/analytics'
+
 module Datadog
   module Contrib
     module Rails
@@ -11,7 +13,7 @@ module Datadog
         def self.normalize_template_name(name)
           return if name.nil?
 
-          base_path = Datadog.configuration[:rails][:template_base_path]
+          base_path = datadog_configuration[:template_base_path]
           sections_view = name.split(base_path)
 
           if sections_view.length == 1
@@ -42,6 +44,20 @@ module Datadog
             true
           end
         end
+
+        def self.set_analytics_sample_rate(span)
+          if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+            Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+          end
+        end
+
+        class << self
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:rails]
+          end
+        end
       end
     end
   end

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

@@ -8,7 +8,7 @@ module Datadog
         # Custom settings for the Rake 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/rake/ext.rb

@@ -4,7 +4,7 @@ module Datadog
       # Rake integration constants
       module Ext
         APP = 'rake'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_RAKE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RAKE_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_RAKE_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'rake'.freeze
         SPAN_INVOKE = 'rake.invoke'.freeze

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the Redis 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/redis/ext.rb

@@ -4,15 +4,14 @@ module Datadog
       # Redis integration constants
       module Ext
         APP = 'redis'.freeze
-        SERVICE_NAME = 'redis'.freeze
-        TYPE = 'redis'.freeze
-
+        ENV_ANALYTICS_ENABLED = 'DD_REDIS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_REDIS_ANALYTICS_SAMPLE_RATE'.freeze
         METRIC_PIPELINE_LEN = 'redis.pipeline_length'.freeze
-
+        SERVICE_NAME = 'redis'.freeze
         SPAN_COMMAND = 'redis.command'.freeze
-
         TAG_DB = 'out.redis_db'.freeze
         TAG_RAW_COMMAND = 'redis.raw_command'.freeze
+        TYPE = 'redis'.freeze
       end
     end
   end

data/lib/ddtrace/contrib/redis/tags.rb

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/net'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/redis/ext'
 
 module Datadog
@@ -6,13 +7,30 @@ module Datadog
     module Redis
       # Tags handles generic common tags assignment.
       module Tags
-        module_function
+        class << self
+          def set_common_tags(client, span)
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
-        def set_common_tags(client, span)
-          span.set_tag Datadog::Ext::NET::TARGET_HOST, client.host
-          span.set_tag Datadog::Ext::NET::TARGET_PORT, client.port
-          span.set_tag Ext::TAG_DB, client.db
-          span.set_tag Ext::TAG_RAW_COMMAND, span.resource
+            span.set_tag Datadog::Ext::NET::TARGET_HOST, client.host
+            span.set_tag Datadog::Ext::NET::TARGET_PORT, client.port
+            span.set_tag Ext::TAG_DB, client.db
+            span.set_tag Ext::TAG_RAW_COMMAND, span.resource
+          end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:redis]
+          end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
         end
       end
     end

data/lib/ddtrace/contrib/registerable.rb

@@ -1,4 +1,4 @@
-require 'ddtrace/registry'
+require 'ddtrace/contrib/registry'
 
 module Datadog
   module Contrib

data/lib/ddtrace/contrib/registry.rb

@@ -0,0 +1,42 @@
+module Datadog
+  module Contrib
+    # Registry is a collection of integrations.
+    class Registry
+      include Enumerable
+
+      Entry = Struct.new(:name, :klass, :auto_patch)
+
+      def initialize
+        @data = {}
+        @mutex = Mutex.new
+      end
+
+      def add(name, klass, auto_patch = false)
+        @mutex.synchronize do
+          @data[name] = Entry.new(name, klass, auto_patch).freeze
+        end
+      end
+
+      def each
+        @mutex.synchronize do
+          @data.each { |_, entry| yield(entry) }
+        end
+      end
+
+      def [](name)
+        @mutex.synchronize do
+          entry = @data[name]
+          entry.klass if entry
+        end
+      end
+
+      def to_h
+        @mutex.synchronize do
+          @data.each_with_object({}) do |(_, entry), hash|
+            hash[entry.name] = entry.auto_patch
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Datadog
         # Custom settings for the Resque 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/resque/ext.rb

@@ -4,7 +4,7 @@ module Datadog
       # Resque integration constants
       module Ext
         APP = 'resque'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_RESQUE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RESQUE_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_RESQUE_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'resque'.freeze
         SPAN_JOB = 'resque.job'.freeze

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

@@ -7,6 +7,14 @@ module Datadog
       module Configuration
         # Custom settings for the RestClient 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 :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/rest_client/ext.rb

@@ -4,8 +4,9 @@ module Datadog
       # RestClient integration constants
       module Ext
         APP = 'rest_client'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_REST_CLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_REST_CLIENT_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'rest_client'.freeze
-
         SPAN_REQUEST = 'rest_client.request'.freeze
       end
     end

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -47,6 +47,10 @@ module Datadog
 
           def datadog_tag_request(uri, span)
             span.resource = method.to_s.upcase
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
             span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
             span.set_tag(Datadog::Ext::HTTP::METHOD, method.to_s.upcase)
             span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
@@ -82,9 +86,19 @@ module Datadog
             span.finish
           end
 
+          private
+
           def datadog_configuration
             Datadog.configuration[:rest_client]
           end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
         end
       end
     end

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

@@ -7,7 +7,13 @@ module Datadog
       module Configuration
         # Custom settings for the Sequel integration
         class Settings < Contrib::Configuration::Settings
-          # Add any custom Sequel settings or behavior here.
+          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
         end
       end
     end

data/lib/ddtrace/contrib/sequel/database.rb

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/sequel/ext'
 require 'ddtrace/contrib/sequel/utils'
 
@@ -23,6 +24,7 @@ module Datadog
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
+              Utils.set_analytics_sample_rate(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super(sql, options)
             end

data/lib/ddtrace/contrib/sequel/dataset.rb

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/sequel/ext'
 require 'ddtrace/contrib/sequel/utils'
 
@@ -44,6 +45,7 @@ module Datadog
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
+              Utils.set_analytics_sample_rate(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super_method.call(sql, options, &block)
             end

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

@@ -4,10 +4,10 @@ module Datadog
       # Sequel integration constants
       module Ext
         APP = 'sequel'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SEQUEL_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'sequel'.freeze
-
         SPAN_QUERY = 'sequel.query'.freeze
-
         TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
       end
     end

data/lib/ddtrace/contrib/sequel/utils.rb

@@ -3,24 +3,42 @@ module Datadog
     module Sequel
       # General purpose functions for Sequel
       module Utils
-        module_function
+        class << self
+          def adapter_name(database)
+            Datadog::Utils::Database.normalize_vendor(database.adapter_scheme.to_s)
+          end
 
-        def adapter_name(database)
-          Datadog::Utils::Database.normalize_vendor(database.adapter_scheme.to_s)
-        end
+          def parse_opts(sql, opts, db_opts)
+            if ::Sequel::VERSION >= '4.37.0' && !sql.is_a?(String)
+              # In 4.37.0, sql was converted to a prepared statement object
+              sql = sql.prepared_sql unless sql.is_a?(Symbol)
+            end
+
+            {
+              name: opts[:type],
+              query: sql,
+              database: db_opts[:database],
+              host: db_opts[:host]
+            }
+          end
+
+          def set_analytics_sample_rate(span)
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+          end
+
+          private
 
-        def parse_opts(sql, opts, db_opts)
-          if ::Sequel::VERSION >= '4.37.0' && !sql.is_a?(String)
-            # In 4.37.0, sql was converted to a prepared statement object
-            sql = sql.prepared_sql unless sql.is_a?(Symbol)
+          def datadog_configuration
+            Datadog.configuration[:sequel]
           end
 
-          {
-            name: opts[:type],
-            query: sql,
-            database: db_opts[:database],
-            host: db_opts[:host]
-          }
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
         end
       end
     end

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

@@ -7,7 +7,7 @@ module Datadog
         # Default settings for the Shoryuken 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/shoryuken/ext.rb

@@ -4,7 +4,7 @@ module Datadog
       # Shoryuken integration constants
       module Ext
         APP = 'shoryuken'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_SHORYUKEN_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SHORYUKEN_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_SHORYUKEN_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'shoryuken'.freeze
         SPAN_JOB = 'shoryuken.job'.freeze

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

@@ -8,7 +8,7 @@ module Datadog
         # Custom settings for the Sidekiq 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/sidekiq/ext.rb

@@ -5,7 +5,7 @@ module Datadog
       module Ext
         APP = 'sidekiq'.freeze
         CLIENT_SERVICE_NAME = 'sidekiq-client'.freeze
-        ENV_ANALYTICS_ENALBED = 'DD_SIDEKIQ_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SIDEKIQ_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_SIDEKIQ_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'sidekiq'.freeze
         SPAN_PUSH = 'sidekiq.push'.freeze

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

@@ -12,6 +12,14 @@ module Datadog
             response: %w[Content-Type X-Request-ID]
           }.freeze
 
+          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 :distributed_tracing, default: true
           option :headers, default: DEFAULT_HEADERS
           option :resource_script_names, default: false

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

@@ -4,13 +4,12 @@ module Datadog
       # Sinatra integration constants
       module Ext
         APP = 'sinatra'.freeze
-        SERVICE_NAME = 'sinatra'.freeze
-
+        ENV_ANALYTICS_ENABLED = 'DD_SINATRA_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SINATRA_ANALYTICS_SAMPLE_RATE'.freeze
         RACK_ENV_REQUEST_SPAN = 'datadog.sinatra_request_span'.freeze
-
+        SERVICE_NAME = 'sinatra'.freeze
         SPAN_RENDER_TEMPLATE = 'sinatra.render_template'.freeze
         SPAN_REQUEST = 'sinatra.request'.freeze
-
         TAG_ROUTE_PATH = 'sinatra.route.path'.freeze
         TAG_TEMPLATE_NAME = 'sinatra.template_name'.freeze
       end