datadog-ci 1.14.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 694421f4e4621608a9aa6d8deb0b1407fa348fec68820a28ced1a567c56ed289
-  data.tar.gz: 12b586d1eabe233af428c7294564f8b7a46ff8bbb64d44f222762afd371a2c1c
+  metadata.gz: 4f7cf7ed07d7a4543498333996a19347f64010eef7900f53d5790ad6e4fe2aaf
+  data.tar.gz: 7b3ebdaaf30c557ac23f3720f72ef56ab1b9c1f9686e8f62dc597e3c938cfe35
 SHA512:
-  metadata.gz: 81c173cb2b22a8e0e3853d21d4e1ac023569142d51bb266c287ef7d4c7c5f2dfd97d2f3914acd1ac766d3e60ac15929cbee849b7284d300644113e6a14dea331
-  data.tar.gz: c1f1f93f35850cf9b6d1e360d53f2a26e2e46961aeed8e69f216327513e4001c45a42c363c20609ad0b525a4aeaf0fdec59e32f38d9302289c9e256ccf5aa81c
+  metadata.gz: 9412f518c4bba62d062448950f10b956abebe22e33680341454f60f67fd48c25b155d9e0ed3f7d378bcb33f21ee0fa586bee2ff03f3a2ad3f4b753a8a24bb36c
+  data.tar.gz: eb8710ab135550d9c26e1742aefb5ebb05b2c8a1f91e9175e44b0181c4934f1ff5453749820b8720e1febe5c79502e2489d46442f80c4836e56a394c931f7143

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 ## [Unreleased]
 
