datadog-ci 1.1.0 → 1.3.0

data/lib/datadog/ci/ext/environment/providers/circleci.rb

@@ -17,7 +17,7 @@ module Datadog
             end
 
             def provider_name
-              "circleci"
+              Provider::CIRCLECI
             end
 
             def job_url

data/lib/datadog/ci/ext/environment/providers/codefresh.rb

@@ -17,7 +17,7 @@ module Datadog
             end
 
             def provider_name
-              "codefresh"
+              Provider::CODEFRESH
             end
 
             def job_name

data/lib/datadog/ci/ext/environment/providers/github_actions.rb

@@ -19,7 +19,7 @@ module Datadog
             end
 
             def provider_name
-              "github"
+              Provider::GITHUB
             end
 
             def job_name

data/lib/datadog/ci/ext/environment/providers/gitlab.rb

@@ -15,7 +15,7 @@ module Datadog
             end
 
             def provider_name
-              "gitlab"
+              Provider::GITLAB
             end
 
             def job_name

data/lib/datadog/ci/ext/environment/providers/jenkins.rb

@@ -18,7 +18,7 @@ module Datadog
             end
 
             def provider_name
-              "jenkins"
+              Provider::JENKINS
             end
 
             def pipeline_id

data/lib/datadog/ci/ext/environment/providers/teamcity.rb

@@ -15,7 +15,7 @@ module Datadog
             end
 
             def provider_name
-              "teamcity"
+              Provider::TEAMCITY
             end
 
             def job_name

data/lib/datadog/ci/ext/environment/providers/travis.rb

@@ -15,7 +15,7 @@ module Datadog
             end
 
             def provider_name
-              "travisci"
+              Provider::TRAVISCI
             end
 
             def job_url

data/lib/datadog/ci/ext/environment.rb

@@ -23,6 +23,23 @@ module Datadog
         TAG_NODE_NAME = "ci.node.name"
         TAG_CI_ENV_VARS = "_dd.ci.env_vars"
 
+        module Provider
+          APPVEYOR = "appveyor"
+          AZURE = "azurepipelines"
+          AWS = "awscodepipeline"
+          BITBUCKET = "bitbucket"
+          BITRISE = "bitrise"
+          BUDDYCI = "buddy"
+          BUILDKITE = "buildkite"
+          CIRCLECI = "circleci"
+          CODEFRESH = "codefresh"
+          GITHUB = "github"
+          GITLAB = "gitlab"
+          JENKINS = "jenkins"
+          TEAMCITY = "teamcity"
+          TRAVISCI = "travisci"
+        end
+
         POSSIBLE_BUNDLE_LOCATIONS = %w[vendor/bundle .bundle].freeze
 
         module_function

data/lib/datadog/ci/ext/settings.rb

@@ -14,6 +14,7 @@ module Datadog
         ENV_GIT_METADATA_UPLOAD_ENABLED = "DD_CIVISIBILITY_GIT_METADATA_UPLOAD_ENABLED"
         ENV_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH = "DD_CIVISIBILITY_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH"
         ENV_ITR_CODE_COVERAGE_USE_SINGLE_THREADED_MODE = "DD_CIVISIBILITY_ITR_CODE_COVERAGE_USE_SINGLE_THREADED_MODE"
