ddtrace 0.44.0 → 0.48.0

data/lib/ddtrace/contrib/rspec/patcher.rb

@@ -1,6 +1,5 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/rspec/example'
-require 'ddtrace/contrib/rspec/example_group'
 
 module Datadog
   module Contrib
@@ -17,7 +16,6 @@ module Datadog
 
         def patch
           ::RSpec::Core::Example.send(:include, Example)
-          ::RSpec::Core::ExampleGroup.send(:include, ExampleGroup)
         end
       end
     end

data/lib/ddtrace/contrib/sequel/utils.rb

@@ -30,12 +30,11 @@ module Datadog
 
           def parse_opts(sql, opts, db_opts, dataset = nil)
             # Prepared statements don't provide their sql query in the +sql+ parameter.
-            unless sql.is_a?(String)
-              if dataset && dataset.respond_to?(:prepared_sql) && (resolved_sql = dataset.prepared_sql)
-                # The dataset contains the resolved SQL query and prepared statement name.
-                prepared_name = dataset.prepared_statement_name
-                sql = resolved_sql
-              end
+            if !sql.is_a?(String) && (dataset && dataset.respond_to?(:prepared_sql) &&
+              (resolved_sql = dataset.prepared_sql))
+              # The dataset contains the resolved SQL query and prepared statement name.
+              prepared_name = dataset.prepared_statement_name
+              sql = resolved_sql
             end
 
             {

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

@@ -23,6 +23,7 @@ module Datadog
 
           option :service_name, default: Ext::SERVICE_NAME
           option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
+          option :tag_body, default: false
         end
       end
     end

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

@@ -12,9 +12,12 @@ module Datadog
         end
 
         def call(worker_instance, queue, sqs_msg, body)
-          @tracer.trace(Ext::SPAN_JOB, service: @shoryuken_service, span_type: Datadog::Ext::AppTypes::WORKER,
-                                       on_error: @error_handler) do |span|
-
+          @tracer.trace(
+            Ext::SPAN_JOB,
+            service: @shoryuken_service,
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: @error_handler
+          ) do |span|
             # Set analytics sample rate
             if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
               Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
@@ -27,7 +30,7 @@ module Datadog
             span.set_tag(Ext::TAG_JOB_ID, sqs_msg.message_id)
             span.set_tag(Ext::TAG_JOB_QUEUE, queue)
             span.set_tag(Ext::TAG_JOB_ATTRIBUTES, sqs_msg.attributes) if sqs_msg.respond_to?(:attributes)
-            span.set_tag(Ext::TAG_JOB_BODY, body)
+            span.set_tag(Ext::TAG_JOB_BODY, body) if configuration[:tag_body]
 
             yield
           end

data/lib/ddtrace/contrib/sidekiq/server_tracer.rb

@@ -22,7 +22,6 @@ module Datadog
 
           @tracer.trace(Ext::SPAN_JOB, service: service, span_type: Datadog::Ext::AppTypes::WORKER,
                                        on_error: @error_handler) do |span|
-
             span.resource = resource
             # Set analytics sample rate
             if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
@@ -38,9 +37,7 @@ module Datadog
             span.set_tag(Ext::TAG_JOB_QUEUE, job['queue'])
             span.set_tag(Ext::TAG_JOB_WRAPPER, job['class']) if job['wrapped']
             span.set_tag(Ext::TAG_JOB_DELAY, 1000.0 * (Time.now.utc.to_f - job['enqueued_at'].to_f))
-            if tag_args && !job['args'].nil? && !job['args'].empty?
-              span.set_tag(Ext::TAG_JOB_ARGS, job['args'])
-            end
+            span.set_tag(Ext::TAG_JOB_ARGS, job['args']) if tag_args && !job['args'].nil? && !job['args'].empty?
 
             yield
           end
@@ -60,9 +57,7 @@ module Datadog
             nil
           end
 
-          if worker_klass.respond_to?(:datadog_tracer_config)
-            worker_klass.datadog_tracer_config[key]
-          end
+          worker_klass.datadog_tracer_config[key] if worker_klass.respond_to?(:datadog_tracer_config)
         end
       end
     end

data/lib/ddtrace/contrib/sidekiq/tracing.rb

@@ -31,7 +31,6 @@ module Datadog
           job['class'].to_s
         end
 
-        #
         def delay_extension_class(job)
           clazz, method = YAML.parse(job['args'].first).children.first.children
 

data/lib/ddtrace/contrib/sinatra/env.rb

@@ -23,9 +23,7 @@ module Datadog
           {}.tap do |result|
             headers.each do |header|
               rack_header = header_to_rack_header(header)
-              if env.key?(rack_header)
-                result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header]
-              end
+              result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header] if env.key?(rack_header)
             end
           end
         end

