datadog-ci 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0975da7283a037f3ea9c70954f2868cf387a0e86608882d2ebefdd097e0cf7
-  data.tar.gz: 7842e2e30802411616d987bcbae9be620befa27ba90206a733646a469225f835
+  metadata.gz: 57da167788887f67dc501a3dc2869c425754fec3cdefa45770af22364003fb20
+  data.tar.gz: ed6645a822db10fbae793c5b226b9d41ca4dbea67449f545135f2571be3894c1
 SHA512:
-  metadata.gz: 89bce02785793b2c1f5b5438f6c9cfbf63d3ff4cb065788b4884063341bdc23c289e29715f846ce24e5a4ab939c9cdeb05e755a216e92cee6f20b9954462b05f
-  data.tar.gz: 6adac19cff9d74fc081d22654a8b0db93152c8c5b6706fee82263e6f219edd96bb473f9595c85418a904110bfcde430b7ddcabd034279cb45d24374a55c5b170
+  metadata.gz: f4586bbf8a10b5bf2b262bafefd222ef981624ced261755bd9d43652506400f6b939e5cd3595b7af0c66a193581328937aabe5b9246efd4cb3a0fa088b9e0ccf
+  data.tar.gz: 4169cf67306d9d080e264897ed2cffb5103a9b98ca176fea2784ff3293d4b9dd3decd62df3848b2a7ade783f5dfe6925b86fa7d4727b45de51764af5bc6e1b4a

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [1.3.0] - 2024-07-30
+
+### Added
+
+* Add test_session metric ([#207][])
+* API metrics ([#206][])
+* git commands telemetry ([#205][])
+* implement ITR metrics for internal telemetry ([#204][])
+* Implement code coverage metrics for internal telemetry ([#203][])
+* Implement manual_api_events metric ([#202][])
+* HTTP transport metrics and minor telemetry tweaks ([#201][])
+* Send event_created and event_finished metrics for internal telemetry ([#200][])
+
 ## [1.2.0] - 2024-07-16
 
 ### Changed
@@ -277,7 +290,8 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 
 - Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.2.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.3.0...main
+[1.3.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0...v1.0.1
@@ -391,4 +405,12 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#189]: https://github.com/DataDog/datadog-ci-rb/issues/189
 [#190]: https://github.com/DataDog/datadog-ci-rb/issues/190
 [#193]: https://github.com/DataDog/datadog-ci-rb/issues/193
-[#197]: https://github.com/DataDog/datadog-ci-rb/issues/197
+[#197]: https://github.com/DataDog/datadog-ci-rb/issues/197
+[#200]: https://github.com/DataDog/datadog-ci-rb/issues/200
+[#201]: https://github.com/DataDog/datadog-ci-rb/issues/201
+[#202]: https://github.com/DataDog/datadog-ci-rb/issues/202
+[#203]: https://github.com/DataDog/datadog-ci-rb/issues/203
+[#204]: https://github.com/DataDog/datadog-ci-rb/issues/204
+[#205]: https://github.com/DataDog/datadog-ci-rb/issues/205
+[#206]: https://github.com/DataDog/datadog-ci-rb/issues/206
+[#207]: https://github.com/DataDog/datadog-ci-rb/issues/207

data/lib/datadog/ci/configuration/components.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "datadog/core/telemetry/ext"
+
 require_relative "../ext/settings"
 require_relative "../git/tree_uploader"
 require_relative "../test_optimisation/component"
@@ -11,8 +13,11 @@ require_relative "../test_visibility/null_component"
 require_relative "../test_visibility/serializers/factories/test_level"
 require_relative "../test_visibility/serializers/factories/test_suite_level"
 require_relative "../test_visibility/transport"
+require_relative "../transport/adapters/telemetry_webmock_safe_adapter"
 require_relative "../transport/api/builder"
 require_relative "../transport/remote_settings_api"
+require_relative "../utils/identity"
+require_relative "../utils/parsing"
 require_relative "../utils/test_run"
 require_relative "../worker"
 
@@ -59,9 +64,7 @@ module Datadog
           return unless settings.ci.enabled
 
           # Configure datadog gem for test visibility mode
-
-          # Deactivate telemetry
-          settings.telemetry.enabled = false
+          configure_telemetry(settings)
 
           # Test visibility uses its own remote settings
           settings.remote.enabled = false
@@ -246,6 +249,30 @@ module Datadog
           end
         end
 
+        def configure_telemetry(settings)
+          # in development environment Datadog's telemetry is disabled by default
+          # for test visibility we want to enable it by default unless explicitly disabled
+          # NOTE: before agentless mode is released, we only enable telemetry when running with Datadog Agent
+          env_telemetry_enabled = ENV[Core::Telemetry::Ext::ENV_ENABLED]
+          settings.telemetry.enabled = !settings.ci.agentless_mode_enabled &&
+            (env_telemetry_enabled.nil? || Utils::Parsing.convert_to_bool(env_telemetry_enabled))
+
+          return unless settings.telemetry.enabled
+
+          begin
+            require "datadog/core/environment/identity"
+            require "datadog/core/telemetry/http/adapters/net"
+
+            # patch gem's identity to report datadog-ci library version instead of datadog gem version
+            Core::Environment::Identity.include(CI::Utils::Identity)
+
+            # patch gem's telemetry transport layer to use Net::HTTP instead of WebMock's Net::HTTP
+            Core::Telemetry::Http::Adapters::Net.include(CI::Transport::Adapters::TelemetryWebmockSafeAdapter)
+          rescue => e
+            Datadog.logger.warn("Failed to patch Datadog gem's telemetry layer: #{e}")
+          end
+        end
+
         def timecop?
           Gem.loaded_specs.key?("timecop") || !!defined?(Timecop)
         end

data/lib/datadog/ci/contrib/cucumber/formatter.rb

@@ -35,14 +35,14 @@ module Datadog
           end
 
           def on_test_run_started(event)
-            CI.start_test_session(
+            test_visibility_component.start_test_session(
               tags: {
                 CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                 CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Cucumber::Integration.version.to_s
               },
               service: configuration[:service_name]
             )
-            CI.start_test_module(Ext::FRAMEWORK)
+            test_visibility_component.start_test_module(Ext::FRAMEWORK)
           end
 
           def on_test_run_finished(event)
@@ -70,7 +70,7 @@ module Datadog
 
             start_test_suite(test_suite_name) unless same_test_suite_as_current?(test_suite_name)
 
-            test_span = CI.start_test(
+            test_span = test_visibility_component.trace_test(
               event.test_case.name,
               test_suite_name,
               tags: tags,
@@ -82,7 +82,7 @@ module Datadog
           end
 
           def on_test_case_finished(event)
-            test_span = CI.active_test
+            test_span = test_visibility_component.active_test
             return if test_span.nil?
 
             finish_span(test_span, event.result)
@@ -90,11 +90,11 @@ module Datadog
           end
 
           def on_test_step_started(event)
-            CI.trace(event.test_step.to_s, type: Ext::STEP_SPAN_TYPE)
+            test_visibility_component.trace(event.test_step.to_s, type: Ext::STEP_SPAN_TYPE)
           end
 
           def on_test_step_finished(event)
-            current_step_span = CI.active_span
+            current_step_span = test_visibility_component.active_span
             return if current_step_span.nil?
 
             finish_span(current_step_span, event.result)
@@ -130,8 +130,8 @@ module Datadog
           def finish_session(result)
             finish_current_test_suite
 
-            test_session = CI.active_test_session
-            test_module = CI.active_test_module
+            test_session = test_visibility_component.active_test_session
+            test_module = test_visibility_component.active_test_module
 
             return unless test_session && test_module
 
@@ -150,7 +150,7 @@ module Datadog
           def start_test_suite(test_suite_name)
             finish_current_test_suite
 
-            @current_test_suite = CI.start_test_suite(test_suite_name)
+            @current_test_suite = test_visibility_component.start_test_suite(test_suite_name)
           end
 
           def finish_current_test_suite
@@ -197,6 +197,10 @@ module Datadog
           def configuration
             Datadog.configuration.ci[:cucumber]
           end
+
+          def test_visibility_component
+            Datadog.send(:components).test_visibility
+          end
         end
       end
     end

data/lib/datadog/ci/contrib/minitest/runnable.rb

@@ -19,7 +19,7 @@ module Datadog
 
               test_suite_name = Helpers.test_suite_name(self, method)
 
-              test_suite = Datadog::CI.start_test_suite(test_suite_name)
+              test_suite = test_visibility_component.start_test_suite(test_suite_name)
 
               results = super
               return results unless test_suite
@@ -34,6 +34,10 @@ module Datadog
             def datadog_configuration
               Datadog.configuration.ci[:minitest]
             end
+
+            def test_visibility_component
+              Datadog.send(:components).test_visibility
+            end
           end
         end
       end

data/lib/datadog/ci/contrib/minitest/runner.rb

@@ -18,14 +18,14 @@ module Datadog
 
               return unless datadog_configuration[:enabled]
 
-              CI.start_test_session(
+              test_visibility_component.start_test_session(
                 tags: {
                   CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                   CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Minitest::Integration.version.to_s
                 },
                 service: datadog_configuration[:service_name]
               )
-              CI.start_test_module(Ext::FRAMEWORK)
+              test_visibility_component.start_test_module(Ext::FRAMEWORK)
             end
 
             private
@@ -33,6 +33,10 @@ module Datadog
             def datadog_configuration
               Datadog.configuration.ci[:minitest]
             end
+
+            def test_visibility_component
+              Datadog.send(:components).test_visibility
+            end
           end
         end
       end

data/lib/datadog/ci/contrib/minitest/test.rb

@@ -26,12 +26,12 @@ module Datadog
                 test_suite_name = "#{test_suite_name} (#{name} concurrently)"
 
                 # for parallel execution we need to start a new test suite for each test
-                CI.start_test_suite(test_suite_name)
+                test_visibility_component.start_test_suite(test_suite_name)
               end
 
               source_file, line_number = method(name).source_location
 
-              test_span = CI.start_test(
+              test_span = test_visibility_component.trace_test(
                 name,
                 test_suite_name,
                 tags: {
@@ -47,7 +47,7 @@ module Datadog
             end
 
             def after_teardown
-              test_span = CI.active_test
+              test_span = test_visibility_component.active_test
               return super unless test_span
 
               finish_with_result(test_span, result_code)
@@ -77,6 +77,10 @@ module Datadog
             def datadog_configuration
               Datadog.configuration.ci[:minitest]
             end
+
+            def test_visibility_component
+              Datadog.send(:components).test_visibility
+            end
           end
 
           module ClassMethods

data/lib/datadog/ci/contrib/rspec/example.rb

@@ -34,10 +34,10 @@ module Datadog
 
               if ci_queue?
                 suite_name = "#{suite_name} (ci-queue running example [#{test_name}])"
-                test_suite_span = CI.start_test_suite(suite_name)
+                test_suite_span = test_visibility_component.start_test_suite(suite_name)
               end
 
-              CI.trace_test(
+              test_visibility_component.trace_test(
                 test_name,
                 suite_name,
                 tags: {
@@ -99,6 +99,10 @@ module Datadog
               Datadog.configuration.ci[:rspec]
             end
 
+            def test_visibility_component
+              Datadog.send(:components).test_visibility
+            end
+
             def ci_queue?
               !!defined?(::RSpec::Queue::ExampleExtension) &&
                 self.class.ancestors.include?(::RSpec::Queue::ExampleExtension)

data/lib/datadog/ci/contrib/rspec/example_group.rb

@@ -21,7 +21,7 @@ module Datadog
               return super unless top_level?
 
               suite_name = "#{description} at #{file_path}"
-              test_suite = Datadog::CI.start_test_suite(suite_name)
+              test_suite = test_visibility_component.start_test_suite(suite_name)
 
               success = super
               return success unless test_suite
@@ -44,6 +44,10 @@ module Datadog
             def datadog_configuration
               Datadog.configuration.ci[:rspec]
             end
+
+            def test_visibility_component
+              Datadog.send(:components).test_visibility
+            end
           end
         end
       end

data/lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb

@@ -18,7 +18,7 @@ module Datadog
                 return super if ::RSpec.configuration.dry_run?
                 return super unless datadog_configuration[:enabled]
 
-                test_session = CI.start_test_session(
+                test_session = test_visibility_component.start_test_session(
                   tags: {
                     CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                     CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s
@@ -26,7 +26,7 @@ module Datadog
                   service: datadog_configuration[:service_name]
                 )
 
-                test_module = CI.start_test_module(Ext::FRAMEWORK)
+                test_module = test_visibility_component.start_test_module(Ext::FRAMEWORK)
 
                 result = super
                 return result unless test_module && test_session
@@ -49,6 +49,10 @@ module Datadog
               def datadog_configuration
                 Datadog.configuration.ci[:rspec]
               end
+
+              def test_visibility_component
+                Datadog.send(:components).test_visibility
+              end
             end
           end
         end

data/lib/datadog/ci/contrib/rspec/runner.rb

@@ -18,7 +18,7 @@ module Datadog
               return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
 
-              test_session = CI.start_test_session(
+              test_session = test_visibility_component.start_test_session(
                 tags: {
                   CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                   CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s
@@ -26,7 +26,7 @@ module Datadog
                 service: datadog_configuration[:service_name]
               )
 
-              test_module = CI.start_test_module(Ext::FRAMEWORK)
+              test_module = test_visibility_component.start_test_module(Ext::FRAMEWORK)
 
               result = super
               return result unless test_module && test_session
@@ -49,6 +49,10 @@ module Datadog
             def datadog_configuration
               Datadog.configuration.ci[:rspec]
             end
+
+            def test_visibility_component
+              Datadog.send(:components).test_visibility
+            end
           end
         end
       end

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

@@ -15,7 +15,7 @@ module Datadog
             end
 
             def provider_name
-              "appveyor"
+              Provider::APPVEYOR
             end
 
             def pipeline_url

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

@@ -17,7 +17,7 @@ module Datadog
             end
 
             def provider_name
-              "awscodepipeline"
+              Provider::AWS
             end
 
             def pipeline_id

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

@@ -17,7 +17,7 @@ module Datadog
             end
 
             def provider_name
-              "azurepipelines"
+              Provider::AZURE
             end
 
             def pipeline_url

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

@@ -16,7 +16,7 @@ module Datadog
 
             # overridden methods
             def provider_name
-              "bitbucket"
+              Provider::BITBUCKET
             end
 
             def pipeline_id

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

@@ -15,7 +15,7 @@ module Datadog
             end
 
             def provider_name
-              "bitrise"
+              Provider::BITRISE
             end
 
             def pipeline_id

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

@@ -15,7 +15,7 @@ module Datadog
             end
 
             def provider_name
-              "buddy"
+              Provider::BUDDYCI
             end
 
             def pipeline_id

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

@@ -17,7 +17,7 @@ module Datadog
             end
 
             def provider_name
-              "buildkite"
+              Provider::BUILDKITE
             end
 
             def job_url

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