ddtrace 0.38.0 → 0.43.0

data/lib/ddtrace/contrib/sneakers/tracer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  module Contrib
+    module Sneakers
+      # Tracer is a Sneakers server-side middleware which traces executed jobs
+      class Tracer
+        def initialize(app, *args)
+          @app = app
+          @args = args
+        end
+
+        def call(deserialized_msg, delivery_info, metadata, handler)
+          trace_options = {
+            service:   configuration[:service_name],
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: configuration[:error_handler]
+          }
+
+          tracer.trace(Ext::SPAN_JOB, trace_options) do |request_span|
+            # Set analytics sample rate
+            if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Datadog::Contrib::Analytics.set_sample_rate(request_span, configuration[:analytics_sample_rate])
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(request_span)
+
+            request_span.resource = @app.to_proc.binding.eval('self.class').to_s
+            request_span.set_tag(Ext::TAG_JOB_ROUTING_KEY, delivery_info.routing_key)
+            request_span.set_tag(Ext::TAG_JOB_QUEUE, delivery_info.consumer.queue.name)
+
+            if configuration[:tag_body]
+              request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg)
+            end
+
+            @app.call(deserialized_msg, delivery_info, metadata, handler)
+          end
+        end
+
+        private
+
+        def tracer
+          configuration[:tracer]
+        end
+
+        def configuration
+          Datadog.configuration[:sneakers]
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/status_code_matcher.rb

@@ -0,0 +1,67 @@
+require 'set'
+require 'ddtrace/ext/http'
+
+module Datadog
+  module Contrib
+    # Contains methods helpful for tracing/annotating HTTP request libraries
+    class StatusCodeMatcher
+      REGEX_PARSER = /^\d{3}(?:-\d{3})?(?:,\d{3}(?:-\d{3})?)*$/
+
+      def initialize(range)
+        @error_response_range = range
+        set_range
+      end
+
+      def include?(exception_status)
+        set_range.include?(exception_status)
+      end
+
+      def to_s
+        @error_response_range.to_s
+      end
+
+      private
+
+      def set_range
+        @datadog_set ||= begin
+          set = Set.new
+          handle_statuses.each do |statuses|
+            status = statuses.to_s.split('-')
+            if status.length == 1
+              set.add(Integer(status[0]))
+            elsif status.length == 2
+              min, max = status.minmax
+              Array(min..max).each do |i|
+                set.add(Integer(i))
+              end
+            end
+          end
+          set
+        end
+        @datadog_set
+      end
+
+      def error_responses
+        return @error_response_range if @error_response_range.is_a?(String) && !@error_response_range.nil?
+        @error_response_range.join(',') if @error_response_range.is_a?(Array) && !@error_response_range.empty?
+      end
+
+      def handle_statuses
+        if error_responses
+          filter_error_responses = error_responses.gsub(/\s+/, '').split(',').select do |code|
+            if !code.to_s.match(REGEX_PARSER)
+              Datadog.logger.debug("Invalid config provided: #{code}. Must be formatted like '400-403,405,410-499'.")
+              next
+            else
+              true
+            end
+          end
+          filter_error_responses.empty? ? Datadog::Ext::HTTP::ERROR_RANGE.to_a : filter_error_responses
+        else
+          Datadog.logger.debug('No valid config was provided for :error_statuses - falling back to default.')
+          Datadog::Ext::HTTP::ERROR_RANGE.to_a
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sucker_punch/configuration/settings.rb

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the SuckerPunch integration
         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.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

data/lib/ddtrace/contrib/sucker_punch/ext.rb

@@ -4,8 +4,11 @@ module Datadog
       # SuckerPunch integration constants
       module Ext
         APP = 'sucker_punch'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_SUCKER_PUNCH_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SUCKER_PUNCH_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_SUCKER_PUNCH_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SUCKER_PUNCH_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_SUCKER_PUNCH_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SUCKER_PUNCH_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SUCKER_PUNCH_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'sucker_punch'.freeze
         SPAN_PERFORM = 'sucker_punch.perform'.freeze
         SPAN_PERFORM_ASYNC = 'sucker_punch.perform_async'.freeze

data/lib/ddtrace/diagnostics/environment_logger.rb

@@ -28,7 +28,7 @@ module Datadog
         private
 
         def log_environment!(line)
