ddtrace 0.54.0 → 1.0.0

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

@@ -0,0 +1,125 @@
+# typed: true
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/presto/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Presto
+        # Instrumentation for Presto integration
+        module Instrumentation
+          # Instrumentation for Presto::Client::Client
+          module Client
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance methods for Presto::Client
+            module InstanceMethods
+              def run(query)
+                Tracing.trace(
+                  Ext::SPAN_QUERY,
+                  service: datadog_configuration[:service_name]
+                ) do |span|
+                  begin
+                    decorate!(span, Ext::TAG_OPERATION_QUERY)
+                    span.resource = query
+                    span.span_type = Tracing::Metadata::Ext::SQL::TYPE
+                    span.set_tag(Ext::TAG_QUERY_ASYNC, false)
+                  rescue StandardError => e
+                    Datadog.logger.debug("error preparing span for presto: #{e}")
+                  end
+
+                  super(query)
+                end
+              end
+
+              def query(query, &blk)
+                Tracing.trace(
+                  Ext::SPAN_QUERY,
+                  service: datadog_configuration[:service_name]
+                ) do |span|
+                  begin
+                    decorate!(span, Ext::TAG_OPERATION_QUERY)
+                    span.resource = query
+                    span.span_type = Tracing::Metadata::Ext::SQL::TYPE
+                    span.set_tag(Ext::TAG_QUERY_ASYNC, !blk.nil?)
+                  rescue StandardError => e
+                    Datadog.logger.debug("error preparing span for presto: #{e}")
+                  end
+
+                  super(query, &blk)
+                end
+              end
+
+              def kill(query_id)
+                Tracing.trace(
+                  Ext::SPAN_KILL,
+                  service: datadog_configuration[:service_name]
+                ) do |span|
+                  begin
+                    decorate!(span, Ext::TAG_OPERATION_KILL)
+                    span.resource = Ext::SPAN_KILL
+                    span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_DB
+                    # ^ not an SQL type span, since there's no SQL query
+                    span.set_tag(Ext::TAG_QUERY_ID, query_id)
+                  rescue StandardError => e
+                    Datadog.logger.debug("error preparing span for presto: #{e}")
+                  end
+
+                  super(query_id)
+                end
+              end
+
+              private
+
+              def datadog_configuration
+                Datadog.configuration.tracing[:presto]
+              end
+
+              def decorate!(span, operation)
+                span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, operation)
+
+                if (host_port = @options[:server])
+                  host, port = Core::Utils.extract_host_port(host_port)
+                  if host && port
+                    span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host)
+                    span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port)
+
+                    span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
+                  else
+                    span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host_port)
+                    span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host_port)
+                  end
+                end
+
+                set_nilable_tag!(span, :user, Ext::TAG_USER_NAME)
+                set_nilable_tag!(span, :schema, Ext::TAG_SCHEMA_NAME)
+                set_nilable_tag!(span, :catalog, Ext::TAG_CATALOG_NAME)
+                set_nilable_tag!(span, :time_zone, Ext::TAG_TIME_ZONE)
+                set_nilable_tag!(span, :language, Ext::TAG_LANGUAGE)
+                set_nilable_tag!(span, :http_proxy, Ext::TAG_PROXY)
+                set_nilable_tag!(span, :model_version, Ext::TAG_MODEL_VERSION)
+
+                # Tag as an external peer service
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+
+                # Set analytics sample rate
+                if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+                  Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+                end
+              end
+
+              def set_nilable_tag!(span, key, tag_name)
+                @options[key].tap { |val| span.set_tag(tag_name, val) if val }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/presto/configuration/settings'
+require 'datadog/tracing/contrib/presto/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Presto
+        # Description of Presto integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.5.14')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :presto
+
+          def self.version
+            Gem.loaded_specs['presto-client'] && Gem.loaded_specs['presto-client'].version
+          end
+
+          def self.loaded?
+            !defined?(::Presto::Client::Client).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/presto/patcher.rb

