ddtrace 1.4.1 → 1.6.1

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

@@ -0,0 +1,24 @@
+# typed: ignore
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_HANAMI_ENABLED'.freeze
+
+          SPAN_ACTION =  'hanami.action'.freeze
+          SPAN_ROUTING = 'hanami.routing'.freeze
+          SPAN_RENDER =  'hanami.render'.freeze
+
+          TAG_COMPONENT = 'hanami'.freeze
+          TAG_OPERATION_ACTION = 'action'.freeze
+          TAG_OPERATION_ROUTING = 'routing'.freeze
+          TAG_OPERATION_RENDER = 'render'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: ignore
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Description of Hanami integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.0.0')
+          MAXIMUM_VERSION = Gem::Version.new('2.0.0')
+
+          register_as :hanami
+
+          def self.version
+            Gem.loaded_specs['hanami'] && Gem.loaded_specs['hanami'].version
+          end
+
+          def self.loaded?
+            !defined?(::Hanami).nil?
+          end
+
+          def self.compatible?
+            # Tested with version larger than 1.x, but not 2.x version
+            super && version >= MINIMUM_VERSION && version < MAXIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: ignore
+
+require_relative '../patcher'
+require_relative 'action_tracer'
+require_relative 'renderer_policy_tracing'
+require_relative 'router_tracing'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Patcher enables patching of Hanami
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            # For auto instrumentation, `plugin` must be required before `Hanami.boot`
+            require_relative 'plugin'
+
+            ::Hanami::Router.prepend(RouterTracing)
+            ::Hanami::RenderingPolicy.prepend(RendererPolicyTracing)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/hanami/plugin.rb

@@ -0,0 +1,23 @@
+# typed: ignore
+
+::Hanami.plugin do
+  Datadog.configure do |c|
+    c.tracing.instrument :rack
+  end
+
+  middleware.use Datadog::Tracing::Contrib::Rack::TraceMiddleware
+end
+
+::Hanami::Application.singleton_class.prepend(
+  Module.new do
+    def inherited(base)
+      super
+
+      base.configure do
+        controller.prepare do
+          use Datadog::Tracing::Contrib::Hanami::ActionTracer, self
+        end
+      end
+    end
+  end
+)

data/lib/datadog/tracing/contrib/hanami/renderer_policy_tracing.rb

@@ -0,0 +1,41 @@
+# typed: ignore
+
+require_relative 'ext'
+require_relative '../../metadata/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami Instrumentation for `hanami.render`
+        module RendererPolicyTracing
+          def render(env, response)
+            action = env['hanami.action']
+            # env['hanami.action'] could be empty for endpoints without an action
+            #
+            # For example in config/routes.rb:
+            # get '/hello', to: ->(env) { [200, {}, ['Hello from Hanami!']] }
+            action_klass = (action && action.class) ||
+              ::Hanami::Routing::Default::NullAction
+
+            Tracing.trace(
+              Ext::SPAN_RENDER,
+              service: configuration[:service_name],
+              resource: action_klass.to_s,
+              span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+            ) do |span_op, _trace_op|
+              span_op.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span_op.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER)
+
+              super
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:hanami]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/hanami/router_tracing.rb

@@ -0,0 +1,44 @@
+# typed: ignore
+
+require_relative 'ext'
+require_relative '../../metadata/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami Instrumentation for `hanami.routing`
+        module RouterTracing
+          def call(env)
+            return super if Tracing.active_span && Tracing.active_span.name == Ext::SPAN_ROUTING
+
+            Tracing.trace(
+              Ext::SPAN_ROUTING,
+              service: configuration[:service_name],
+              span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+            ) do |span_op, trace_op|
+              begin
+                span_op.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span_op.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ROUTING)
+
+                span_op.resource = nil
+
+                super
+              ensure
+                span_op.resource ||= if trace_op.resource_override?
+                                       trace_op.resource
+                                     else
+                                       env['REQUEST_METHOD']
+                                     end
+              end
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:hanami]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -70,6 +70,8 @@ module Datadog
             end
 
             def annotate_span_with_request!(span, request, request_options)
