ddtrace 0.54.2 → 1.8.0

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

@@ -0,0 +1,28 @@
+# typed: false
+
+require_relative '../analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rails
+        # common utilities for Rails
+        module Utils
+          def self.app_name
+            if ::Rails::VERSION::MAJOR >= 6
+              ::Rails.application.class.module_parent_name.underscore
+            elsif ::Rails::VERSION::MAJOR >= 4
+              ::Rails.application.class.parent_name.underscore
+            else
+              ::Rails.application.class.to_s.underscore
+            end
+          end
+
+          def self.railtie_supported?
+            !(defined?(::Rails::VERSION::MAJOR) && ::Rails::VERSION::MAJOR >= 3 && defined?(::Rails::Railtie)).nil?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# typed: false
+
+require 'set'
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rake
+        module Configuration
+          # Custom settings for the Rake integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+
+            option :analytics_enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :quantize, default: {}
+            option :service_name
+
+            # A list of rake tasks, using their string names, to be instrumented.
+            # An empty list, or not setting this option means no task is instrumented.
+            # Automatically instrumenting all Rake tasks can lead to long-running tasks
+            # causing undue memory accumulation, as the trace for such tasks is never flushed.
+            option :tasks do |o|
+              o.default { [] }
+              o.lazy
+              o.on_set do |value|
+                # DEV: It should be possible to modify the value after it's set. E.g. for normalization.
+                options[:tasks].instance_variable_set(:@value, value.map(&:to_s).to_set)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rake
+        # Rake integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_RAKE_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_RAKE_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RAKE_ANALYTICS_SAMPLE_RATE'.freeze
+          SERVICE_NAME = 'rake'.freeze
+          SPAN_INVOKE = 'rake.invoke'.freeze
+          SPAN_EXECUTE = 'rake.execute'.freeze
+          TAG_EXECUTE_ARGS = 'rake.execute.args'.freeze
+          TAG_INVOKE_ARGS = 'rake.invoke.args'.freeze
+          TAG_TASK_ARG_NAMES = 'rake.task.arg_names'.freeze
+          TAG_COMPONENT = 'rake'.freeze
+          TAG_OPERATION_EXECUTE = 'execute'.freeze
+          TAG_OPERATION_INVOKE = 'invoke'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# typed: false
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../utils/quantization/hash'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rake
+        # Instrumentation for Rake tasks
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Instance methods for Rake instrumentation
+          module InstanceMethods
+            def invoke(*args)
+              return super if !enabled? || !instrumented_task?
+
+              Tracing.trace(Ext::SPAN_INVOKE, **span_options) do |span|
+                annotate_invoke!(span, args)
+                super
+              end
+            ensure
+              shutdown_tracer!
+            end
+
+            def execute(args = nil)
+              return super if !enabled? || !instrumented_task?
+
+              Tracing.trace(Ext::SPAN_EXECUTE, **span_options) do |span|
+                annotate_execute!(span, args)
+                super
+              end
+            ensure
+              shutdown_tracer!
+            end
+
+            private
+
+            # Task names are verified dynamically, in order to be agnostic of
+            # when tracing is configured in relation to Rake task declaration.
+            def instrumented_task?
+              configuration[:tasks].include?(name)
+            end
+
+            def shutdown_tracer!
+              Tracing.shutdown! if Tracing.active_span.nil? && ::Rake.application.top_level_tasks.include?(name)
+            end
+
+            def annotate_invoke!(span, args)
+              span.resource = name
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_INVOKE)
+              span.set_tag(Ext::TAG_TASK_ARG_NAMES, arg_names)
+              span.set_tag(Ext::TAG_INVOKE_ARGS, quantize_args(args)) unless args.nil?
+            rescue StandardError => e
+              Datadog.logger.debug("Error while tracing Rake invoke: #{e.class.name} #{e.message}")
+            end
+
+            def annotate_execute!(span, args)
+              span.resource = name
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_EXECUTE)
+              span.set_tag(Ext::TAG_EXECUTE_ARGS, quantize_args(args.to_hash)) unless args.nil?
+            rescue StandardError => e
+              Datadog.logger.debug("Error while tracing Rake execute: #{e.class.name} #{e.message}")
+            end
+
+            def quantize_args(args)
+              quantize_options = configuration[:quantize][:args]
+              Contrib::Utils::Quantization::Hash.format(args, quantize_options)
+            end
+
+            def enabled?
+              Datadog.configuration.tracing.enabled && \
+                configuration[:enabled] == true
+            end
+
+            def span_options
+              { service: configuration[:service_name] }
+            end
+
+            def configuration
+              Datadog.configuration.tracing[:rake]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rake
+        # Description of Rake integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('12.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :rake
+
+          def self.version
+            Gem.loaded_specs['rake'] && Gem.loaded_specs['rake'].version
+          end
+
+          def self.loaded?
+            !defined?(::Rake::Task).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: true
+
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Rake
+        # Patcher enables patching of 'rake' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            # Add instrumentation patch to Rake task
+            ::Rake::Task.include(Instrumentation)
+          end
+
+          def get_option(option)
+            Datadog.configuration.tracing[:rake].get_option(option)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/redis/configuration/resolver.rb