data/lib/ddtrace/contrib/sinatra/headers.rb

@@ -18,9 +18,7 @@ module Datadog
                 # Try a case-insensitive lookup
                 uppercased_header = header.to_s.upcase
                 matching_header = headers.keys.find { |h| h.upcase == uppercased_header }
-                if matching_header
-                  result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header]
-                end
+                result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header] if matching_header
               end
             end
           end

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

@@ -110,9 +110,7 @@ module Datadog
 
               span.set_tag(Ext::TAG_APP_NAME, settings.name || settings.superclass.name)
               span.set_tag(Ext::TAG_ROUTE_PATH, @datadog_route)
-              if request.script_name && !request.script_name.empty?
-                span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
-              end
+              span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
 
               rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
               rack_request_span.resource = span.resource if rack_request_span

data/lib/ddtrace/contrib/sinatra/tracer_middleware.rb

@@ -15,6 +15,8 @@ module Datadog
 
         # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
         def call(env)
           # Set the trace context (e.g. distributed tracing)
           if configuration[:distributed_tracing] && tracer.provider.context.trace_id.nil?
@@ -40,9 +42,7 @@ module Datadog
               request = ::Sinatra::Request.new(env)
               span.set_tag(Datadog::Ext::HTTP::URL, request.path)
               span.set_tag(Datadog::Ext::HTTP::METHOD, request.request_method)
-              if request.script_name && !request.script_name.empty?
-                span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
-              end
+              span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
 
               span.set_tag(Ext::TAG_APP_NAME, @app_instance.settings.name)
 

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

@@ -5,17 +5,17 @@ module Datadog
     module Sneakers
       # Sneakers integration constants
       module Ext
-        APP = 'sneakers'.freeze
-        ENV_ENABLED = 'DD_TRACE_SNEAKERS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SNEAKERS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_SNEAKERS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SNEAKERS_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SNEAKERS_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'sneakers'.freeze
-        SPAN_JOB = 'sneakers.job'.freeze
-        TAG_JOB_ROUTING_KEY = 'sneakers.routing_key'.freeze
-        TAG_JOB_QUEUE = 'sneakers.queue'.freeze
-        TAG_JOB_BODY = 'sneakers.body'.freeze
+        APP = 'sneakers'
+        ENV_ENABLED = 'DD_TRACE_SNEAKERS_ENABLED'
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SNEAKERS_ANALYTICS_ENABLED'
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_SNEAKERS_ANALYTICS_ENABLED'
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SNEAKERS_ANALYTICS_SAMPLE_RATE'
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SNEAKERS_ANALYTICS_SAMPLE_RATE'
+        SERVICE_NAME = 'sneakers'
+        SPAN_JOB = 'sneakers.job'
+        TAG_JOB_ROUTING_KEY = 'sneakers.routing_key'
+        TAG_JOB_QUEUE = 'sneakers.queue'
+        TAG_JOB_BODY = 'sneakers.body'
       end
     end
   end

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

@@ -14,7 +14,7 @@ module Datadog
 
         def call(deserialized_msg, delivery_info, metadata, handler)
           trace_options = {
-            service:   configuration[:service_name],
+            service: configuration[:service_name],
             span_type: Datadog::Ext::AppTypes::WORKER,
             on_error: configuration[:error_handler]
           }
@@ -32,9 +32,7 @@ module Datadog
             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
+            request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg) if configuration[:tag_body]
 
             @app.call(deserialized_msg, delivery_info, metadata, handler)
           end

data/lib/ddtrace/contrib/status_code_matcher.rb

@@ -5,7 +5,7 @@ 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})?)*$/
+      REGEX_PARSER = /^\d{3}(?:-\d{3})?(?:,\d{3}(?:-\d{3})?)*$/.freeze
 
       def initialize(range)
         @error_response_range = range
@@ -27,9 +27,10 @@ module Datadog
           set = Set.new
           handle_statuses.each do |statuses|
             status = statuses.to_s.split('-')
-            if status.length == 1
+            case status.length
+            when 1
               set.add(Integer(status[0]))
-            elsif status.length == 2
+            when 2
               min, max = status.minmax
               Array(min..max).each do |i|
                 set.add(Integer(i))
@@ -43,6 +44,7 @@ module Datadog
 
       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
 

data/lib/ddtrace/correlation.rb

@@ -32,6 +32,7 @@ module Datadog
     # Produces a CorrelationIdentifier from the Context provided
     def identifier_from_context(context)
       return Identifier.new.freeze if context.nil?
+
       Identifier.new(context.trace_id, context.span_id).freeze
     end
   end