+        ENV_ITR_TEST_IMPACT_ANALYSIS_USE_ALLOCATION_TRACING = "DD_CIVISIBILITY_ITR_TEST_IMPACT_ANALYSIS_USE_ALLOCATION_TRACING"
 
         # Source: https://docs.datadoghq.com/getting_started/site/
         DD_SITE_ALLOWLIST = %w[

data/lib/datadog/ci/ext/telemetry.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Ext
+      module Telemetry
+        NAMESPACE = "civisibility"
+
+        METRIC_EVENT_CREATED = "event_created"
+        METRIC_EVENT_FINISHED = "event_finished"
+
+        METRIC_MANUAL_API_EVENTS = "manual_api_events"
+
+        METRIC_EVENTS_ENQUEUED = "events_enqueued_for_serialization"
+        METRIC_ENDPOINT_PAYLOAD_REQUESTS = "endpoint_payload.requests"
+        METRIC_ENDPOINT_PAYLOAD_REQUESTS_MS = "endpoint_payload.requests_ms"
+        METRIC_ENDPOINT_PAYLOAD_REQUESTS_ERRORS = "endpoint_payload.requests_errors"
+        METRIC_ENDPOINT_PAYLOAD_BYTES = "endpoint_payload.bytes"
+        METRIC_ENDPOINT_PAYLOAD_EVENTS_COUNT = "endpoint_payload.events_count"
+        METRIC_ENDPOINT_PAYLOAD_EVENTS_SERIALIZATION_MS = "endpoint_payload.events_serialization_ms"
+        METRIC_ENDPOINT_PAYLOAD_DROPPED = "endpoint_payload.dropped"
+
+        METRIC_GIT_COMMAND = "git.command"
+        METRIC_GIT_COMMAND_ERRORS = "git.command_errors"
+        METRIC_GIT_COMMAND_MS = "git.command_ms"
+
+        METRIC_GIT_REQUESTS_SEARCH_COMMITS = "git_requests.search_commits"
+        METRIC_GIT_REQUESTS_SEARCH_COMMITS_MS = "git_requests.search_commits_ms"
+        METRIC_GIT_REQUESTS_SEARCH_COMMITS_ERRORS = "git_requests.search_commits_errors"
+
+        METRIC_GIT_REQUESTS_OBJECT_PACK = "git_requests.objects_pack"
+        METRIC_GIT_REQUESTS_OBJECT_PACK_MS = "git_requests.objects_pack_ms"
+        METRIC_GIT_REQUESTS_OBJECT_PACK_ERRORS = "git_requests.objects_pack_errors"
+        METRIC_GIT_REQUESTS_OBJECT_PACK_BYTES = "git_requests.objects_pack_bytes"
+        METRIC_GIT_REQUESTS_OBJECT_PACK_FILES = "git_requests.objects_pack_files"
+
+        METRIC_GIT_REQUESTS_SETTINGS = "git_requests.settings"
+        METRIC_GIT_REQUESTS_SETTINGS_MS = "git_requests.settings_ms"
+        METRIC_GIT_REQUESTS_SETTINGS_ERRORS = "git_requests.settings_errors"
+        METRIC_GIT_REQUESTS_SETTINGS_RESPONSE = "git_requests.settings_response"
+
+        METRIC_ITR_SKIPPABLE_TESTS_REQUEST = "itr_skippable_tests.request"
+        METRIC_ITR_SKIPPABLE_TESTS_REQUEST_MS = "itr_skippable_tests.request_ms"
+        METRIC_ITR_SKIPPABLE_TESTS_REQUEST_ERRORS = "itr_skippable_tests.request_errors"
+        METRIC_ITR_SKIPPABLE_TESTS_RESPONSE_BYTES = "itr_skippable_tests.response_bytes"
+        METRIC_ITR_SKIPPABLE_TESTS_RESPONSE_TESTS = "itr_skippable_tests.response_tests"
+
+        METRIC_ITR_SKIPPED = "itr_skipped"
+        METRIC_ITR_UNSKIPPABLE = "itr_unskippable"
+        METRIC_ITR_FORCED_RUN = "itr_forced_run"
+
+        METRIC_CODE_COVERAGE_STARTED = "code_coverage_started"
+        METRIC_CODE_COVERAGE_FINISHED = "code_coverage_finished"
+        METRIC_CODE_COVERAGE_IS_EMPTY = "code_coverage.is_empty"
+        METRIC_CODE_COVERAGE_FILES = "code_coverage.files"
+
+        METRIC_TEST_SESSION = "test_session"
+
+        TAG_TEST_FRAMEWORK = "test_framework"
+        TAG_EVENT_TYPE = "event_type"
+        TAG_HAS_CODEOWNER = "has_codeowner"
+        TAG_IS_UNSUPPORTED_CI = "is_unsupported_ci"
+        TAG_BROWSER_DRIVER = "browser_driver"
+        TAG_IS_RUM = "is_rum"
+        TAG_LIBRARY = "library"
+        TAG_ENDPOINT = "endpoint"
+        TAG_ERROR_TYPE = "error_type"
+        TAG_EXIT_CODE = "exit_code"
+        TAG_STATUS_CODE = "status_code"
+        TAG_REQUEST_COMPRESSED = "rq_compressed"
+        TAG_RESPONSE_COMPRESSED = "rs_compressed"
+        TAG_COMMAND = "command"
+        TAG_COVERAGE_ENABLED = "coverage_enabled"
+        TAG_ITR_SKIP_ENABLED = "itrskip_enabled"
+        TAG_PROVIDER = "provider"
+        TAG_AUTO_INJECTED = "auto_injected"
+
+        module EventType
+          TEST = "test"
+          SUITE = "suite"
+          MODULE = "module"
+          SESSION = "session"
+        end
+
+        module Library
+          CUSTOM = "custom"
+        end
+
+        module Endpoint
+          CODE_COVERAGE = "code_coverage"
+          TEST_CYCLE = "test_cycle"
+        end
+
+        module ErrorType
+          NETWORK = "network"
+          TIMEOUT = "timeout"
+          STATUS_CODE = "status_code"
+        end
+
+        module ExitCode
+          MISSING = "missing"
+        end
+
+        module Command
+          GET_REPOSITORY = "get_repository"
+          GET_BRANCH = "get_branch"
+          CHECK_SHALLOW = "check_shallow"
+          UNSHALLOW = "unshallow"
+          GET_LOCAL_COMMITS = "get_local_commits"
+          GET_OBJECTS = "get_objects"
+          PACK_OBJECTS = "pack_objects"
+        end
+
+        module Provider
+          UNSUPPORTED = "unsupported"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/git/local_repository.rb

@@ -3,12 +3,25 @@
 require "open3"
 require "pathname"
 
+require_relative "../ext/telemetry"
+require_relative "telemetry"
 require_relative "user"
 
 module Datadog
   module CI
     module Git
       module LocalRepository
+        class GitCommandExecutionError < StandardError
+          attr_reader :output, :command, :status
+          def initialize(message, output:, command:, status:)
+            super(message)
+
+            @output = output
+            @command = command
+            @status = status
+          end
+        end
+
         COMMAND_RETRY_COUNT = 3
 
         def self.root
@@ -48,9 +61,18 @@ module Datadog
         end
 
         def self.git_repository_url
-          exec_git_command("git ls-remote --get-url")
+          Telemetry.git_command(Ext::Telemetry::Command::GET_REPOSITORY)
+          res = nil
+
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            res = exec_git_command("git ls-remote --get-url")
+          end
+
+          Telemetry.git_command_ms(Ext::Telemetry::Command::GET_REPOSITORY, duration_ms)
+          res
         rescue => e
           log_failure(e, "git repository url")
+          telemetry_track_error(e, Ext::Telemetry::Command::GET_REPOSITORY)
           nil
         end
 
@@ -69,9 +91,18 @@ module Datadog
         end
 
         def self.git_branch
-          exec_git_command("git rev-parse --abbrev-ref HEAD")
+          Telemetry.git_command(Ext::Telemetry::Command::GET_BRANCH)
+          res = nil
+
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            res = exec_git_command("git rev-parse --abbrev-ref HEAD")
+          end
+
+          Telemetry.git_command_ms(Ext::Telemetry::Command::GET_BRANCH, duration_ms)
+          res
         rescue => e
           log_failure(e, "git branch")
+          telemetry_track_error(e, Ext::Telemetry::Command::GET_BRANCH)
           nil
         end
 
@@ -116,29 +147,49 @@ module Datadog
 
         # returns maximum of 1000 latest commits in the last month
         def self.git_commits
-          output = exec_git_command("git log --format=%H -n 1000 --since=\"1 month ago\"")
+          Telemetry.git_command(Ext::Telemetry::Command::GET_LOCAL_COMMITS)
+
+          output = nil
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            output = exec_git_command("git log --format=%H -n 1000 --since=\"1 month ago\"")
+          end
+
+          Telemetry.git_command_ms(Ext::Telemetry::Command::GET_LOCAL_COMMITS, duration_ms)
+
           return [] if output.nil?
 
+          # @type var output: String
           output.split("\n")
         rescue => e
           log_failure(e, "git commits")
+          telemetry_track_error(e, Ext::Telemetry::Command::GET_LOCAL_COMMITS)
           []
         end
 
         def self.git_commits_rev_list(included_commits:, excluded_commits:)
+          Telemetry.git_command(Ext::Telemetry::Command::GET_OBJECTS)
           included_commits = filter_invalid_commits(included_commits).join(" ")
           excluded_commits = filter_invalid_commits(excluded_commits).map! { |sha| "^#{sha}" }.join(" ")
 
-          exec_git_command(
-            "git rev-list " \
-            "--objects " \
-            "--no-object-names " \
-            "--filter=blob:none " \
-            "--since=\"1 month ago\" " \
-            "#{excluded_commits} #{included_commits}"
-          )
+          res = nil
+
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            res = exec_git_command(
+              "git rev-list " \
+              "--objects " \
+              "--no-object-names " \
+              "--filter=blob:none " \
+              "--since=\"1 month ago\" " \
+              "#{excluded_commits} #{included_commits}"
+            )
+          end
+
+          Telemetry.git_command_ms(Ext::Telemetry::Command::GET_OBJECTS, duration_ms)
+
+          res
         rescue => e
           log_failure(e, "git commits rev list")
+          telemetry_track_error(e, Ext::Telemetry::Command::GET_OBJECTS)
           nil
         end
 
@@ -150,35 +201,59 @@ module Datadog
 
           basename = SecureRandom.hex(4)
 
-          exec_git_command(
-            "git pack-objects --compression=9 --max-pack-size=3m #{path}/#{basename}",
-            stdin: commit_tree
-          )
+          Telemetry.git_command(Ext::Telemetry::Command::PACK_OBJECTS)
+
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            exec_git_command(
+              "git pack-objects --compression=9 --max-pack-size=3m #{path}/#{basename}",
+              stdin: commit_tree
+            )
+          end
+          Telemetry.git_command_ms(Ext::Telemetry::Command::PACK_OBJECTS, duration_ms)
 
           basename
         rescue => e
           log_failure(e, "git generate packfiles")
+          telemetry_track_error(e, Ext::Telemetry::Command::PACK_OBJECTS)
           nil
         end
 
         def self.git_shallow_clone?
-          exec_git_command("git rev-parse --is-shallow-repository") == "true"
+          Telemetry.git_command(Ext::Telemetry::Command::CHECK_SHALLOW)
+          res = false
+
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            res = exec_git_command("git rev-parse --is-shallow-repository") == "true"
+          end
+          Telemetry.git_command_ms(Ext::Telemetry::Command::CHECK_SHALLOW, duration_ms)
+
+          res
         rescue => e
           log_failure(e, "git shallow clone")
+          telemetry_track_error(e, Ext::Telemetry::Command::CHECK_SHALLOW)
           false
         end
 
         def self.git_unshallow
-          exec_git_command(
-            "git fetch " \
-            "--shallow-since=\"1 month ago\" " \
-            "--update-shallow " \
-            "--filter=\"blob:none\" " \
-            "--recurse-submodules=no " \
-            "$(git config --default origin --get clone.defaultRemoteName) $(git rev-parse HEAD)"
-          )
+          Telemetry.git_command(Ext::Telemetry::Command::UNSHALLOW)
+          res = nil
+
+          duration_ms = Core::Utils::Time.measure(:float_millisecond) do
+            res = exec_git_command(
+              "git fetch " \
+              "--shallow-since=\"1 month ago\" " \
+              "--update-shallow " \
+              "--filter=\"blob:none\" " \
+              "--recurse-submodules=no " \
+              "$(git config --default origin --get clone.defaultRemoteName) $(git rev-parse HEAD)"
+            )
+          end
+          Telemetry.git_command_ms(Ext::Telemetry::Command::UNSHALLOW, duration_ms)
+
+          res
         rescue => e
           log_failure(e, "git unshallow")
+          telemetry_track_error(e, Ext::Telemetry::Command::UNSHALLOW)
           nil
         end
 
@@ -209,7 +284,12 @@ module Datadog
             end
 
             if status.nil? || !status.success?
-              raise "Failed to run git command [#{cmd}] with input [#{stdin}] and output [#{out}]"
+              raise GitCommandExecutionError.new(
+                "Failed to run git command [#{cmd}] with input [#{stdin}] and output [#{out}]",
+                output: out,
+                command: cmd,
+                status: status
+              )
             end
 
             # Sometimes Encoding.default_external is somehow set to US-ASCII which breaks
@@ -231,6 +311,17 @@ module Datadog
               "Unable to perform #{action}: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
             )
           end