@@ -0,0 +1,37 @@
+# typed: true
+
+require 'datadog/core/utils/only_once'
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/presto/ext'
+require 'datadog/tracing/contrib/presto/instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Presto
+        # Patcher enables patching of 'presto-client' module.
+        module Patcher
+          include Contrib::Patcher
+
+          PATCH_ONLY_ONCE = Core::Utils::OnlyOnce.new
+
+          module_function
+
+          def patched?
+            PATCH_ONLY_ONCE.ran?
+          end
+
+          def patch
+            PATCH_ONLY_ONCE.run do
+              begin
+                ::Presto::Client::Client.include(Instrumentation::Client)
+              rescue StandardError => e
+                Datadog.logger.error("Unable to apply Presto integration: #{e}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/qless/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        module Configuration
+          # Custom settings for the Qless integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            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 :tag_job_data do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_JOB_DATA, false) }
+              o.lazy
+            end
+
+            option :tag_job_tags do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_JOB_TAGS, false) }
+              o.lazy
+            end
+
+            option :service_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        # Qless integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_QLESS_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QLESS_ANALYTICS_SAMPLE_RATE'.freeze
+          ENV_TAG_JOB_DATA = 'DD_QLESS_TAG_JOB_DATA'.freeze
+          ENV_TAG_JOB_TAGS = 'DD_QLESS_TAG_JOB_TAGS'.freeze
+          SERVICE_NAME = 'qless'.freeze
+          SPAN_JOB = 'qless.job'.freeze
+          TAG_JOB_ID = 'qless.job.id'.freeze
+          TAG_JOB_DATA = 'qless.job.data'.freeze
+          TAG_JOB_QUEUE = 'qless.job.queue'.freeze
+          TAG_JOB_TAGS = 'qless.job.tags'.freeze
+          TAG_COMPONENT = 'qless'.freeze
+          TAG_OPERATION_JOB = 'job'.freeze
+        end
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,39 @@
+# typed: true
+
+require 'datadog/tracing'
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/qless/integration'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        # Patcher enables patching of 'qless' module.
+        module Patcher
+          include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require_relative 'qless_job'
+            require_relative 'tracer_cleaner'
+
+            # Instrument all Qless Workers
+            # These are executed in inverse order of listing here
+            ::Qless::Workers::BaseWorker.include(QlessJob)
+            ::Qless::Workers::BaseWorker.include(TracerCleaner)
+          end
+
+          def get_option(option)
+            Datadog.configuration.tracing[:qless].get_option(option)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/qless/qless_job.rb

@@ -0,0 +1,75 @@
+# typed: false
+
+require 'qless'
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        # Uses Qless job hooks to create traces
+        module QlessJob
+          def around_perform(job)
+            return super unless datadog_configuration && Tracing.enabled?
+
+            Tracing.trace(Ext::SPAN_JOB, **span_options) do |span|
+              span.resource = job.klass_name
+              span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
+              span.set_tag(Ext::TAG_JOB_ID, job.jid)
+              span.set_tag(Ext::TAG_JOB_QUEUE, job.queue_name)
+
+              tag_job_tags = datadog_configuration[:tag_job_tags]
+              span.set_tag(Ext::TAG_JOB_TAGS, job.tags) if tag_job_tags
+
+              tag_job_data = datadog_configuration[:tag_job_data]
+              if tag_job_data && !job.data.empty?
+                job_data = job.data.with_indifferent_access
+                formatted_data = job_data.except(:tags).map do |key, value|
+                  "#{key}:#{value}".underscore
+                end
+
+                span.set_tag(Ext::TAG_JOB_DATA, formatted_data)
+              end
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+              end
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              super
+            end
+          end
+
+          def after_fork
+            configuration = Datadog.configuration.tracing[:qless]
+            return if configuration.nil?
+
+            # Add a pin, marking the job as forked.
+            # Used to trigger shutdown in forks for performance reasons.
+            # Cleanup happens in the TracerCleaner class
+            Datadog.configure_onto(::Qless, forked: true)
+          end
+
+          private
+
+          def span_options
+            { service: datadog_configuration[:service_name] }
+          end
+
+          def datadog_configuration
+            Datadog.configuration.tracing[:qless]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/qless/tracer_cleaner.rb