data/lib/ddtrace/diagnostics/environment_logger.rb

@@ -7,13 +7,13 @@ module Datadog
     # A holistic collection of the environment in which ddtrace is running.
     # This logger should allow for easy reporting by users to Datadog support.
     #
-    # rubocop:disable Style/DoubleNegation
     module EnvironmentLogger
       class << self
         # Outputs environment information to {Datadog.logger}.
         # Executes only for the lifetime of the program.
         def log!(transport_responses)
-          return if @executed || !log?
+          return if (defined?(@executed) && @executed) || !log?
+
           @executed = true
 
           data = EnvironmentCollector.new.collect!(transport_responses)
@@ -165,6 +165,7 @@ module Datadog
       def tags
         tags = Datadog.configuration.tags
         return nil if tags.empty?
+
         hash_serializer(tags)
       end
 

data/lib/ddtrace/distributed_tracing/headers/headers.rb

@@ -36,6 +36,7 @@ module Datadog
 
           # Zero or greater than max allowed value of 2**64
           return if id.zero? || id > Span::EXTERNAL_MAX_ID
+
           id < 0 ? id + (2**64) : id
         end
 

data/lib/ddtrace/distributed_tracing/headers/helpers.rb

@@ -35,9 +35,7 @@ module Datadog
           #      for us so we want to make sure the comparision will work as expected
           # DEV: regex, remove all leading zeros up until we find the last 0 in the string
           #      or we find the first non-zero, this allows `'0000' -> '0'` and `'00001' -> '1'`
-          value = value.sub(/^0*(?=(0$)|[^0])/, '')
-
-          value
+          value.sub(/^0*(?=(0$)|[^0])/, '')
         end
       end
     end

data/lib/ddtrace/error.rb

@@ -16,6 +16,8 @@ module Datadog
 
     def initialize(type = nil, message = nil, backtrace = nil)
       backtrace = Array(backtrace).join("\n")
+
+      # DEV: We should measure if `Utils.utf8_encode` is still needed in practice.
       @type = Utils.utf8_encode(type)
       @message = Utils.utf8_encode(message)
       @backtrace = Utils.utf8_encode(backtrace)

data/lib/ddtrace/ext/ci.rb

@@ -5,6 +5,8 @@ module Datadog
     # Defines constants for CI tags
     # rubocop:disable Metrics/ModuleLength:
     module CI
+      TAG_STAGE_NAME = 'ci.stage.name'.freeze
+      TAG_JOB_NAME = 'ci.job.name'.freeze
       TAG_JOB_URL = 'ci.job.url'.freeze
       TAG_PIPELINE_ID = 'ci.pipeline.id'.freeze
       TAG_PIPELINE_NAME = 'ci.pipeline.name'.freeze
@@ -23,7 +25,8 @@ module Datadog
         ['GITLAB_CI'.freeze, :extract_gitlab],
         ['JENKINS_URL'.freeze, :extract_jenkins],
         ['TEAMCITY_VERSION'.freeze, :extract_teamcity],
-        ['TRAVIS'.freeze, :extract_travis]
+        ['TRAVIS'.freeze, :extract_travis],
+        ['BITRISE_BUILD_SLUG'.freeze, :extract_bitrise]
       ].freeze
 
       module_function
@@ -37,7 +40,6 @@ module Datadog
         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 ~
@@ -63,26 +65,34 @@ module Datadog
 
       def extract_appveyor(env)
         url = "https://ci.appveyor.com/project/#{env['APPVEYOR_REPO_NAME']}/builds/#{env['APPVEYOR_BUILD_ID']}"
+
+        if env['APPVEYOR_REPO_PROVIDER'] == 'github'
+          repository = "https://github.com/#{env['APPVEYOR_REPO_NAME']}.git"
+          commit = env['APPVEYOR_REPO_COMMIT']
+          branch = (env['APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH'] || env['APPVEYOR_REPO_BRANCH'])
+          tag = env['APPVEYOR_REPO_TAG_NAME']
+        end
+
         {
           TAG_PROVIDER_NAME => 'appveyor',
-          Git::TAG_REPOSITORY_URL =>  "https://github.com/#{env['APPVEYOR_REPO_NAME']}.git",
-          Git::TAG_COMMIT_SHA => env['APPVEYOR_REPO_COMMIT'],
+          Git::TAG_REPOSITORY_URL => repository,
+          Git::TAG_COMMIT_SHA => 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']
+          Git::TAG_BRANCH => branch,
+          Git::TAG_TAG => tag
         }
       end
 
       def extract_azure_pipelines(env)
