ddtrace 0.34.1 → 1.23.1

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+require_relative '../../propagation/sql_comment'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Trilogy
+        module Configuration
+          # Custom settings for the Trilogy integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            option :analytics_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
+            end
+
+            option :analytics_sample_rate do |o|
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
+            end
+
+            option :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :comment_propagation do |o|
+              o.type :string
+              o.env Contrib::Propagation::SqlComment::Ext::ENV_DBM_PROPAGATION_MODE
+              o.default Contrib::Propagation::SqlComment::Ext::DISABLED
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Trilogy
+        # Trilogy integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_TRILOGY_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_TRILOGY_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_TRILOGY_PEER_SERVICE'
+
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_TRILOGY_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_TRILOGY_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'trilogy'
+          SPAN_QUERY = 'trilogy.query'
+          TAG_DB_NAME = 'trilogy.db.name'
+          TAG_COMPONENT = 'trilogy'
+          TAG_OPERATION_QUERY = 'query'
+          TAG_SYSTEM = 'mysql'
+          PEER_SERVICE_SOURCES = (Array[Ext::TAG_DB_NAME] + Contrib::Ext::DB::PEER_SERVICE_SOURCES).freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../ext'
+require_relative '../propagation/sql_comment'
+require_relative '../propagation/sql_comment/mode'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Trilogy
+        # Trilogy patch module
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Trilogy patch instance methods
+          module InstanceMethods
+            def query(sql)
+              service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+
+              Tracing.trace(Ext::SPAN_QUERY, service: service) do |span, trace_op|
+                span.resource = sql
+                span.span_type = Tracing::Metadata::Ext::SQL::TYPE
+
+                if datadog_configuration[:peer_service]
+                  span.set_tag(
+                    Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                    datadog_configuration[:peer_service]
+                  )
+                end
+
+                # Tag original global service name if not used
+                if span.service != Datadog.configuration.service
+                  span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+                end
+
+                span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
+                span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+                span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
+
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, connection_options[:host])
+
+                # Set analytics sample rate
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+                span.set_tag(Ext::TAG_DB_NAME, connection_options[:database])
+                span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, connection_options[:host])
+                span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, connection_options[:port])
+
+                Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+
+                propagation_mode = Contrib::Propagation::SqlComment::Mode.new(comment_propagation)
+
+                Contrib::Propagation::SqlComment.annotate!(span, propagation_mode)
+                sql = Contrib::Propagation::SqlComment.prepend_comment(
+                  sql,
+                  span,
+                  trace_op,
+                  propagation_mode
+                )
+
+                super(sql)
+              end
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:trilogy]
+            end
+
+            def analytics_enabled?
+              datadog_configuration[:analytics_enabled]
+            end
+
+            def analytics_sample_rate
+              datadog_configuration[:analytics_sample_rate]
+            end
+
+            def comment_propagation
+              datadog_configuration[:comment_propagation]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Trilogy
+        # Description of Trilogy integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('2.0.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :trilogy
+
+          def self.version
+            Gem.loaded_specs['trilogy'] && Gem.loaded_specs['trilogy'].version
+          end
+
+          def self.loaded?
+            !defined?(::Trilogy).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/trilogy/patcher.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../patcher'
+require_relative 'instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Trilogy
+        # Patcher enables patching of 'trilogy' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            patch_trilogy_client
+          end
+
+          def patch_trilogy_client
+            ::Trilogy.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Utils
+        # Common database-related utility functions.
+        module Database
+          VENDOR_DEFAULT = 'defaultdb'
+          VENDOR_POSTGRES = 'postgres'
+          VENDOR_SQLITE = 'sqlite'
+
+          module_function
+
+          def normalize_vendor(vendor)
+            case vendor
+            when nil
+              VENDOR_DEFAULT
+            when 'postgresql'
+              VENDOR_POSTGRES
+            when 'sqlite3'
+              VENDOR_SQLITE
+            else
+              vendor
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/utils/quantization/hash.rb