+              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_REQUEST)
 

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

@@ -51,6 +51,8 @@ module Datadog
             private
 
             def annotate_span_with_request!(span, req, req_options)
+              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_REQUEST)
 

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

@@ -51,6 +51,8 @@ module Datadog
             private
 
             def annotate_span_with_request!(span, req, req_options)
+              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_REQUEST)
 

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

@@ -20,6 +20,13 @@ module Datadog
           TAG_ROWS = 'mongodb.rows'.freeze
           TAG_COMPONENT = 'mongodb'.freeze
           TAG_OPERATION_COMMAND = 'command'.freeze
+          TAG_SYSTEM = 'mongodb'.freeze
+
+          # Temporary namespace to accommodate unified tags which has naming collision, before
+          # making breaking changes
+          module DB
+            TAG_COLLECTION = 'db.mongodb.collection'.freeze
+          end
         end
       end
     end

data/lib/datadog/tracing/contrib/mongodb/subscribers.rb

@@ -2,6 +2,7 @@
 
 require_relative '../analytics'
 require_relative 'ext'
+require_relative '../ext'
 require_relative 'parsers'
 require_relative '../../metadata/ext'
 
@@ -30,6 +31,8 @@ module Datadog
             query = MongoDB.query_builder(event.command_name, event.database_name, event.command)
             serialized_query = query.to_s
 
+            span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
+
             span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
             span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
 
@@ -44,6 +47,7 @@ module Datadog
             # since it has been quantized and reduced
             span.set_tag(Ext::TAG_DB, query['database'])
             span.set_tag(Ext::TAG_COLLECTION, query['collection'])
+            span.set_tag(Ext::DB::TAG_COLLECTION, query['collection'])
             span.set_tag(Ext::TAG_OPERATION, query['operation'])
             span.set_tag(Ext::TAG_QUERY, serialized_query)
             span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, event.address.host)

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

@@ -3,6 +3,8 @@
 require_relative '../../configuration/settings'
 require_relative '../ext'
 
+require_relative '../../propagation/sql_comment'
+
 module Datadog
   module Tracing
     module Contrib
@@ -27,6 +29,16 @@ module Datadog
             end
 
             option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+
+            option :comment_propagation do |o|
+              o.default do
+                ENV.fetch(
+                  Contrib::Propagation::SqlComment::Ext::ENV_DBM_PROPAGATION_MODE,
+                  Contrib::Propagation::SqlComment::Ext::DISABLED
+                )
+              end
+              o.lazy
+            end
           end
         end
       end

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

@@ -15,6 +15,7 @@ module Datadog
           TAG_DB_NAME = 'mysql2.db.name'.freeze
           TAG_COMPONENT = 'mysql2'.freeze
           TAG_OPERATION_QUERY = 'query'.freeze
+          TAG_SYSTEM = 'mysql'.freeze
         end
       end
     end

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

@@ -3,6 +3,9 @@
 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
@@ -23,6 +26,9 @@ module Datadog
                 span.resource = sql
                 span.span_type = Tracing::Metadata::Ext::SQL::TYPE
 
+                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)
 
@@ -36,6 +42,12 @@ module Datadog
                 span.set_tag(Ext::TAG_DB_NAME, query_options[:database])
                 span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, query_options[:host])
                 span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, query_options[:port])
+
+                propagation_mode = Contrib::Propagation::SqlComment::Mode.new(comment_propagation)
+
+                Contrib::Propagation::SqlComment.annotate!(span, propagation_mode)
+                sql = Contrib::Propagation::SqlComment.prepend_comment(sql, span, propagation_mode)
+
                 super(sql, options)
               end
             end
@@ -53,6 +65,10 @@ module Datadog
             def analytics_sample_rate
               datadog_configuration[:analytics_sample_rate]
             end