-          Datadog.logger.warn("DATADOG TRACER CONFIGURATION - #{line}")
+          Datadog.logger.info("DATADOG TRACER CONFIGURATION - #{line}")
         end
 
         def log_error!(type, error)

data/lib/ddtrace/environment.rb

@@ -6,24 +6,34 @@ module Datadog
     # Defines helper methods for environment
     module Helpers
       def env_to_bool(var, default = nil)
-        ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default
+        var = decode_array(var)
+        var && ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default
       end
 
       def env_to_int(var, default = nil)
-        ENV.key?(var) ? ENV[var].to_i : default
+        var = decode_array(var)
+        var && ENV.key?(var) ? ENV[var].to_i : default
       end
 
       def env_to_float(var, default = nil)
-        ENV.key?(var) ? ENV[var].to_f : default
+        var = decode_array(var)
+        var && ENV.key?(var) ? ENV[var].to_f : default
       end
 
       def env_to_list(var, default = [])
-        if ENV.key?(var)
+        var = decode_array(var)
+        if var && ENV.key?(var)
           ENV[var].split(',').map(&:strip)
         else
           default
         end
       end
+
+      private
+
+      def decode_array(var)
+        var.is_a?(Array) ? var.find { |env_var| ENV.key?(env_var) } : var
+      end
     end
 
     extend Helpers

data/lib/ddtrace/ext/app_types.rb

@@ -6,6 +6,7 @@ module Datadog
       CACHE = 'cache'.freeze
       WORKER = 'worker'.freeze
       CUSTOM = 'custom'.freeze
+      TEST = 'test'.freeze
     end
   end
 end

data/lib/ddtrace/ext/ci.rb

