ddtrace 1.5.2 → 1.6.0

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

@@ -19,6 +19,8 @@ module Datadog
           TAG_URL = 'elasticsearch.url'.freeze
           TAG_COMPONENT = 'elasticsearch'.freeze
           TAG_OPERATION_QUERY = 'query'.freeze
+
+          TAG_SYSTEM = 'elasticsearch'.freeze
         end
       end
     end

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

@@ -3,6 +3,7 @@
 require_relative '../../metadata/ext'
 require_relative '../analytics'
 require_relative 'ext'
+require_relative '../ext'
 require_relative '../integration'
 require_relative '../patcher'
 
@@ -80,6 +81,8 @@ module Datadog
 
                     span.span_type = Datadog::Tracing::Contrib::Elasticsearch::Ext::SPAN_TYPE_QUERY
 
+                    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_QUERY)
 

data/lib/datadog/tracing/contrib/ethon/easy_patch.rb

@@ -131,6 +131,8 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
 
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
               uri = try_parse_uri
               return unless uri
 

data/lib/datadog/tracing/contrib/ethon/multi_patch.rb

@@ -67,6 +67,8 @@ module Datadog
               @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_MULTI_REQUEST)
 
+              @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
               # Tag as an external peer service
               @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, @datadog_multi_span.service)
 

data/lib/datadog/tracing/contrib/excon/middleware.rb

@@ -116,6 +116,8 @@ module Datadog
             span.service = service_name(datum[:host], @options)
             span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
 
+            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/ext.rb

@@ -13,6 +13,12 @@ module Datadog
           TAG_STATEMENT = 'db.statement'
           TAG_ROW_COUNT = 'db.row_count'
         end
+
+        module RPC
+          TAG_SYSTEM = 'rpc.system'
+          TAG_SERVICE = 'rpc.service'
+          TAG_METHOD = 'rpc.method'
+        end
       end
     end
   end

data/lib/datadog/tracing/contrib/faraday/middleware.rb

@@ -42,6 +42,8 @@ module Datadog
             span.service = service_name(env[:url].host, options)
             span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
 
+            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/grpc/datadog_interceptor/client.rb

@@ -4,6 +4,7 @@ require_relative '../../../../tracing'
 require_relative '../../../metadata/ext'
 require_relative '../../analytics'
 require_relative '../ext'
+require_relative '../../ext'
 
 module Datadog
   module Tracing
@@ -36,6 +37,10 @@ module Datadog
             def annotate!(trace, span, metadata, call)
               span.set_tags(metadata)
 
+              span.set_tag(Contrib::Ext::RPC::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_CLIENT)
 

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/server.rb

@@ -6,6 +6,7 @@ require_relative '../../../metadata/ext'
 require_relative '../../../propagation/grpc'
 require_relative '../../analytics'
 require_relative '../ext'
+require_relative '../../ext'
 
 module Datadog
   module Tracing
@@ -19,10 +20,11 @@ module Datadog
           # its tracing context with a parent client-side context
           class Server < Base
             def trace(keywords)
+              method = keywords[:method]
               options = {
                 span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
                 service: service_name, # TODO: Remove server-side service name configuration
-                resource: format_resource(keywords[:method]),
+                resource: format_resource(method),
                 on_error: error_handler
               }
               metadata = keywords[:call].metadata
@@ -30,6 +32,10 @@ module Datadog
               set_distributed_context!(metadata)
 
               Tracing.trace(Ext::SPAN_SERVICE, **options) do |span|
+                span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+                span.set_tag(Contrib::Ext::RPC::TAG_SERVICE, method.owner.to_s)
+                span.set_tag(Contrib::Ext::RPC::TAG_METHOD,  method.name)
+
                 annotate!(span, metadata)
 
                 yield

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

@@ -17,6 +17,8 @@ module Datadog
           TAG_COMPONENT = 'grpc'.freeze
           TAG_OPERATION_CLIENT = 'client'.freeze
           TAG_OPERATION_SERVICE = 'service'.freeze
+
+          TAG_SYSTEM = 'grpc'.freeze
         end
       end
     end

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

@@ -0,0 +1,47 @@
+# typed: ignore
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami Instrumentation for `hanami.action`
+        class ActionTracer
+          def initialize(app, action)
+            @app = app
+            @action = action
+          end
+
+          def call(env)
+            Tracing.trace(
+              Ext::SPAN_ACTION,
+              resource: @action.to_s,
+              service: configuration[:service_name],
+              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_ACTION)
+
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span_op, configuration[:analytics_sample_rate])
+              end
+
+              trace_op.resource = span_op.resource
+
+              @app.call(env)
+            end
+          end
+
+          private
+
+          def configuration
+            Datadog.configuration.tracing[:hanami]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: ignore
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        module Configuration
+          # Configuration for Hanami instrumentation
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+          end
+        end
+      end
+    end
+  end
+end

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