+## [1.16.0] - 2025-04-15
+
+
+### Added
+
+* agentless logs submission for tests ([#306][])
+* lograge support for agentless logs feature ([#308][])
+* semantic_logger instrumentation for agentless logs feature ([#311][])
+* retry reason "external" ([#312][])
+
+## [1.15.0] - 2025-03-25
+
+
+### Added
+
+* parallel tests gem support ([#299][])
+* implemented attempt to fix flow V2 ([#298][])
+
+### Fixed
+
+* Fix: prevent test impact analysis from skipping flaky tests that are attempted to be fixed ([#301][])
+* Fix git commit message extraction to extract multiline commit messages correctly ([#300][])
+
 ## [1.14.0] - 2025-03-11
 
 ### Added
@@ -404,7 +427,9 @@ 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.14.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.16.0...main
+[1.16.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.15.0...v1.16.0
+[1.15.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.14.0...v1.15.0
 [1.14.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.13.0...v1.14.0
 [1.13.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.12.0...v1.13.0
 [1.12.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.11.0...v1.12.0
@@ -579,4 +604,12 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#289]: https://github.com/DataDog/datadog-ci-rb/issues/289
 [#292]: https://github.com/DataDog/datadog-ci-rb/issues/292
 [#294]: https://github.com/DataDog/datadog-ci-rb/issues/294
-[#295]: https://github.com/DataDog/datadog-ci-rb/issues/295
+[#295]: https://github.com/DataDog/datadog-ci-rb/issues/295
+[#298]: https://github.com/DataDog/datadog-ci-rb/issues/298
+[#299]: https://github.com/DataDog/datadog-ci-rb/issues/299
+[#300]: https://github.com/DataDog/datadog-ci-rb/issues/300
+[#301]: https://github.com/DataDog/datadog-ci-rb/issues/301
+[#306]: https://github.com/DataDog/datadog-ci-rb/issues/306
+[#308]: https://github.com/DataDog/datadog-ci-rb/issues/308
+[#311]: https://github.com/DataDog/datadog-ci-rb/issues/311
+[#312]: https://github.com/DataDog/datadog-ci-rb/issues/312

data/lib/datadog/ci/async_writer.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "datadog/core/workers/async"
+require "datadog/core/workers/queue"
+require "datadog/core/workers/polling"
+
+require "datadog/core/buffer/cruby"
+require "datadog/core/buffer/thread_safe"
+
+require "datadog/core/environment/ext"
+
+module Datadog
+  module CI
+    class AsyncWriter
+      include Core::Workers::Queue
+      include Core::Workers::Polling
+
+      attr_reader :transport
+
+      DEFAULT_BUFFER_MAX_SIZE = 10_000
+      DEFAULT_SHUTDOWN_TIMEOUT = 60
+
+      DEFAULT_INTERVAL = 3
+
+      def initialize(transport:, options: {})
+        @transport = transport
+
+        # Workers::Polling settings
+        self.enabled = options.fetch(:enabled, true)
+
+        # Workers::Async::Thread settings
+        self.fork_policy = Core::Workers::Async::Thread::FORK_POLICY_RESTART
+
+        # Workers::IntervalLoop settings
+        self.loop_base_interval = options[:interval] || DEFAULT_INTERVAL
+        self.loop_back_off_ratio = options[:back_off_ratio] if options.key?(:back_off_ratio)
+        self.loop_back_off_max = options[:back_off_max] if options.key?(:back_off_max)
+
+        @buffer_size = options.fetch(:buffer_size, DEFAULT_BUFFER_MAX_SIZE)
+
+        self.buffer = buffer_klass.new(@buffer_size)
+
+        @shutdown_timeout = options.fetch(:shutdown_timeout, DEFAULT_SHUTDOWN_TIMEOUT)
+
+        @stopped = false
+      end
+
+      def write(event)
+        return if @stopped
+
+        # Start worker thread. If the process has forked, it will trigger #after_fork to
+        # reconfigure the worker accordingly.
+        perform
+
+        enqueue(event)
+      end
+
+      def perform(*events)
+        responses = transport.send_events(events)
+
+        if responses.find(&:server_error?)
+          loop_back_off!
+          Datadog.logger.warn { "Encountered server error while sending events: #{responses}" }
+        end
+
+        nil
+      rescue => e
+        Datadog.logger.warn { "Error while sending events: #{e}" }
+        loop_back_off!
+      end
+
+      def stop(force_stop = false, timeout = @shutdown_timeout)
+        @stopped = true
+
+        buffer.close if running?
+
+        super
+      end
+
+      def enqueue(event)
+        buffer.push(event)
+      end
+
+      def dequeue
+        buffer.pop
+      end
+
+      def work_pending?
+        !buffer.empty?
+      end
+
+      def async?
+        true
+      end
+
+      def after_fork
+        # In multiprocess environments, forks will share the same buffer until its written to.
+        # A.K.A. copy-on-write. We don't want forks to write events generated from another process.
+        # Instead, we reset it after the fork. (Make sure any enqueue operations happen after this.)
+        self.buffer = buffer_klass.new(@buffer_size)
+      end
+
+      def buffer_klass
+        if Core::Environment::Ext::RUBY_ENGINE == "ruby"
+          Core::Buffer::CRuby
+        else
+          Core::Buffer::ThreadSafe
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,8 @@ require "datadog/core/telemetry/ext"
 
 require_relative "../ext/settings"
 require_relative "../git/tree_uploader"
+require_relative "../logs/component"
+require_relative "../logs/transport"
 require_relative "../remote/component"
 require_relative "../remote/library_settings_client"
 require_relative "../test_management/component"
@@ -11,7 +13,6 @@ require_relative "../test_management/null_component"
 require_relative "../test_management/tests_properties"
 require_relative "../test_optimisation/component"
 require_relative "../test_optimisation/coverage/transport"
-require_relative "../test_optimisation/coverage/writer"
 require_relative "../test_retries/component"
 require_relative "../test_retries/null_component"
 require_relative "../test_visibility/component"
@@ -20,12 +21,13 @@ require_relative "../test_visibility/known_tests"
 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/null_transport"
 require_relative "../test_visibility/transport"
 require_relative "../transport/adapters/telemetry_webmock_safe_adapter"
-require_relative "../test_visibility/null_transport"
 require_relative "../transport/api/builder"
 require_relative "../utils/parsing"
 require_relative "../utils/test_run"
+require_relative "../async_writer"
 require_relative "../worker"
 
 module Datadog
@@ -33,7 +35,8 @@ module Datadog
     module Configuration
       # Adds CI behavior to Datadog trace components
       module Components
-        attr_reader :test_visibility, :test_optimisation, :git_tree_upload_worker, :ci_remote, :test_retries, :test_management
+        attr_reader :test_visibility, :test_optimisation, :git_tree_upload_worker, :ci_remote, :test_retries,
+          :test_management, :agentless_logs_submission
 
         def initialize(settings)
           @test_optimisation = nil
@@ -56,6 +59,7 @@ module Datadog
 
           @test_visibility&.shutdown!
           @test_optimisation&.shutdown!
+          @agentless_logs_submission&.shutdown!
           @git_tree_upload_worker&.stop
         end
 
@@ -129,8 +133,11 @@ module Datadog
           @test_visibility = TestVisibility::Component.new(
             test_suite_level_visibility_enabled: !settings.ci.force_test_level_visibility,
             logical_test_session_name: settings.ci.test_session_name,
-            known_tests_client: build_known_tests_client(settings, test_visibility_api)
+            known_tests_client: build_known_tests_client(settings, test_visibility_api),
+            context_service_uri: settings.ci.test_visibility_drb_server_uri
           )
+
+          @agentless_logs_submission = build_agentless_logs_component(settings, test_visibility_api)
         end
 
         def build_test_optimisation(settings, test_visibility_api)
@@ -223,7 +230,7 @@ module Datadog
           # nil means that coverage event will be ignored
           return nil if api.nil? || settings.ci.discard_traces
 
-          TestOptimisation::Coverage::Writer.new(
+          AsyncWriter.new(
             transport: TestOptimisation::Coverage::Transport.new(api: api)
           )
         end
@@ -255,6 +262,29 @@ module Datadog
           )
         end
 
+        def build_agentless_logs_component(settings, api)
+          if settings.ci.agentless_logs_submission_enabled && !settings.ci.agentless_mode_enabled
+            Datadog.logger.warn(
+              "Agentless logs submission is enabled but agentless mode is not enabled. " \
+              "Logs will not be submitted. " \
+              "Please make sure to set DD_CIVISIBILITY_AGENTLESS_ENABLED to true if you want to submit logs in agentless mode. " \
+              "Otherwise, set DD_AGENTLESS_LOG_SUBMISSION_ENABLED to 0 and use Datadog Agent to submit logs."
+            )
+            settings.ci.agentless_logs_submission_enabled = false
+          end
+
+          Logs::Component.new(
+            enabled: settings.ci.agentless_logs_submission_enabled,
+            writer: build_logs_writer(settings, api)
+          )
+        end
+
+        def build_logs_writer(settings, api)
+          return nil if api.nil? || settings.ci.discard_traces
+
+          AsyncWriter.new(transport: Logs::Transport.new(api: api), options: {buffer_size: 1024})
+        end
+
         # fetch custom tags provided by the user in DD_TAGS env var
         # with prefix test.configuration.
         def custom_configuration(settings)
@@ -297,7 +327,7 @@ module Datadog
 
             # 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
+          rescue LoadError, StandardError => e
             Datadog.logger.warn("Failed to patch Datadog gem's telemetry layer: #{e}")
           end
         end

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

@@ -128,12 +128,29 @@ module Datadog
                 o.default 20
               end
 
+              option :agentless_logs_submission_enabled do |o|
+                o.type :bool
+                o.env CI::Ext::Settings::ENV_AGENTLESS_LOGS_SUBMISSION_ENABLED
+                o.default false
+              end
+
+              option :agentless_logs_submission_url do |o|
+                o.type :string, nilable: true
+                o.env CI::Ext::Settings::ENV_AGENTLESS_LOGS_SUBMISSION_URL
+              end
+
               # internal only
               option :discard_traces do |o|
                 o.type :bool
                 o.default false
               end
 
+              # internal only
+              option :test_visibility_drb_server_uri do |o|
+                o.type :string, nilable: true
+                o.env CI::Ext::Settings::ENV_TEST_VISIBILITY_DRB_SERVER_URI
+              end
+
               define_method(:instrument) do |integration_name, options = {}, &block|
                 return unless enabled
 

data/lib/datadog/ci/contrib/activesupport/configuration/settings.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "../ext"
+require_relative "../../settings"
+require_relative "../../../utils/configuration"
+
+module Datadog
+  module CI
+    module Contrib
+      module ActiveSupport
+        module Configuration
+          # Custom settings for the ActiveSupport integration
+          # @public_api
+          class Settings < Datadog::CI::Contrib::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/activesupport/ext.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module ActiveSupport
+        # Datadog ActiveSupport integration constants
+        module Ext
+          ENV_ENABLED = "DD_CI_ACTIVESUPPORT_ENABLED"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/activesupport/integration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module ActiveSupport
+        # Description of ActiveSupport integration
+        class Integration < Datadog::CI::Contrib::Integration
+          MINIMUM_VERSION = Gem::Version.new("5.0")
+
+          def version
+            Gem.loaded_specs["activesupport"]&.version
+          end
+
+          def loaded?
+            !defined?(::Rails).nil? && !defined?(::ActiveSupport).nil? && !defined?(::ActiveSupport::TaggedLogging).nil? &&
+              !defined?(::ActiveSupport::TaggedLogging::Formatter).nil?
+          end
+
+          def compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def late_instrument?
+            true
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/activesupport/logs_formatter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module ActiveSupport
+        module LogsFormatter
+          def call(severity, timestamp, progname, msg)
+            # don't even construct an object for every log message if agentless logs submission is not enabled
+            return super unless datadog_logs_component.enabled
+            return super unless datadog_configuration[:enabled]
+
+            # additional precaution because we cannot use targeted prepend in Ruby 2.7, so method :tags_text might
+            # not be available (highly unlikely, but not unimaginable)
+            #
+            # (see Datadog::CI::Contrib::ActiveSupport::Patcher for explanation)
+            return super unless respond_to?(:tags_text)
+
+            message = "#{msg} #{tags_text}"
+            return super unless message.include?("dd.trace_id")
+
+            datadog_logs_component.write({
+              message: message,
+              level: severity
+            })
+
+            super
+          end
+
+          def datadog_logs_component
+            Datadog.send(:components).agentless_logs_submission
+          end
+
+          def datadog_configuration
+            Datadog.configuration.ci[:activesupport]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/activesupport/patcher.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "../patcher"
+require_relative "logs_formatter"
+
+module Datadog
+  module CI
+    module Contrib
+      module ActiveSupport
+        # Patcher enables patching of activesupport module
+        module Patcher
+          include Datadog::CI::Contrib::Patcher
+
+          module_function
+
+          def patch
+            unless datadog_logs_component.enabled
+              Datadog.logger.debug("Datadog logs submission is disabled, skipping activesupport patching")
+              return
+            end
+
+            unless ::Rails.logger.formatter.is_a?(::ActiveSupport::TaggedLogging::Formatter)
+              Datadog.logger.debug {
+                "Rails logger formatter is not an instance of ActiveSupport::TaggedLogging::Formatter, skipping activesupport patching. " \
+                "Formatter: #{::Rails.logger.formatter.class}"
+              }
+              return
+            end
+
+            # Before Ruby 3.0, prepending to a module did not change existing instances where this module was included
+            # It means that for Ruby 2.7 we have to patch formatter's class directly
+            #
+            # Context:
+            # - https://bugs.ruby-lang.org/issues/9573
+            # - https://rubyreferences.github.io/rubychanges/3.0.html#include-and-prepend-now-affects-modules-including-the-receiver
+            if RUBY_VERSION.start_with?("2.7")
+              Rails.logger.formatter.class.prepend(LogsFormatter)
+            else
+              ::ActiveSupport::TaggedLogging::Formatter.prepend(LogsFormatter)
+            end
+          end
+
+          def datadog_logs_component
+            Datadog.send(:components).agentless_logs_submission
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/lograge/configuration/settings.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "../ext"
+require_relative "../../settings"
+require_relative "../../../utils/configuration"
+
+module Datadog
+  module CI
+    module Contrib
+      module Lograge
+        module Configuration
+          # Custom settings for the Lograge integration
+          # @public_api
+          class Settings < Datadog::CI::Contrib::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/lograge/ext.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Lograge
+        # Datadog Lograge integration constants
+        module Ext
+          ENV_ENABLED = "DD_CI_LOGRAGE_ENABLED"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/lograge/integration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module Lograge
+        # Description of Lograge integration
+        class Integration < Datadog::CI::Contrib::Integration
+          MINIMUM_VERSION = Gem::Version.new("0.14.0")
+
+          def version
+            Gem.loaded_specs["lograge"]&.version
+          end
+
+          def loaded?
+            !defined?(::Lograge).nil? && !defined?(::Lograge::LogSubscribers).nil? &&
+              !defined?(::Lograge::LogSubscribers::Base).nil?
+          end
+
+          def compatible?
+            super && version && version >= MINIMUM_VERSION
+          end
+
+          def late_instrument?
+            true
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/lograge/log_subscriber.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Lograge
+        module LogSubscriber
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          module InstanceMethods
+            private
+
+            def before_format(data, payload)
+              return super unless datadog_logs_component.enabled
+              return super unless datadog_configuration[:enabled]
+
+              result = super
+
+              if result.fetch(:dd, {}).fetch(:trace_id, nil).nil?
+                Datadog.logger.debug { "Discarding uncorrelated log event: #{result.inspect}" }
+                return result
+              end
+              datadog_logs_component.write(result)
+              result
+            end
+
+            def datadog_logs_component
+              Datadog.send(:components).agentless_logs_submission
+            end
+
+            def datadog_configuration
+              Datadog.configuration.ci[:lograge]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/lograge/patcher.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../patcher"
+require_relative "log_subscriber"
+
+module Datadog
+  module CI
+    module Contrib
+      module Lograge
+        # Patcher enables patching of lograge module
+        module Patcher
+          include Datadog::CI::Contrib::Patcher
+
+          module_function
+
+          def patch
+            unless datadog_logs_component.enabled
+              Datadog.logger.debug("Datadog logs submission is disabled, skipping lograge patching")
+              return
+            end
+
+            ::Lograge::LogSubscribers::Base.include(LogSubscriber)
+          end
+
+          def datadog_logs_component
+            Datadog.send(:components).agentless_logs_submission
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -27,7 +27,10 @@ module Datadog
                   CI::Ext::Test::TAG_FRAMEWORK_VERSION => datadog_integration.version.to_s
                 },
                 service: datadog_configuration[:service_name],
-                estimated_total_tests_count: tests_count
+                estimated_total_tests_count: tests_count,
+                # if minitest is being used with a parallel runner, then tests split will happen by example, not by test suite
+                # we need to always start/stop test suites in the parent process in this case
+                local_test_suites_mode: false
               )
               test_visibility_component.start_test_module(Ext::FRAMEWORK)
             end