@@ -0,0 +1,49 @@
+# typed: true
+
+require_relative '../vendor/resolver'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        module Configuration
+          UNIX_SCHEME = 'unix'.freeze
+
+          # Converts String URLs and Hashes to a normalized connection settings Hash.
+          class Resolver < Contrib::Configuration::Resolver
+            # @param [Hash,String] Redis connection information
+            def resolve(hash)
+              super(parse_matcher(hash))
+            end
+
+            protected
+
+            def parse_matcher(matcher)
+              matcher = { url: matcher } if matcher.is_a?(String)
+
+              normalize(connection_resolver.resolve(matcher))
+            end
+
+            def normalize(hash)
+              return { url: hash[:url] } if hash[:scheme] == UNIX_SCHEME
+
+              # Connexion strings are always converted to host, port, db and scheme
+              # but the host, port, db and scheme will generate the :url only after
+              # establishing a first connexion
+              {
+                host: hash[:host],
+                port: hash[:port],
+                db: hash[:db],
+                scheme: hash[:scheme]
+              }
+            end
+
+            def connection_resolver
+              @connection_resolver ||= Vendor::Resolver.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        module Configuration
+          # Custom settings for the Redis integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+
+            option :analytics_enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :command_args do |o|
+              o.default { env_to_bool(Ext::ENV_COMMAND_ARGS, true) }
+              o.lazy
+            end
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        # Redis integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_REDIS_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_REDIS_SERVICE_NAME'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_REDIS_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_REDIS_ANALYTICS_SAMPLE_RATE'.freeze
+          ENV_COMMAND_ARGS = 'DD_REDIS_COMMAND_ARGS'.freeze
+          METRIC_PIPELINE_LEN = 'redis.pipeline_length'.freeze
+          DEFAULT_PEER_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
+          TAG_COMPONENT = 'redis'.freeze
+          TAG_OPERATION_COMMAND = 'command'.freeze
+          TAG_SYSTEM = 'redis'.freeze
+          TAG_DATABASE_INDEX = 'db.redis.database_index'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# typed: false
+
+require_relative '../patcher'
+require_relative 'configuration/resolver'
+require_relative 'ext'
+require_relative 'quantize'
+require_relative 'tags'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        # Instrumentation for Redis < 5
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            def call(*args, &block)
+              show_command_args = command_args?
+
+              Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
+                span.service = service_name
+                span.span_type = Contrib::Redis::Ext::TYPE
+                span.resource = get_command(args, show_command_args)
+                Contrib::Redis::Tags.set_common_tags(self, span, show_command_args)
+
+                super
+              end
+            end
+
+            def call_pipeline(*args, &block)
+              show_command_args = command_args?
+
+              Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
+                span.service = service_name
+                span.span_type = Contrib::Redis::Ext::TYPE
+                commands = get_pipeline_commands(args, show_command_args)
+                span.resource = commands.any? ? commands.join("\n") : '(none)'
+                span.set_metric Contrib::Redis::Ext::METRIC_PIPELINE_LEN, commands.length
+                Contrib::Redis::Tags.set_common_tags(self, span, show_command_args)
+
+                super
+              end
+            end
+
+            private
+
+            def command_args?
+              pinned = Datadog.configuration_for(redis_instance, :command_args)
+
+              return pinned unless pinned.nil?
+
+              datadog_configuration[:command_args]
+            end
+
+            def service_name
+              Datadog.configuration_for(redis_instance, :service_name) ||
+                datadog_configuration[:service_name]
+            end
+
+            def get_command(args, show_command_args)
+              if show_command_args
+                Contrib::Redis::Quantize.format_command_args(*args)
+              else
+                Contrib::Redis::Quantize.get_verb(*args)
+              end
+            end
+
+            def get_pipeline_commands(args, show_command_args)
+              if show_command_args
+                args[0].commands.map { |c| Contrib::Redis::Quantize.format_command_args(c) }
+              else
+                args[0].commands.map { |c| Contrib::Redis::Quantize.get_verb(c) }
+              end
+            end
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:redis, options]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        # Description of Redis integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('3.2')
+
+          # Support `Config#custom`
+          # https://github.com/redis-rb/redis-client/blob/master/CHANGELOG.md#0110
+          REDISCLIENT_MINIMUM_VERSION = Gem::Version.new('0.11.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :redis, auto_patch: true
+
+          # Until Redis 4, all instrumentation happened in one gem: redis.
+          # Since Redis 5, instrumentation happens in a separate gem: redis-client.
+          # Because Redis 4 does not depend on redis-client, it's possible for both gems to be installed at the same time.
+          # For example, if Sidekiq 7 and Redis 4 are installed: both redis and redis-client will be installed.
+          # If redis-client and redis > 5 are installed, than they will be in sync, and only redis-client will be installed.
+          def self.version
+            redis_version || redis_client_version
+          end
+
+          def self.redis_version
+            Gem.loaded_specs['redis'] && Gem.loaded_specs['redis'].version
+          end
+
+          def self.redis_client_version
+            Gem.loaded_specs['redis-client'] && Gem.loaded_specs['redis-client'].version
+          end
+
+          def self.loaded?
+            redis_loaded? || redis_client_loaded?
+          end
+
+          def self.redis_loaded?
+            !defined?(::Redis).nil?
+          end
+
+          def self.redis_client_loaded?
+            !defined?(::RedisClient).nil?
+          end
+
+          def self.compatible?
+            super && (redis_compatible? || redis_client_compatible?)
+          end
+
+          def self.redis_compatible?
+            !!(redis_version && redis_version >= MINIMUM_VERSION)
+          end
+
+          def self.redis_client_compatible?
+            !!(redis_client_version && redis_client_version >= REDISCLIENT_MINIMUM_VERSION)
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+
+          def resolver
+            @resolver ||= Configuration::Resolver.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# typed: ignore
+
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'configuration/resolver'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        # Patcher enables patching of 'redis' module.
+        module Patcher
+          include Contrib::Patcher
+
+          # Patch for redis instance
+          module InstancePatch
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance method patch for redis instance
+            module InstanceMethods
+              # `options` could be frozen
+              def initialize(options = {})
+                super(options.merge(redis_instance: self))
+              end
+            end
+          end
+
+          # Patch for redis client
+          module ClientPatch
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance method patch for redis client
+            module InstanceMethods
+              def initialize(options = {})
+                @redis_instance = options.delete(:redis_instance)
+
+                super(options)
+              end
+
+              private
+
+              attr_reader :redis_instance
+            end
+          end
+
+          module_function
+
+          def default_tags
+            [].tap do |tags|
+              tags << "target_redis_version:#{Integration.redis_version}"               if Integration.redis_version
+              tags << "target_redis_client_version:#{Integration.redis_client_version}" if Integration.redis_client_version
+            end
+          end
+
+          def patch
+            # Redis 5+ extracts RedisClient to its own gem and provide instrumentation interface
+            if Integration.redis_client_compatible?
+              require_relative 'trace_middleware'
+
+              ::RedisClient.register(TraceMiddleware)
+            end
+
+            if Integration.redis_compatible? && Integration.redis_version < Gem::Version.new('5.0.0')
+              require_relative 'instrumentation'
+
+              ::Redis.include(InstancePatch)
+              ::Redis::Client.include(ClientPatch)
+              ::Redis::Client.include(Instrumentation)
+            end
+          end
+        end
+      end
+    end
+  end
+end