+
+            def comment_propagation
+              datadog_configuration[:comment_propagation]
+            end
           end
         end
       end

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

@@ -3,6 +3,8 @@
 require_relative '../../configuration/settings'
 require_relative '../ext'
 
+require_relative '../../propagation/sql_comment/ext'
+
 module Datadog
   module Tracing
     module Contrib
@@ -27,6 +29,16 @@ module Datadog
             end
 
             option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+
+            option :comment_propagation do |o|
+              o.default do
+                ENV.fetch(
+                  Contrib::Propagation::SqlComment::Ext::ENV_DBM_PROPAGATION_MODE,
+                  Contrib::Propagation::SqlComment::Ext::DISABLED
+                )
+              end
+              o.lazy
+            end
           end
         end
       end

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

@@ -11,7 +11,6 @@ module Datadog
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_PG_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_PG_ANALYTICS_SAMPLE_RATE'.freeze
           DEFAULT_PEER_SERVICE_NAME = 'pg'.freeze
-          SPAN_SYSTEM = 'postgresql'.freeze
           SPAN_EXEC = 'pg.exec'.freeze
           SPAN_EXEC_PARAMS = 'pg.exec.params'.freeze
           SPAN_EXEC_PREPARED = 'pg.exec.prepared'.freeze
@@ -24,6 +23,8 @@ module Datadog
           TAG_DB_NAME = 'pg.db.name'.freeze
           TAG_COMPONENT = 'pg'.freeze
           TAG_OPERATION_QUERY = 'query'.freeze
+
+          TAG_SYSTEM = 'postgresql'.freeze
         end
       end
     end

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

@@ -2,8 +2,12 @@
 
 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
@@ -17,68 +21,77 @@ module Datadog
           # PG::Connection patch methods
           module InstanceMethods
             def exec(sql, *args)
-              trace(Ext::SPAN_EXEC, resource: sql) do
-                super(sql, *args)
+              trace(Ext::SPAN_EXEC, sql: sql) do |sql_statement|
+                super(sql_statement, *args)
               end
             end
 
             def exec_params(sql, params, *args)
-              trace(Ext::SPAN_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+              trace(Ext::SPAN_EXEC_PARAMS, sql: sql) do |sql_statement|
+                super(sql_statement, params, *args)
               end
             end
 
             def exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_EXEC_PREPARED, resource: statement_name) do
+              trace(Ext::SPAN_EXEC_PREPARED, statement_name: statement_name) do
                 super(statement_name, params, *args)
               end
             end
 
             def async_exec(sql, *args)
-              trace(Ext::SPAN_ASYNC_EXEC, resource: sql) do
-                super(sql, *args)
+              trace(Ext::SPAN_ASYNC_EXEC, sql: sql) do |sql_statement|
+                super(sql_statement, *args)
               end
             end
 
             def async_exec_params(sql, params, *args)
-              trace(Ext::SPAN_ASYNC_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+              trace(Ext::SPAN_ASYNC_EXEC_PARAMS, sql: sql) do |sql_statement|
+                super(sql_statement, params, *args)
               end
             end
 
             def async_exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_ASYNC_EXEC_PREPARED, resource: statement_name) do
+              trace(Ext::SPAN_ASYNC_EXEC_PREPARED, statement_name: statement_name) do
                 super(statement_name, params, *args)
               end
             end
 
             def sync_exec(sql, *args)
-              trace(Ext::SPAN_SYNC_EXEC, resource: sql) do
-                super(sql, *args)
+              trace(Ext::SPAN_SYNC_EXEC, sql: sql) do |sql_statement|
+                super(sql_statement, *args)
               end
             end
 
             def sync_exec_params(sql, params, *args)
-              trace(Ext::SPAN_SYNC_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+              trace(Ext::SPAN_SYNC_EXEC_PARAMS, sql: sql) do |sql_statement|
+                super(sql_statement, params, *args)
               end
             end
 
             def sync_exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_SYNC_EXEC_PREPARED, resource: statement_name) do