-        if env['SYSTEM_TEAMFOUNDATIONSERVERURI'] && env['SYSTEM_TEAMPROJECT'] && env['BUILD_BUILDID']
-          base_url = "#{env['SYSTEM_TEAMFOUNDATIONSERVERURI']}#{env['SYSTEM_TEAMPROJECT']}" \
+        if env['SYSTEM_TEAMFOUNDATIONSERVERURI'] && env['SYSTEM_TEAMPROJECTID'] && env['BUILD_BUILDID']
+          base_url = "#{env['SYSTEM_TEAMFOUNDATIONSERVERURI']}#{env['SYSTEM_TEAMPROJECTID']}" \
             "/_build/results?buildId=#{env['BUILD_BUILDID']}"
-          pipeline_url = base_url + '&_a=summary'
+          pipeline_url = base_url
           job_url = base_url + "&view=logs&j=#{env['SYSTEM_JOBID']}&t=#{env['SYSTEM_TASKINSTANCEID']}"
         else
           pipeline_url = job_url = nil
@@ -194,6 +204,8 @@ module Datadog
           Git::TAG_COMMIT_SHA => env['CI_COMMIT_SHA'],
           Git::TAG_REPOSITORY_URL => env['CI_REPOSITORY_URL'],
           Git::TAG_TAG => env['CI_COMMIT_TAG'],
+          TAG_STAGE_NAME => env['CI_JOB_STAGE'],
+          TAG_JOB_NAME => env['CI_JOB_NAME'],
           TAG_JOB_URL => env['CI_JOB_URL'],
           TAG_PIPELINE_ID => env['CI_PIPELINE_ID'],
           TAG_PIPELINE_NAME => env['CI_PROJECT_PATH'],
@@ -248,7 +260,7 @@ module Datadog
         {
           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_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'],
@@ -259,6 +271,27 @@ module Datadog
           TAG_WORKSPACE_PATH => env['TRAVIS_BUILD_DIR']
         }
       end
+
+      def extract_bitrise(env)
+        commit = (
+          env['BITRISE_GIT_COMMIT'] || env['GIT_CLONE_COMMIT_HASH']
+        )
+        branch = (
+          env['BITRISEIO_GIT_BRANCH_DEST'] || env['BITRISE_GIT_BRANCH']
+        )
+        {
+          TAG_PROVIDER_NAME => 'bitrise',
+          TAG_PIPELINE_ID => env['BITRISE_BUILD_SLUG'],
+          TAG_PIPELINE_NAME => env['BITRISE_APP_TITLE'],
+          TAG_PIPELINE_NUMBER => env['BITRISE_BUILD_NUMBER'],
+          TAG_PIPELINE_URL => env['BITRISE_BUILD_URL'],
+          TAG_WORKSPACE_PATH => env['BITRISE_SOURCE_DIR'],
+          Git::TAG_REPOSITORY_URL => env['GIT_REPOSITORY_URL'],
+          Git::TAG_COMMIT_SHA => commit,
+          Git::TAG_BRANCH => branch,
+          Git::TAG_TAG => env['BITRISE_GIT_TAG']
+        }
+      end
     end
   end
 end

data/lib/ddtrace/ext/distributed.rb

@@ -22,7 +22,7 @@ module Datadog
       PROPAGATION_STYLE_B3_SINGLE_HEADER = 'B3 single header'.freeze
       PROPAGATION_STYLE_INJECT_ENV = 'DD_PROPAGATION_STYLE_INJECT'.freeze
       PROPAGATION_STYLE_EXTRACT_ENV = 'DD_PROPAGATION_STYLE_EXTRACT'.freeze
-      # Note: the below inject/extract values are deprecated and were defined erronously
+      # NOTE: the below inject/extract values are deprecated and were defined erronously
       # they were never part of the datadog language client standard or documentation
       # some users may already be relying on them, but we should look to remove these in the future
       # or before 1.0.

data/lib/ddtrace/ext/git.rb

@@ -4,7 +4,6 @@ module Datadog
     module Git
       TAG_BRANCH = 'git.branch'.freeze
       TAG_COMMIT_SHA = 'git.commit.sha'.freeze
-      TAG_DEPRECATED_COMMIT_SHA = 'git.commit_sha'.freeze
       TAG_REPOSITORY_URL = 'git.repository_url'.freeze
       TAG_TAG = 'git.tag'.freeze
     end

data/lib/ddtrace/ext/http.rb

@@ -2,7 +2,7 @@ module Datadog
   module Ext
     module HTTP
       BASE_URL = 'http.base_url'.freeze
-      ERROR_RANGE = 500...600
+      ERROR_RANGE = (500...600).freeze
       METHOD = 'http.method'.freeze
       STATUS_CODE = 'http.status_code'.freeze
       TEMPLATE = 'template'.freeze