+
+          def telemetry_track_error(e, command)
+            case e
+            when Errno::ENOENT
+              Telemetry.git_command_errors(command, executable_missing: true)
+            when GitCommandExecutionError
+              Telemetry.git_command_errors(command, exit_code: e.status&.to_i)
+            else
+              Telemetry.git_command_errors(command, exit_code: -9000)
+            end
+          end
         end
       end
     end

data/lib/datadog/ci/git/search_commits.rb

@@ -3,8 +3,11 @@
 require "json"
 require "set"
 
+require_relative "../ext/telemetry"
 require_relative "../ext/transport"
+require_relative "../transport/telemetry"
 require_relative "../utils/git"
+require_relative "../utils/telemetry"
 
 module Datadog
   module CI
@@ -25,7 +28,23 @@ module Datadog
             path: Ext::Transport::DD_API_GIT_SEARCH_COMMITS_PATH,
             payload: request_payload(repository_url, commits)
           )
-          raise ApiError, "Failed to search commits: #{http_response.inspect}" unless http_response.ok?
+
+          Transport::Telemetry.api_requests(
+            Ext::Telemetry::METRIC_GIT_REQUESTS_SEARCH_COMMITS,
+            1,
+            compressed: http_response.request_compressed
+          )
+          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_GIT_REQUESTS_SEARCH_COMMITS_MS, http_response.duration_ms)
+
+          unless http_response.ok?
+            Transport::Telemetry.api_requests_errors(
+              Ext::Telemetry::METRIC_GIT_REQUESTS_SEARCH_COMMITS_ERRORS,
+              1,
+              error_type: http_response.telemetry_error_type,
+              status_code: http_response.code
+            )
+            raise ApiError, "Failed to search commits: #{http_response.inspect}"
+          end
 
           response_payload = parse_json_response(http_response)
           extract_commits(response_payload)