+              trace(Ext::SPAN_SYNC_EXEC_PREPARED, statement_name: statement_name) do
                 super(statement_name, params, *args)
               end
             end
 
             private
 
-            def trace(name, resource:)
+            def trace(name, sql: nil, statement_name: nil)
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+              resource = statement_name || sql
+
               Tracing.trace(name, service: service, resource: resource, type: Tracing::Metadata::Ext::SQL::TYPE) do |span|
                 annotate_span_with_query!(span, service)
                 # Set analytics sample rate
                 Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
-                result = yield
+
+                if sql
+                  propagation_mode = Contrib::Propagation::SqlComment::Mode.new(comment_propagation)
+                  Contrib::Propagation::SqlComment.annotate!(span, propagation_mode)
+                  propagated_sql_statement = Contrib::Propagation::SqlComment.prepend_comment(sql, span, propagation_mode)
+                end
+
+                result = yield(propagated_sql_statement)
                 annotate_span_with_result!(span, result)
                 result
               end
@@ -95,9 +108,9 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, service)
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
 
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_INSTANCE, db)
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_USER, user)
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_SYSTEM, Ext::SPAN_SYSTEM)
+              span.set_tag(Contrib::Ext::DB::TAG_INSTANCE, db)
+              span.set_tag(Contrib::Ext::DB::TAG_USER, user)
+              span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
 
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host)
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port)
@@ -106,7 +119,7 @@ module Datadog
             end
 
             def annotate_span_with_result!(span, result)
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_ROW_COUNT, result.ntuples)
+              span.set_tag(Contrib::Ext::DB::TAG_ROW_COUNT, result.ntuples)
             end
 
             def datadog_configuration
@@ -120,6 +133,10 @@ module Datadog
             def analytics_sample_rate
               datadog_configuration[:analytics_sample_rate]
             end
+
+            def comment_propagation
+              datadog_configuration[:comment_propagation]
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/propagation/sql_comment/comment.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'erb'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        module SqlComment
+          # To be prepended to a sql statement.
+          class Comment
+            def initialize(hash)
+              @hash = hash
+            end
+
+            def to_s
+              @string ||= begin
+                ret = String.new
+
+                @hash.each do |key, value|
+                  next if value.nil?
+
+                  # Url encode
+                  value = ERB::Util.url_encode(value)
+
+                  # Escape SQL
+                  ret << "#{key}='#{value}',"
+                end
+
+                # Remove the last `,`
+                ret.chop!
+
+                "/*#{ret}*/"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/propagation/sql_comment/ext.rb

@@ -0,0 +1,32 @@
+# typed: false
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        module SqlComment
+          module Ext
+            ENV_DBM_PROPAGATION_MODE = 'DD_DBM_PROPAGATION_MODE'.freeze
+
+            # The default mode for sql comment propagation
+            DISABLED = 'disabled'.freeze
+
+            # The `service` mode propagates service configuration
+            SERVICE = 'service'.freeze
+
+            # The `full` mode propagates service configuration + trace context
+            FULL = 'full'.freeze
+
+            # The value should be `true` when `full` mode
+            TAG_DBM_TRACE_INJECTED = '_dd.dbm_trace_injected'.freeze
+
+            KEY_DATABASE_SERVICE = 'dddbs'.freeze
+            KEY_ENVIRONMENT = 'dde'.freeze
+            KEY_PARENT_SERVICE = 'ddps'.freeze
+            KEY_VERSION = 'ddpv'.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/propagation/sql_comment/mode.rb

@@ -0,0 +1,28 @@
+# typed: false
+
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        # Implements sql comment propagation related contracts.
+        module SqlComment
+          Mode = Struct.new(:mode) do
+            def enabled?
+              service? || full?
+            end
+
+            def service?
+              mode == Ext::SERVICE
+            end
+
+            def full?
+              mode == Ext::FULL
+            end
+          end
+        end
+      end
+    end
+  end
+end