@@ -0,0 +1,32 @@
+# typed: true
+
+require 'datadog/tracing'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        # Shutdown Tracer in forks for performance reasons
+        module TracerCleaner
+          def around_perform(job)
+            return super unless datadog_configuration && Tracing.enabled?
+
+            super.tap do
+              Tracing.shutdown! if forked?
+            end
+          end
+
+          private
+
+          def forked?
+            Datadog.configuration_for(::Qless, :forked) == true
+          end
+
+          def datadog_configuration
+            Datadog.configuration.tracing[:qless]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/tracing/span_operation'
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/que/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        module Configuration
+          # Default settings for the Que integration
+          class Settings < Contrib::Configuration::Settings
+            option :service_name
+            option :distributed_tracing, default: true
+
+            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 :tag_args do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_ARGS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :tag_data do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_DATA_ENABLED, false) }
+              o.lazy
+            end
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# typed: strict
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Que integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'
+          ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'
+          ENV_TAG_ARGS_ENABLED = 'DD_TRACE_QUE_TAG_ARGS_ENABLED'
+          ENV_TAG_DATA_ENABLED = 'DD_TRACE_QUE_TAG_DATA_ENABLED'
+          SERVICE_NAME = 'que'
+          SPAN_JOB = 'que.job'
+          TAG_JOB_ARGS = 'que.job.args'
+          TAG_JOB_DATA = 'que.job.data'
+          TAG_JOB_ERROR_COUNT = 'que.job.error_count'
+          TAG_JOB_EXPIRED_AT = 'que.job.expired_at'
+          TAG_JOB_FINISHED_AT = 'que.job.finished_at'
+          TAG_JOB_ID = 'que.job.id'
+          TAG_JOB_PRIORITY = 'que.job.priority'
+          TAG_JOB_QUEUE = 'que.job.queue'
+          TAG_JOB_RUN_AT = 'que.job.run_at'
+          TAG_COMPONENT = 'que'
+          TAG_OPERATION_JOB = 'job'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/que/ext'
+require 'datadog/tracing/contrib/que/configuration/settings'
+require 'datadog/tracing/contrib/que/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Description of Que integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.0.0.beta2')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :que, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['que'] && Gem.loaded_specs['que'].version
+          end
+
+          def self.loaded?
+            !defined?(::Que).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/que/patcher.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/tracing/contrib/que/integration'
+require 'datadog/tracing/contrib/que/tracer'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Patcher enables patching of 'que' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Que.job_middleware.push(Que::Tracer.new)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/que/tracer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# typed: true
+
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Tracer is a Que's server-side middleware which traces executed jobs
+        class Tracer
+          def call(job)
+            trace_options = {
+              service: configuration[:service_name],
+              span_type: Tracing::Metadata::Ext::AppTypes::TYPE_WORKER,
+              on_error: configuration[:error_handler]
+            }
+
+            Tracing.trace(Ext::SPAN_JOB, **trace_options) do |request_span|
+              request_span.resource = job.class.name.to_s
+
+              request_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              request_span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+
+              request_span.set_tag(Ext::TAG_JOB_QUEUE, job.que_attrs[:queue])
+              request_span.set_tag(Ext::TAG_JOB_ID, job.que_attrs[:id])
+              request_span.set_tag(Ext::TAG_JOB_PRIORITY, job.que_attrs[:priority])
+              request_span.set_tag(Ext::TAG_JOB_ERROR_COUNT, job.que_attrs[:error_count])
+              request_span.set_tag(Ext::TAG_JOB_RUN_AT, job.que_attrs[:run_at])
+              request_span.set_tag(Ext::TAG_JOB_EXPIRED_AT, job.que_attrs[:expired_at])
+              request_span.set_tag(Ext::TAG_JOB_FINISHED_AT, job.que_attrs[:finished_at])
+              request_span.set_tag(Ext::TAG_JOB_ARGS, job.que_attrs[:args]) if configuration[:tag_args]
+              request_span.set_tag(Ext::TAG_JOB_DATA, job.que_attrs[:data]) if configuration[:tag_data]
+
+              set_sample_rate(request_span)
+              Contrib::Analytics.set_measured(request_span)
+
+              yield
+            end
+          end
+
+          private
+
+          def set_sample_rate(request_span)
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(
+                request_span,
+                configuration[:analytics_sample_rate]
+              )
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:que]
+          end
+        end
+      end
+    end
+  end
+end