data/lib/datadog/ci/git/telemetry.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Git
+      module Telemetry
+        def self.git_command(command)
+          Utils::Telemetry.inc(Ext::Telemetry::METRIC_GIT_COMMAND, 1, tags_for_command(command))
+        end
+
+        def self.git_command_errors(command, exit_code: nil, executable_missing: false)
+          tags = tags_for_command(command)
+
+          exit_code_tag_value = exit_code_for(exit_code: exit_code, executable_missing: executable_missing)
+          tags[Ext::Telemetry::TAG_EXIT_CODE] = exit_code_tag_value if exit_code_tag_value
+
+          Utils::Telemetry.inc(Ext::Telemetry::METRIC_GIT_COMMAND_ERRORS, 1, tags)
+        end
+
+        def self.git_command_ms(command, duration_ms)
+          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_GIT_COMMAND_MS, duration_ms, tags_for_command(command))
+        end
+
+        def self.tags_for_command(command)
+          {Ext::Telemetry::TAG_COMMAND => command}
+        end
+
+        def self.exit_code_for(exit_code: nil, executable_missing: false)
+          return Ext::Telemetry::ExitCode::MISSING if executable_missing
+          return exit_code.to_s if exit_code
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/git/tree_uploader.rb

@@ -8,6 +8,9 @@ require_relative "search_commits"
 require_relative "upload_packfile"
 require_relative "packfiles"
 
