ddtrace 0.42.0 → 0.47.0

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?
+
           @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/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,297 @@
+require 'ddtrace/ext/git'
+
+module Datadog
+  module Ext
+    # 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
+      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],
+        ['BITRISE_BUILD_SLUG'.freeze, :extract_bitrise]
+      ].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_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']}"
+
+        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 => 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 => branch,
+          Git::TAG_TAG => tag
+        }
+      end
+
+      def extract_azure_pipelines(env)
+        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
+          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_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'],
+          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_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
+
+      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

@@ -20,8 +20,14 @@ module Datadog
       PROPAGATION_STYLE_DATADOG = 'Datadog'.freeze
       PROPAGATION_STYLE_B3 = 'B3'.freeze
       PROPAGATION_STYLE_B3_SINGLE_HEADER = 'B3 single header'.freeze
-      PROPAGATION_INJECT_STYLE_ENV = 'DD_PROPAGATION_INJECT_STYLE'.freeze
-      PROPAGATION_EXTRACT_STYLE_ENV = 'DD_PROPAGATION_EXTRACT_STYLE'.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
+      # 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.
+      PROPAGATION_INJECT_STYLE_ENV_OLD = 'DD_PROPAGATION_INJECT_STYLE'.freeze
+      PROPAGATION_EXTRACT_STYLE_ENV_OLD = 'DD_PROPAGATION_EXTRACT_STYLE'.freeze
 
       # gRPC metadata keys for distributed tracing. https://github.com/grpc/grpc-go/blob/v1.10.x/Documentation/grpc-metadata.md
       GRPC_METADATA_TRACE_ID = 'x-datadog-trace-id'.freeze

data/lib/ddtrace/ext/git.rb

@@ -0,0 +1,11 @@
+module Datadog
+  module Ext
+    # Defines constants for Git tags
+    module Git
+      TAG_BRANCH = 'git.branch'.freeze
+      TAG_COMMIT_SHA = 'git.commit.sha'.freeze
+      TAG_REPOSITORY_URL = 'git.repository_url'.freeze
+      TAG_TAG = 'git.tag'.freeze
+    end
+  end
+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

data/lib/ddtrace/ext/runtime.rb

@@ -5,11 +5,14 @@ module Datadog
     module Runtime
       # Identity
       LANG = 'ruby'.freeze
-      LANG_INTERPRETER = (RUBY_ENGINE + '-' + RUBY_PLATFORM).freeze
+      LANG_ENGINE = RUBY_ENGINE
+      LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
+      LANG_PLATFORM = RUBY_PLATFORM
       LANG_VERSION = RUBY_VERSION
       RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
       TRACER_VERSION = Datadog::VERSION::STRING
 
+      TAG_ID = 'runtime-id'.freeze
       TAG_LANG = 'language'.freeze
 
       # Metrics

data/lib/ddtrace/ext/test.rb

@@ -0,0 +1,24 @@
+module Datadog
+  module Ext
+    # Defines constants for test tags
+    module Test
+      TAG_ARGUMENTS = 'test.arguments'.freeze
+      TAG_FRAMEWORK = 'test.framework'.freeze
+      TAG_NAME = 'test.name'.freeze
+      TAG_SKIP_REASON = 'test.skip_reason'.freeze
+      TAG_STATUS = 'test.status'.freeze
+      TAG_SUITE = 'test.suite'.freeze
+      TAG_TRAITS = 'test.traits'.freeze
+      TAG_TYPE = 'test.type'.freeze
+
+      # TODO: is there a better place for SPAN_KIND?
+      TAG_SPAN_KIND = 'span.kind'.freeze
+
+      module Status
+        PASS = 'pass'.freeze
+        FAIL = 'fail'.freeze
+        SKIP = 'skip'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/forced_tracing.rb

@@ -7,11 +7,13 @@ module Datadog
     class << self
       def keep(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_KEEP
       end
 
       def drop(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_REJECT
       end
     end