@@ -0,0 +1,109 @@
+module Datadog
+  module Tracing
+    module Contrib
+      module Utils
+        module Quantization
+          # Quantization for Hash
+          module Hash
+            PLACEHOLDER = '?'.freeze
+            EXCLUDE_KEYS = [].freeze
+            SHOW_KEYS = [].freeze
+            DEFAULT_OPTIONS = {
+              exclude: EXCLUDE_KEYS,
+              show: SHOW_KEYS,
+              placeholder: PLACEHOLDER
+            }.freeze
+
+            module_function
+
+            def format(hash_obj, options = {})
+              options ||= {}
+              format!(hash_obj, options)
+            rescue StandardError
+              options[:placeholder] || PLACEHOLDER
+            end
+
+            def format!(hash_obj, options = {})
+              options ||= {}
+              options = merge_options(DEFAULT_OPTIONS, options)
+              format_hash(hash_obj, options)
+            end
+
+            def format_hash(hash_obj, options = {})
+              case hash_obj
+              when ::Hash
+                return {} if options[:exclude] == :all
+                return hash_obj if options[:show] == :all
+
+                hash_obj.each_with_object({}) do |(key, value), quantized|
+                  if options[:show].any?(&indifferent_equals(key))
+                    quantized[key] = value
+                  elsif options[:exclude].none?(&indifferent_equals(key))
+                    quantized[key] = format_value(value, options)
+                  end
+                end
+              else
+                format_value(hash_obj, options)
+              end
+            end
+
+            def format_value(value, options = {})
+              return value if options[:show] == :all
+
+              case value
+              when ::Hash
+                format_hash(value, options)
+              when Array
+                # If any are objects, format them.
+                format_array(value, options)
+              else
+                options[:placeholder]
+              end
+            end
+
+            def format_array(value, options)
+              if value.any? { |v| v.class <= ::Hash || v.class <= Array }
+                first_entry = format_value(value.first, options)
+                value.size > 1 ? [first_entry, options[:placeholder]] : [first_entry]
+                # Otherwise short-circuit and return single placeholder
+              else
+                [options[:placeholder]]
+              end
+            end
+
+            def merge_options(original, additional)
+              {}.tap do |options|
+                # Show
+                # If either is :all, value becomes :all
+                options[:show] =  if original[:show] == :all || additional[:show] == :all
+                                    :all
+                                  else
+                                    (original[:show] || []).dup.concat(additional[:show] || []).uniq
+                                  end
+
+                # Exclude
+                # If either is :all, value becomes :all
+                options[:exclude] = if original[:exclude] == :all || additional[:exclude] == :all
+                                      :all
+                                    else
+                                      (original[:exclude] || []).dup.concat(additional[:exclude] || []).uniq
+                                    end
+
+                options[:placeholder] = additional[:placeholder] || original[:placeholder]
+              end
+            end
+
+            def indifferent_equals(value)
+              value = convert_value(value)
+              ->(compared_value) { value == convert_value(compared_value) }
+            end
+
+            def convert_value(value)
+              value.is_a?(Symbol) ? value.to_s : value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/utils/quantization/http.rb