+require_relative "../ext/telemetry"
+require_relative "../utils/telemetry"
+
 module Datadog
   module CI
     module Git
@@ -63,12 +66,16 @@ module Datadog
             head_commit_sha: head_commit,
             repository_url: repository_url
           )
+          packfiles_count = 0
           Packfiles.generate(included_commits: new_commits, excluded_commits: known_commits) do |filepath|
+            packfiles_count += 1
             uploader.call(filepath: filepath)
           rescue UploadPackfile::ApiError => e
             Datadog.logger.debug("Packfile upload failed with #{e}")
             break
           end
+
+          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_GIT_REQUESTS_OBJECT_PACK_FILES, packfiles_count.to_f)
         ensure
           Datadog.logger.debug("Git tree upload finished")
         end

data/lib/datadog/ci/git/upload_packfile.rb

@@ -3,6 +3,11 @@
 require "json"
 require "securerandom"
 
+require_relative "../ext/transport"
+require_relative "../ext/telemetry"
+require_relative "../transport/telemetry"
+require_relative "../utils/telemetry"
+
 module Datadog
   module CI
     module Git
@@ -34,7 +39,23 @@ module Datadog
             headers: {Ext::Transport::HEADER_CONTENT_TYPE => content_type}
           )
 
-          raise ApiError, "Failed to upload packfile: #{http_response.inspect}" unless http_response.ok?
+          Transport::Telemetry.api_requests(
+            Ext::Telemetry::METRIC_GIT_REQUESTS_OBJECT_PACK,
+            1,
+            compressed: http_response.request_compressed
+          )
+          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_GIT_REQUESTS_OBJECT_PACK_MS, http_response.duration_ms)
+          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_GIT_REQUESTS_OBJECT_PACK_BYTES, http_response.request_size.to_f)
+
+          unless http_response.ok?
+            Transport::Telemetry.api_requests_errors(
+              Ext::Telemetry::METRIC_GIT_REQUESTS_OBJECT_PACK_ERRORS,
+              1,
+              error_type: http_response.telemetry_error_type,
+              status_code: http_response.code
+            )
+            raise ApiError, "Failed to upload packfile: #{http_response.inspect}"
+          end
         end
 
         private