@@ -0,0 +1,265 @@
+require 'ddtrace/ext/git'
+
+module Datadog
+  module Ext
+    # Defines constants for CI tags
+    # rubocop:disable Metrics/ModuleLength:
+    module CI
+      TAG_JOB_URL = 'ci.job.url'.freeze
+      TAG_PIPELINE_ID = 'ci.pipeline.id'.freeze
+      TAG_PIPELINE_NAME = 'ci.pipeline.name'.freeze
+      TAG_PIPELINE_NUMBER = 'ci.pipeline.number'.freeze
+      TAG_PIPELINE_URL = 'ci.pipeline.url'.freeze
+      TAG_PROVIDER_NAME = 'ci.provider.name'.freeze
+      TAG_WORKSPACE_PATH = 'ci.workspace_path'.freeze
+
+      PROVIDERS = [
+        ['APPVEYOR'.freeze, :extract_appveyor],
+        ['TF_BUILD'.freeze, :extract_azure_pipelines],
+        ['BITBUCKET_COMMIT'.freeze, :extract_bitbucket],
+        ['BUILDKITE'.freeze, :extract_buildkite],
+        ['CIRCLECI'.freeze, :extract_circle_ci],
+        ['GITHUB_SHA'.freeze, :extract_github_actions],
+        ['GITLAB_CI'.freeze, :extract_gitlab],
+        ['JENKINS_URL'.freeze, :extract_jenkins],
+        ['TEAMCITY_VERSION'.freeze, :extract_teamcity],
+        ['TRAVIS'.freeze, :extract_travis]
+      ].freeze
+
+      module_function
+
+      def tags(env)
+        provider = PROVIDERS.find { |c| env.key? c[0] }
+        return {} if provider.nil?
+
+        tags = send(provider[1], env)
+
+        tags[Git::TAG_TAG] = normalize_ref(tags[Git::TAG_TAG])
+        tags.delete(Git::TAG_BRANCH) unless tags[Git::TAG_TAG].nil?
+        tags[Git::TAG_BRANCH] = normalize_ref(tags[Git::TAG_BRANCH])
+        tags[Git::TAG_DEPRECATED_COMMIT_SHA] = tags[Git::TAG_COMMIT_SHA]
+        tags[Git::TAG_REPOSITORY_URL] = filter_sensitive_info(tags[Git::TAG_REPOSITORY_URL])
+
+        # Expand ~
+        workspace_path = tags[TAG_WORKSPACE_PATH]
+        if !workspace_path.nil? && (workspace_path == '~' || workspace_path.start_with?('~/'))
+          tags[TAG_WORKSPACE_PATH] = File.expand_path(workspace_path)
+        end
+        tags.reject { |_, v| v.nil? }
+      end
+
+      def normalize_ref(name)
+        refs = %r{^refs/(heads/)?}
+        origin = %r{^origin/}
+        tags = %r{^tags/}
+        name.gsub(refs, '').gsub(origin, '').gsub(tags, '') unless name.nil?
+      end
+
+      def filter_sensitive_info(url)
+        url.gsub(%r{(https?://)[^/]*@}, '\1') unless url.nil?
+      end
+
+      # CI providers
+
+      def extract_appveyor(env)
+        url = "https://ci.appveyor.com/project/#{env['APPVEYOR_REPO_NAME']}/builds/#{env['APPVEYOR_BUILD_ID']}"
+        {
+          TAG_PROVIDER_NAME => 'appveyor',
+          Git::TAG_REPOSITORY_URL =>  "https://github.com/#{env['APPVEYOR_REPO_NAME']}.git",
+          Git::TAG_COMMIT_SHA => env['APPVEYOR_REPO_COMMIT'],
+          TAG_WORKSPACE_PATH => env['APPVEYOR_BUILD_FOLDER'],
+          TAG_PIPELINE_ID => env['APPVEYOR_BUILD_ID'],
+          TAG_PIPELINE_NAME => env['APPVEYOR_REPO_NAME'],
+          TAG_PIPELINE_NUMBER => env['APPVEYOR_BUILD_NUMBER'],
+          TAG_PIPELINE_URL => url,
+          TAG_JOB_URL => url,
+          Git::TAG_BRANCH => (env['APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH'] || env['APPVEYOR_REPO_BRANCH']),
+          Git::TAG_TAG => env['APPVEYOR_REPO_TAG_NAME']
+        }
+      end
+
+      def extract_azure_pipelines(env)
+        if env['SYSTEM_TEAMFOUNDATIONSERVERURI'] && env['SYSTEM_TEAMPROJECT'] && env['BUILD_BUILDID']
+          base_url = "#{env['SYSTEM_TEAMFOUNDATIONSERVERURI']}#{env['SYSTEM_TEAMPROJECT']}" \
+            "/_build/results?buildId=#{env['BUILD_BUILDID']}"
+          pipeline_url = base_url + '&_a=summary'
+          job_url = base_url + "&view=logs&j=#{env['SYSTEM_JOBID']}&t=#{env['SYSTEM_TASKINSTANCEID']}"
+        else
+          pipeline_url = job_url = nil
+        end
+        branch_or_tag = (
+          env['SYSTEM_PULLREQUEST_SOURCEBRANCH'] || env['BUILD_SOURCEBRANCH'] || env['BUILD_SOURCEBRANCHNAME']
+        )
+        if branch_or_tag.include? 'tags/'
+          branch = nil
+          tag = branch_or_tag
+        else
+          branch = branch_or_tag
+          tag = nil
+        end
+        {
+          TAG_PROVIDER_NAME => 'azurepipelines',
+          TAG_WORKSPACE_PATH => env['BUILD_SOURCESDIRECTORY'],
+          TAG_PIPELINE_ID => env['BUILD_BUILDID'],
+          TAG_PIPELINE_NAME => env['BUILD_DEFINITIONNAME'],
+          TAG_PIPELINE_NUMBER => env['BUILD_BUILDID'],
+          TAG_PIPELINE_URL => pipeline_url,
+          TAG_JOB_URL => job_url,
+          Git::TAG_REPOSITORY_URL => (env['SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI'] || env['BUILD_REPOSITORY_URI']),
+          Git::TAG_COMMIT_SHA => (env['SYSTEM_PULLREQUEST_SOURCECOMMITID'] || env['BUILD_SOURCEVERSION']),
+          Git::TAG_BRANCH => branch,
+          Git::TAG_TAG => tag
+        }
+      end
+
+      def extract_bitbucket(env)
+        url = "https://bitbucket.org/#{env['BITBUCKET_REPO_FULL_NAME']}/addon/pipelines/home#" \
+          "!/results/#{env['BITBUCKET_BUILD_NUMBER']}"
+        {
+          Git::TAG_BRANCH => env['BITBUCKET_BRANCH'],
+          Git::TAG_COMMIT_SHA => env['BITBUCKET_COMMIT'],
+          Git::TAG_REPOSITORY_URL => env['BITBUCKET_GIT_SSH_ORIGIN'],
+          Git::TAG_TAG => env['BITBUCKET_TAG'],
+          TAG_JOB_URL => url,
+          TAG_PIPELINE_ID => env['BITBUCKET_PIPELINE_UUID'] ? env['BITBUCKET_PIPELINE_UUID'].tr('{}', '') : None,
+          TAG_PIPELINE_NAME => env['BITBUCKET_REPO_FULL_NAME'],
+          TAG_PIPELINE_NUMBER => env['BITBUCKET_BUILD_NUMBER'],
+          TAG_PIPELINE_URL => url,
+          TAG_PROVIDER_NAME => 'bitbucket',
+          TAG_WORKSPACE_PATH => env['BITBUCKET_CLONE_DIR']
+        }
+      end
+
+      def extract_buildkite(env)
+        {
+          Git::TAG_BRANCH => env['BUILDKITE_BRANCH'],
+          Git::TAG_COMMIT_SHA => env['BUILDKITE_COMMIT'],
+          Git::TAG_REPOSITORY_URL => env['BUILDKITE_REPO'],
+          Git::TAG_TAG => env['BUILDKITE_TAG'],
+          TAG_PIPELINE_ID => env['BUILDKITE_BUILD_ID'],
+          TAG_PIPELINE_NAME => env['BUILDKITE_PIPELINE_SLUG'],
+          TAG_PIPELINE_NUMBER => env['BUILDKITE_BUILD_NUMBER'],
+          TAG_PIPELINE_URL => env['BUILDKITE_BUILD_URL'],
+          TAG_JOB_URL => "#{env['BUILDKITE_BUILD_URL']}##{env['BUILDKITE_JOB_ID']}",
+          TAG_PROVIDER_NAME => 'buildkite',
+          TAG_WORKSPACE_PATH => env['BUILDKITE_BUILD_CHECKOUT_PATH']
+        }
+      end
+
+      def extract_circle_ci(env)
+        {
+          Git::TAG_BRANCH => env['CIRCLE_BRANCH'],
+          Git::TAG_COMMIT_SHA => env['CIRCLE_SHA1'],
+          Git::TAG_REPOSITORY_URL => env['CIRCLE_REPOSITORY_URL'],
+          Git::TAG_TAG => env['CIRCLE_TAG'],
+          TAG_PIPELINE_ID => env['CIRCLE_WORKFLOW_ID'],
+          TAG_PIPELINE_NAME => env['CIRCLE_PROJECT_REPONAME'],
+          TAG_PIPELINE_NUMBER => env['CIRCLE_BUILD_NUM'],
+          TAG_PIPELINE_URL => env['CIRCLE_BUILD_URL'],
+          TAG_JOB_URL => env['CIRCLE_BUILD_URL'],
+          TAG_PROVIDER_NAME => 'circleci',
+          TAG_WORKSPACE_PATH => env['CIRCLE_WORKING_DIRECTORY']
+        }
+      end
+
+      def extract_github_actions(env)
+        branch_or_tag = (env['GITHUB_HEAD_REF'] || env['GITHUB_REF'])
+        if branch_or_tag.include? 'tags/'
+          branch = nil
+          tag = branch_or_tag
+        else
+          branch = branch_or_tag
+          tag = nil
+        end
+        {
+          Git::TAG_BRANCH => branch,
+          Git::TAG_COMMIT_SHA => env['GITHUB_SHA'],
+          Git::TAG_REPOSITORY_URL => "https://github.com/#{env['GITHUB_REPOSITORY']}.git",
+          Git::TAG_TAG => tag,
+          TAG_JOB_URL => "https://github.com/#{env['GITHUB_REPOSITORY']}/commit/#{env['GITHUB_SHA']}/checks",
+          TAG_PIPELINE_ID => env['GITHUB_RUN_ID'],
+          TAG_PIPELINE_NAME => env['GITHUB_WORKFLOW'],
+          TAG_PIPELINE_NUMBER => env['GITHUB_RUN_NUMBER'],
+          TAG_PIPELINE_URL => "https://github.com/#{env['GITHUB_REPOSITORY']}/commit/#{env['GITHUB_SHA']}/checks",
+          TAG_PROVIDER_NAME => 'github',
+          TAG_WORKSPACE_PATH => env['GITHUB_WORKSPACE']
+        }
+      end
+
+      def extract_gitlab(env)
+        url = env['CI_PIPELINE_URL']
+        url = url.gsub(%r{/-/pipelines/}, '/pipelines/') unless url.nil?
+        {
+          Git::TAG_BRANCH => env['CI_COMMIT_BRANCH'],
+          Git::TAG_COMMIT_SHA => env['CI_COMMIT_SHA'],
+          Git::TAG_REPOSITORY_URL => env['CI_REPOSITORY_URL'],
+          Git::TAG_TAG => env['CI_COMMIT_TAG'],
+          TAG_JOB_URL => env['CI_JOB_URL'],
+          TAG_PIPELINE_ID => env['CI_PIPELINE_ID'],
+          TAG_PIPELINE_NAME => env['CI_PROJECT_PATH'],
+          TAG_PIPELINE_NUMBER => env['CI_PIPELINE_IID'],
+          TAG_PIPELINE_URL => url,
+          TAG_PROVIDER_NAME => 'gitlab',
+          TAG_WORKSPACE_PATH => env['CI_PROJECT_DIR']
+        }
+      end
+
+      def extract_jenkins(env)
+        branch_or_tag = env['GIT_BRANCH']
+        if branch_or_tag.include? 'tags/'
+          branch = nil
+          tag = branch_or_tag
+        else
+          branch = branch_or_tag
+          tag = nil
+        end
+        name = env['JOB_NAME']
+        name = name.gsub("/#{normalize_ref(branch)}", '') unless name.nil? || branch.nil?
+        name = name.split('/').reject { |v| v.nil? || v.include?('=') }.join('/') unless name.nil?
+        {
+          Git::TAG_BRANCH => branch,
+          Git::TAG_COMMIT_SHA => env['GIT_COMMIT'],
+          Git::TAG_REPOSITORY_URL => env['GIT_URL'],
+          Git::TAG_TAG => tag,
+          TAG_JOB_URL => env['JOB_URL'],
+          TAG_PIPELINE_ID => env['BUILD_TAG'],
+          TAG_PIPELINE_NAME => name,
+          TAG_PIPELINE_NUMBER => env['BUILD_NUMBER'],
+          TAG_PIPELINE_URL => env['BUILD_URL'],
+          TAG_PROVIDER_NAME => 'jenkins',
+          TAG_WORKSPACE_PATH => env['WORKSPACE']
+        }
+      end
+
+      def extract_teamcity(env)
+        {
+          TAG_PROVIDER_NAME => 'teamcity',
+          Git::TAG_REPOSITORY_URL => env['BUILD_VCS_URL'],
+          Git::TAG_COMMIT_SHA => env['BUILD_VCS_NUMBER'],
+          TAG_WORKSPACE_PATH => env['BUILD_CHECKOUTDIR'],
+          TAG_PIPELINE_ID => env['BUILD_ID'],
+          TAG_PIPELINE_NUMBER => env['BUILD_NUMBER'],
+          TAG_PIPELINE_URL => (
+            env['SERVER_URL'] && env['BUILD_ID'] ? "#{env['SERVER_URL']}/viewLog.html?buildId=#{env['SERVER_URL']}" : nil
+          )
+        }
+      end
+
+      def extract_travis(env)
+        {
+          Git::TAG_BRANCH => (env['TRAVIS_PULL_REQUEST_BRANCH'] || env['TRAVIS_BRANCH']),
+          Git::TAG_COMMIT_SHA => env['TRAVIS_COMMIT'],
+          Git::TAG_REPOSITORY_URL =>  "https://github.com/#{env['TRAVIS_REPO_SLUG']}.git",
+          Git::TAG_TAG => env['TRAVIS_TAG'],
+          TAG_JOB_URL => env['TRAVIS_JOB_WEB_URL'],
+          TAG_PIPELINE_ID => env['TRAVIS_BUILD_ID'],
+          TAG_PIPELINE_NAME => env['TRAVIS_REPO_SLUG'],
+          TAG_PIPELINE_NUMBER => env['TRAVIS_BUILD_NUMBER'],
+          TAG_PIPELINE_URL => env['TRAVIS_BUILD_WEB_URL'],
+          TAG_PROVIDER_NAME => 'travisci',
+          TAG_WORKSPACE_PATH => env['TRAVIS_BUILD_DIR']
+        }
+      end
+    end
+  end
+end