@@ -0,0 +1,177 @@
+require 'uri'
+require 'set'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Utils
+        module Quantization
+          # Quantization for HTTP resources
+          module HTTP
+            PLACEHOLDER = '?'.freeze
+
+            # taken from Ruby https://github.com/ruby/uri/blob/eaf89cc31619d49e67c64d0b58ea9dc38892d175/lib/uri/rfc3986_parser.rb
+            # but adjusted to parse only <scheme>://<host>:<port>/ components
+            # and stop there, since we don't care about the path, query string,
+            # and fragment components
+            RFC3986_URL_BASE = /\A(?<URI>(?<scheme>[A-Za-z][+\-.0-9A-Za-z]*+):(?<hier-part>\/\/(?<authority>(?:(?<userinfo>(?:%\h\h|[!$&-.0-;=A-Z_a-z~])*+)@)?(?<host>(?<IP-literal>\[(?:(?<IPv6address>(?:\h{1,4}:){6}(?<ls32>\h{1,4}:\h{1,4}|(?<IPv4address>(?<dec-octet>[1-9]\d|1\d{2}|2[0-4]\d|25[0-5]|\d)\.\g<dec-octet>\.\g<dec-octet>\.\g<dec-octet>))|::(?:\h{1,4}:){5}\g<ls32>|\h{1,4}?::(?:\h{1,4}:){4}\g<ls32>|(?:(?:\h{1,4}:)?\h{1,4})?::(?:\h{1,4}:){3}\g<ls32>|(?:(?:\h{1,4}:){,2}\h{1,4})?::(?:\h{1,4}:){2}\g<ls32>|(?:(?:\h{1,4}:){,3}\h{1,4})?::\h{1,4}:\g<ls32>|(?:(?:\h{1,4}:){,4}\h{1,4})?::\g<ls32>|(?:(?:\h{1,4}:){,5}\h{1,4})?::\h{1,4}|(?:(?:\h{1,4}:){,6}\h{1,4})?::)|(?<IPvFuture>v\h++\.[!$&-.0-;=A-Z_a-z~]++))\])|\g<IPv4address>|(?<reg-name>(?:%\h\h|[!$&-.0-9;=A-Z_a-z~])*+))(?::(?<port>\d*+))?)))(?:\/|\z)/.freeze # rubocop:disable Style/RegexpLiteral, Layout/LineLength
+
+            module_function
+
+            def url(url, options = {})
+              url!(url, options)
+            rescue StandardError
+              placeholder = options[:placeholder] || PLACEHOLDER
+
+              options[:base] == :exclude ? placeholder : "#{base_url(url)}/#{placeholder}"
+            end
+
+            def base_url(url, options = {})
+              if (m = RFC3986_URL_BASE.match(url))
+                m[1]
+              else
+                ''
+              end
+            end
+
+            def url!(url, options = {})
+              options ||= {}
+
+              URI.parse(url).tap do |uri|
+                # Format the query string
+                if uri.query
+                  query = query(uri.query, options[:query])
+                  uri.query = (!query.nil? && query.empty? ? nil : query)
+                end
+
+                # Remove any URI fragments
+                uri.fragment = nil unless options[:fragment] == :show
+
+                if options[:base] == :exclude
+                  uri.host = nil
+                  uri.port = nil
+                  uri.scheme = nil
+                end
+              end.to_s
+            end
+
+            def query(query, options = {})
+              query!(query, options)
+            rescue StandardError
+              options[:placeholder] || PLACEHOLDER
+            end
+
+            def query!(query, options = {})
+              options ||= {}
+              options[:obfuscate] = {} if options[:obfuscate] == :internal
+              options[:show] = options[:show] || (options[:obfuscate] ? :all : [])
+              options[:exclude] = options[:exclude] || []
+
+              # Short circuit if query string is meant to exclude everything
+              # or if the query string is meant to include everything
+              return '' if options[:exclude] == :all
+
+              unless options[:show] == :all && !(options[:obfuscate] && options[:exclude])
+                query = collect_query(query, uniq: true) do |key, value|
+                  if options[:exclude].include?(key)
+                    [nil, nil]
+                  else
+                    value = options[:show] == :all || options[:show].include?(key) ? value : nil
+                    [key, value]
+                  end
+                end
+              end
+
+              options[:obfuscate] ? obfuscate_query(query, options[:obfuscate]) : query
+            end
+
+            # Iterate over each key value pair, yielding to the block given.
+            # Accepts :uniq option, which keeps uniq copies of keys without values.
+            # e.g. Reduces "foo&bar=bar&bar=bar&foo" to "foo&bar=bar&bar=bar"
+            def collect_query(query, options = {})
+              return query unless block_given?
+
+              uniq = options[:uniq].nil? ? false : options[:uniq]
+              keys = Set.new
+
+              delims = query.scan(/(^|&|;)/).flatten
+              query.split(/[&;]/).collect.with_index do |pairs, i|
+                key, value = pairs.split('=', 2)
+                key, value = yield(key, value, delims[i])
+                if uniq && keys.include?(key)
+                  ''
+                elsif key && value
+                  "#{delims[i]}#{key}=#{value}"
+                elsif key
+                  "#{delims[i]}#{key}".tap { keys << key }
+                # rubocop:disable Lint/DuplicateBranch
+                else
+                  ''
+                end
+                # rubocop:enable Lint/DuplicateBranch
+              end.join.sub(/^[&;]/, '')
+            end
+
+            private_class_method :collect_query
+
+            # Scans over the query string and obfuscates sensitive data by
+            # replacing matches with an opaque value
+            def obfuscate_query(query, options = {})
+              options[:regex] = nil if options[:regex] == :internal
+              re = options[:regex] || OBFUSCATOR_REGEX
+              with = options[:with] || OBFUSCATOR_WITH
+
+              query.gsub(re, with)
+            end
+
+            private_class_method :obfuscate_query
+
+            OBFUSCATOR_WITH = '<redacted>'.freeze
+
+            # rubocop:disable Layout/LineLength
+            OBFUSCATOR_REGEX = %r{
+              (?: # JSON-ish leading quote
+                 (?:"|%22)?
+              )
+              (?: # common keys
+                 (?:old[-_]?|new_?)?p(?:ass)?w(?:or)?d(?:1|2)? # pw, password variants
+                |pass(?:[-_]?phrase)?  # pass, passphrase variants
+                |secret
+                |(?: # key, key_id variants
+                     api[-_]?
+                    |private[-_]?
+                    |public[-_]?
+                    |access[-_]?
+                    |secret[-_]?
+                 )key(?:[-_]?id)?
+                |token
+                |consumer[-_]?(?:id|key|secret)
+                |sign(?:ed|ature)?
+                |auth(?:entication|orization)?
+              )
+              (?:
+                 # '=' query string separator, plus value til next '&' separator
+                 (?:\s|%20)*(?:=|%3D)[^&]+
+                 # JSON-ish '": "somevalue"', key being handled with case above, without the opening '"'
+                |(?:"|%22)                                     # closing '"' at end of key
+                 (?:\s|%20)*(?::|%3A)(?:\s|%20)*               # ':' key-value spearator, with surrounding spaces
+                 (?:"|%22)                                     # opening '"' at start of value
+                 (?:%2[^2]|%[^2]|[^"%])+                       # value
+                 (?:"|%22)                                     # closing '"' at end of value
+              )
+             |(?: # other common secret values
+                 bearer(?:\s|%20)+[a-z0-9._-]+
+                |token(?::|%3A)[a-z0-9]{13}
+                |gh[opsu]_[0-9a-zA-Z]{36}
+                |ey[I-L](?:[\w=-]|%3D)+\.ey[I-L](?:[\w=-]|%3D)+(?:\.(?:[\w.+/=-]|%3D|%2F|%2B)+)?
+                |-{5}BEGIN(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY-{5}[^-]+-{5}END(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY(?:-{5})?(?:\n|%0A)?
+                |(?:ssh-(?:rsa|dss)|ecdsa-[a-z0-9]+-[a-z0-9]+)(?:\s|%20)*(?:[a-z0-9/.+]|%2F|%5C|%2B){100,}(?:=|%3D)*(?:(?:\s+)[a-z0-9._-]+)?
+              )
+            }ix.freeze
+            # rubocop:enable Layout/LineLength
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../tracing'
+require_relative 'contrib/registry'
+require_relative 'contrib/extensions'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Registry is a global, declarative repository of all available integrations.
+      #
+      # Integrations should register themselves with the registry as early as
+      # possible as the initial tracer configuration can only activate integrations
+      # if they have already been registered.
+      #
+      # Despite that, integrations *can* be appended to the registry at any point
+      # of the program execution. Newly appended integrations can then be
+      # activated during tracer reconfiguration.
+      #
+      # The registry does not depend on runtime configuration and registered integrations
+      # must execute correctly after successive configuration changes.
+      # The registered integrations themselves can depend on the stateful configuration
+      # of the tracer.
+      #
+      # `Datadog.registry` is a helper accessor to this constant, but it's only available
+      # after the tracer has complete initialization. Use `Datadog::Tracing::Contrib::REGISTRY` instead
+      # of `Datadog.registry` when you code might be called during tracer initialization.
+      REGISTRY = Registry.new
+    end
+  end
+end
+
+require_relative 'contrib/action_cable/integration'
+require_relative 'contrib/action_mailer/integration'
+require_relative 'contrib/action_pack/integration'
+require_relative 'contrib/action_view/integration'
+require_relative 'contrib/active_model_serializers/integration'
+require_relative 'contrib/active_job/integration'
+require_relative 'contrib/active_record/integration'
+require_relative 'contrib/active_support/integration'
+require_relative 'contrib/aws/integration'
+require_relative 'contrib/concurrent_ruby/integration'
+require_relative 'contrib/dalli/integration'
+require_relative 'contrib/delayed_job/integration'
+require_relative 'contrib/elasticsearch/integration'
+require_relative 'contrib/ethon/integration'
+require_relative 'contrib/excon/integration'
+require_relative 'contrib/faraday/integration'
+require_relative 'contrib/grape/integration'
+require_relative 'contrib/graphql/integration'
+require_relative 'contrib/grpc/integration'
+require_relative 'contrib/hanami/integration'
+require_relative 'contrib/http/integration'
+require_relative 'contrib/httpclient/integration'
+require_relative 'contrib/httprb/integration'
+require_relative 'contrib/integration'
+require_relative 'contrib/kafka/integration'
+require_relative 'contrib/lograge/integration'
+require_relative 'contrib/mongodb/integration'
+require_relative 'contrib/mysql2/integration'
+require_relative 'contrib/opensearch/integration'
+require_relative 'contrib/pg/integration'
+require_relative 'contrib/presto/integration'
+require_relative 'contrib/qless/integration'
+require_relative 'contrib/que/integration'
+require_relative 'contrib/racecar/integration'
+require_relative 'contrib/rack/integration'
+require_relative 'contrib/rails/integration'
+require_relative 'contrib/rake/integration'
+require_relative 'contrib/redis/integration'
+require_relative 'contrib/resque/integration'
+require_relative 'contrib/rest_client/integration'
+require_relative 'contrib/roda/integration'
+require_relative 'contrib/semantic_logger/integration'
+require_relative 'contrib/sequel/integration'
+require_relative 'contrib/shoryuken/integration'
+require_relative 'contrib/sidekiq/integration'
+require_relative 'contrib/sinatra/integration'
+require_relative 'contrib/sneakers/integration'
+require_relative 'contrib/stripe/integration'
+require_relative 'contrib/sucker_punch/integration'
+require_relative 'contrib/trilogy/integration'