data/lib/datadog/ci/span.rb

@@ -202,9 +202,9 @@ module Datadog
 
       private
 
-      # provides access to global CI recorder for CI models to deactivate themselves
-      def recorder
-        Datadog.send(:components).ci_recorder
+      # provides access to the test visibility component for CI models to deactivate themselves
+      def test_visibility
+        Datadog.send(:components).test_visibility
       end
     end
   end

data/lib/datadog/ci/test.rb

@@ -3,6 +3,7 @@
 require "json"
 
 require_relative "span"
+require_relative "test_optimisation/telemetry"
 require_relative "utils/test_run"
 
 module Datadog
@@ -19,7 +20,7 @@ module Datadog
       # Finishes the current test.
       # @return [void]
       def finish
-        recorder.deactivate_test
+        test_visibility.deactivate_test
 
         super
       end
@@ -80,9 +81,13 @@ module Datadog
       #
       # @return [void]
       def itr_unskippable!
+        TestOptimisation::Telemetry.itr_unskippable
         set_tag(Ext::Test::TAG_ITR_UNSKIPPABLE, "true")
+
         if skipped_by_itr?
           clear_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR)
+
+          TestOptimisation::Telemetry.itr_forced_run
           set_tag(Ext::Test::TAG_ITR_FORCED_RUN, "true")
         end
       end

data/lib/datadog/ci/test_module.rb

@@ -14,7 +14,7 @@ module Datadog
       # Finishes this test module.
       # @return [void]
       def finish
-        recorder.deactivate_test_module
+        test_visibility.deactivate_test_module
 
         super
       end