datadog-ci 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce3b4502404f6faa6b05421763ced6582071c9ad025937219b59ba8c63c39175
-  data.tar.gz: 7a341aa75161299cb04a29f745e172ef5ca4fec3a24f536ec96e08119de11a97
+  metadata.gz: 85bb3584dc8081e8f6e8531d2a600e3948f4f9ea23d551dd99df0eab9daf2a3c
+  data.tar.gz: b6f686d49d3dbb1695c0f6e20b434b77648a118c32e1691f4a0f30b13d38dc62
 SHA512:
-  metadata.gz: 6058fbf497f43040a588018a2104055a303849d5616d063412dae4dab1e5247098e9ecd1b0b718776a51bc090f137d2bcf19cc78d252c7968c9cd6e4723ad902
-  data.tar.gz: 3c8d8eb9a34266a690a0dd5103d344b80df5175c703a414b1bc8255dc3c2732d723960e786765f2686fdcaaff5f009b675942c5e39dbd4a6fc9e58a38653051e
+  metadata.gz: 8e8ae716ea7c7408c59c11efa5a3bc30e0767a02c659e231f1cec2a02d5494d451c1e2b43c7c16240cbe7c9418f004ead32faa09b08c83bcd878156fa1062ae9
+  data.tar.gz: 15bdfb45e32660356fcc4c5726c4a640c78cfc2d5007807623f532a0b7c321f0b11a32d0a75f571a64ae263159d4b86b0a750dda5d7e8a5c33f9c110bf7682a0

data/CHANGELOG.md

@@ -1,5 +1,70 @@
 ## [Unreleased]
 
+## [0.5.1] - 2023-12-11
+
+### Fixed
+
+* do not collect environment tags when CI is not enabled ([#87][])
+
+### Changed
+
+* Move private classes and modules deeper in module hierarchy ([#85][])
+* update appraisal dependencies ([#84][])
+
+## [0.5.0] - 2023-12-06
+
+### Test suite level visibility
+
+This release includes experimental manual API for [test suite level visibility](https://docs.datadoghq.com/continuous_integration/explorer/?tab=testruns#sessions) in Ruby.
+
+Currently test suite level visibility is not used by our instrumentation: it will be released in v0.6.
+
+### Added
+
+* Test suite level visibility: add test session public API ([#72][])
+* Test suite level visibility: test module support ([#76][])
+* Test suite level visibility: test suites support ([#77][])
+* add YARD documentation ([#82][])
+* support validation errors for CI spans ([#78][])
+
+### Changed
+
+* Validate DD_SITE variable ([#79][])
+* Document how to use WebMock with datadog-ci ([#80][])
+
+### Fixed
+
+* Datadog::CI.trace_test always starts a new trace ([#74][])
+* Skip tracing when CI mode disabled and manual API is used ([#75][])
+
+### Removed
+
+* Deprecate operation name setting, change service_name to service in public API ([#81][])
+
+## [0.4.1] - 2023-11-22
+
+### Fixed
+
+* disable 128-bit trace id generation in CI mode ([#70][])
+
+## [0.4.0] - 2023-11-21
+
+### Added
+
+* Public API for manual test instrumentation ([#64][]) ([#61][])
+
+### Changed
+
+* fix tracing instrumentation example in readme ([#60][])
+
+### Fixed
+
+* Remove user credentials from ssh URLs and from GITHUB_REPO_URL environment variable ([#66][])
+
+### Removed
+
+* Remove _dd.measured tag from spans ([#65][])
+
 ## [0.3.0] - 2023-10-25
 
 ### Added
@@ -47,7 +112,11 @@
 
 * Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.3.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.5.1...main
+[0.5.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.5.0...v0.5.1
+[0.5.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.1.0...v0.1.1
@@ -66,3 +135,22 @@
 [#49]: https://github.com/DataDog/datadog-ci-rb/issues/49
 [#51]: https://github.com/DataDog/datadog-ci-rb/issues/51
 [#54]: https://github.com/DataDog/datadog-ci-rb/issues/54
+[#60]: https://github.com/DataDog/datadog-ci-rb/issues/60
+[#61]: https://github.com/DataDog/datadog-ci-rb/issues/61
+[#64]: https://github.com/DataDog/datadog-ci-rb/issues/64
+[#65]: https://github.com/DataDog/datadog-ci-rb/issues/65
+[#66]: https://github.com/DataDog/datadog-ci-rb/issues/66
+[#70]: https://github.com/DataDog/datadog-ci-rb/issues/70
+[#72]: https://github.com/DataDog/datadog-ci-rb/issues/72
+[#74]: https://github.com/DataDog/datadog-ci-rb/issues/74
+[#75]: https://github.com/DataDog/datadog-ci-rb/issues/75
+[#76]: https://github.com/DataDog/datadog-ci-rb/issues/76
+[#77]: https://github.com/DataDog/datadog-ci-rb/issues/77
+[#78]: https://github.com/DataDog/datadog-ci-rb/issues/78
+[#79]: https://github.com/DataDog/datadog-ci-rb/issues/79
+[#80]: https://github.com/DataDog/datadog-ci-rb/issues/80
+[#81]: https://github.com/DataDog/datadog-ci-rb/issues/81
+[#82]: https://github.com/DataDog/datadog-ci-rb/issues/82
+[#84]: https://github.com/DataDog/datadog-ci-rb/issues/84
+[#85]: https://github.com/DataDog/datadog-ci-rb/issues/85
+[#87]: https://github.com/DataDog/datadog-ci-rb/issues/87

data/README.md

@@ -1,6 +1,7 @@
 # Datadog CI Visibility for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/datadog-ci.svg)](https://badge.fury.io/rb/datadog-ci)
+[![YARD documentation](https://img.shields.io/badge/YARD-documentation-blue)](https://datadoghq.dev/datadog-ci-rb/)
 [![codecov](https://codecov.io/gh/DataDog/datadog-ci-rb/branch/main/graph/badge.svg)](https://app.codecov.io/gh/DataDog/datadog-ci-rb/branch/main)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/DataDog/datadog-ci-rb/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/DataDog/datadog-ci-rb/tree/main)
 
@@ -30,18 +31,18 @@ To activate `RSpec` integration, add this to the `spec_helper.rb` file:
 require 'rspec'
 require 'datadog/ci'
 
-Datadog.configure do |c|
-  # Only activates test instrumentation on CI
-  c.tracing.enabled = (ENV["DD_ENV"] == "ci")
-
-  # Configures the tracer to ensure results delivery
-  c.ci.enabled = true
+# Only activates test instrumentation on CI
+if ENV["DD_ENV"] == "ci"
+  Datadog.configure do |c|
+    # Configures the tracer to ensure results delivery
+    c.ci.enabled = true
 
-  # The name of the service or library under test
-  c.service = 'my-ruby-app'
+    # The name of the service or library under test
+    c.service = 'my-ruby-app'
 
-  # Enables the RSpec instrumentation
-  c.ci.instrument :rspec, **options
+    # Enables the RSpec instrumentation
+    c.ci.instrument :rspec, **options
+  end
 end
 ```
 
@@ -51,7 +52,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether RSpec tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `rspec` instrumentation. | `'rspec'` |
-| `operation_name` | Operation name used for `rspec` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'rspec.example'` |
+| `operation_name` | *DEPRECATED, to be removed in 1.0* Operation name used for `rspec` instrumentation (has no effect in agentless mode or when using newer agent versions). | `'rspec.example'` |
 
 ### Minitest
 
@@ -63,18 +64,18 @@ To activate your integration, use the `Datadog.configure` method:
 require 'minitest'
 require 'datadog/ci'
 
+# Only activates test instrumentation on CI
+if ENV["DD_ENV"] == "ci"
 # Configure default Minitest integration
-Datadog.configure do |c|
-  # Only activates test instrumentation on CI
-  c.tracing.enabled = (ENV["DD_ENV"] == "ci")
-
-  # Configures the tracer to ensure results delivery
-  c.ci.enabled = true
+  Datadog.configure do |c|
+    # Configures the tracer to ensure results delivery
+    c.ci.enabled = true
 
-  # The name of the service or library under test
-  c.service = 'my-ruby-app'
+    # The name of the service or library under test
+    c.service = 'my-ruby-app'
 
-  c.ci.instrument :minitest, **options
+    c.ci.instrument :minitest, **options
+  end
 end
 ```
 
@@ -84,7 +85,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether Minitest tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `minitest` instrumentation. | `'minitest'` |
-| `operation_name` | Operation name used for `minitest` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'minitest.test'` |
+| `operation_name` | *DEPRECATED, to be removed in 1.0* Operation name used for `minitest` instrumentation (has no effect in agentless mode or when using newer agent versions). | `'minitest.test'` |
 
 ### Cucumber
 
@@ -94,18 +95,18 @@ Activate `Cucumber` integration with configuration
 require 'cucumber'
 require 'datadog/ci'
 
-Datadog.configure do |c|
-  # Only activates test instrumentation on CI
-  c.tracing.enabled = (ENV["DD_ENV"] == "ci")
-
-  # Configures the tracer to ensure results delivery
-  c.ci.enabled = true
+# Only activates test instrumentation on CI
+if ENV["DD_ENV"] == "ci"
+  Datadog.configure do |c|
+    # Configures the tracer to ensure results delivery
+    c.ci.enabled = true
 
-  # The name of the service or library under test
-  c.service = 'my-ruby-app'
+    # The name of the service or library under test
+    c.service = 'my-ruby-app'
 
-  # Enables the Cucumber instrumentation
-  c.ci.instrument :cucumber, **options
+    # Enables the Cucumber instrumentation
+    c.ci.instrument :cucumber, **options
+  end
 end
 ```
 
@@ -115,7 +116,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether Cucumber tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `cucumber` instrumentation. | `'cucumber'` |
-| `operation_name` | Operation name used for `cucumber` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'cucumber.test'` |
+| `operation_name` | *DEPRECATED, to be removed in 1.0* Operation name used for `cucumber` instrumentation (has no effect in agentless mode or when using newer agent versions). | `'cucumber.test'` |
 
 ## Agentless mode
 
@@ -145,8 +146,8 @@ In order to achieve this you can configure ddtrace instrumentations in your conf
 ```ruby
 Datadog.configure do |c|
   #  ... ci configs and instrumentation here ...
-  c.instrument :redis
-  c.instrument :pg
+  c.tracing.instrument :redis
+  c.tracing.instrument :pg
 end
 ```
 
@@ -161,6 +162,28 @@ they will **not** show up in Datadog APM.
 
 For the full list of available instrumentations see [ddtrace documentation](https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md)
 
+### WebMock
+
+[WebMock](https://github.com/bblimke/webmock)
+is a popular Ruby library that stubs HTTP requests when running tests.
+By default it fails when used together with datadog-ci as traces are being sent
+to Datadog via HTTP calls.
+
+In order to allow HTTP connections for Datadog backend you would need to configure
+Webmock accordingly.
+
+```ruby
+# when using agentless mode
+# note to use the correct datadog site (e.g. datadoghq.eu, etc)
+WebMock.disable_net_connect!(:allow => "citestcycle-intake.datadoghq.com")
+
+# when using agent
+WebMock.disable_net_connect!(:allow_localhost => true)
+
+# or for more granular setting set your agent URL
+WebMock.disable_net_connect!(:allow => "localhost:8126")
+```
+
 ### Disabling startup logs
 
 Startup logs produce a report of tracing state when the application is initially configured.

data/lib/datadog/ci/concurrent_span.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "span"
+
+module Datadog
+  module CI
+    # Represents a single part of a test run that can be safely shared between threads.
+    # Examples of shared objects are: TestSession, TestModule, TestSpan.
+    #
+    # @public_api
+    class ConcurrentSpan < Span
+      def initialize(tracer_span)
+        super
+
+        @mutex = Mutex.new
+      end
+
+      # Gets tag value by key. This method is thread-safe.
+      # @param [String] key the key of the tag.
+      # @return [String] the value of the tag.
+      def get_tag(key)
+        synchronize { super }
+      end
+
+      # Sets tag value by key. This method is thread-safe.
+      # @param [String] key the key of the tag.
+      # @param [String] value the value of the tag.
+      # @return [void]
+      def set_tag(key, value)
+        synchronize { super }
+      end
+
+      # Sets metric value by key. This method is thread-safe.
+      # @param [String] key the key of the metric.
+      # @param [Numeric] value the value of the metric.
+      # @return [void]
+      def set_metric(key, value)
+        synchronize { super }
+      end
+
+      # Finishes the span. This method is thread-safe.
+      # @return [void]
+      def finish
+        synchronize { super }
+      end
+
+      # Sets multiple tags at once. This method is thread-safe.
+      # @param [Hash[String, String]] tags the tags to set.
+      # @return [void]
+      def set_tags(tags)
+        synchronize { super }
+      end
+
+      def synchronize
+        @mutex.synchronize { yield }
+      end
+    end
+  end
+end

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

@@ -4,7 +4,11 @@ require "datadog/core/configuration/agent_settings_resolver"
 require "datadog/core/remote/negotiation"
 
 require_relative "../ext/transport"
+require_relative "../ext/settings"
 require_relative "../test_visibility/flush"
+require_relative "../test_visibility/recorder"
+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/api/builder"
 
@@ -13,10 +17,17 @@ module Datadog
     module Configuration
       # Adds CI behavior to Datadog trace components
       module Components
+        attr_reader :ci_recorder
+
         def initialize(settings)
           # Activate CI mode if enabled
           activate_ci!(settings) if settings.ci.enabled
 
+          @ci_recorder = TestVisibility::Recorder.new(
+            enabled: settings.ci.enabled,
+            test_suite_level_visibility_enabled: settings.ci.experimental_test_suite_level_visibility_enabled
+          )
+
           # Initialize normally
           super
         end
@@ -26,9 +37,12 @@ module Datadog
           agent_settings = Datadog::Core::Configuration::AgentSettingsResolver.call(settings)
 
           if settings.ci.agentless_mode_enabled
+            check_dd_site(settings)
             test_visibility_transport = build_agentless_transport(settings)
           elsif can_use_evp_proxy?(settings, agent_settings)
             test_visibility_transport = build_evp_proxy_transport(settings, agent_settings)
+          else
+            settings.ci.experimental_test_suite_level_visibility_enabled = false
           end
 
           # Deactivate telemetry
@@ -37,11 +51,15 @@ module Datadog
           # Deactivate remote configuration
           settings.remote.enabled = false
 
+          # do not use 128-bit trace ids for CI visibility
+          # they are used for OTEL compatibility in Datadog tracer
+          settings.tracing.trace_id_128_bit_generation_enabled = false
+
           # Activate underlying tracing test mode
           settings.tracing.test_mode.enabled = true
 
           # Choose user defined TraceFlush or default to CI TraceFlush
-          settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Finished.new
+          settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Partial.new
 
           writer_options = settings.ci.writer_options
           if test_visibility_transport
@@ -80,6 +98,7 @@ module Datadog
 
             Datadog::CI::TestVisibility::Transport.new(
               api: Transport::Api::Builder.build_ci_test_cycle_api(settings),
+              serializers_factory: serializers_factory(settings),
               dd_env: settings.env
             )
           end
@@ -90,9 +109,29 @@ module Datadog
 
           Datadog::CI::TestVisibility::Transport.new(
             api: Transport::Api::Builder.build_evp_proxy_api(agent_settings),
+            serializers_factory: serializers_factory(settings),
             dd_env: settings.env
           )
         end
+
+        def serializers_factory(settings)
+          if settings.ci.experimental_test_suite_level_visibility_enabled
+            Datadog::CI::TestVisibility::Serializers::Factories::TestSuiteLevel
+          else
+            Datadog::CI::TestVisibility::Serializers::Factories::TestLevel
+          end
+        end
+
+        def check_dd_site(settings)
+          return if settings.site.nil?
+          return if Ext::Settings::DD_SITE_ALLOWLIST.include?(settings.site)
+
+          Datadog.logger.warn(
+            "CI VISIBILITY CONFIGURATION " \
+            "Agentless mode was enabled but DD_SITE is not set to one of the following: #{Ext::Settings::DD_SITE_ALLOWLIST.join(", ")}. " \
+            "Please make sure to set valid site in DD_SITE environment variable"
+          )
+        end
       end
     end
   end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "datadog/core/configuration/settings"
+require "datadog/core/configuration/components"
+
+require_relative "settings"
+require_relative "components"
+
+module Datadog
+  module CI
+    module Configuration
+      # Extends Datadog tracing with CI features
+      module Extensions
+        def self.activate!
+          Core::Configuration::Settings.extend(CI::Configuration::Settings)
+          Core::Configuration::Components.prepend(CI::Configuration::Components)
+        end
+      end
+    end
+  end
+end

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

@@ -34,6 +34,12 @@ module Datadog
                 o.env CI::Ext::Settings::ENV_AGENTLESS_URL
               end
 
+              option :experimental_test_suite_level_visibility_enabled do |o|
+                o.type :bool
+                o.env CI::Ext::Settings::ENV_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED
+                o.default false
+              end
+
               define_method(:instrument) do |integration_name, options = {}, &block|
                 return unless enabled
 
@@ -56,7 +62,7 @@ module Datadog
                 fetch_integration(integration_name).configuration
               end
 
-              # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
+              # @deprecated Will be removed on datadog-ci-rb 1.0.
               alias_method :use, :instrument
 
               option :trace_flush

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "datadog/core"
+
 require_relative "../ext"
 require_relative "../../settings"
 
@@ -9,7 +11,7 @@ module Datadog
       module Cucumber
         module Configuration
           # Custom settings for the Cucumber integration
-          # TODO: mark as `@public_api` when GA
+          # @public_api
           class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
@@ -22,10 +24,19 @@ module Datadog
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
             end
 
+            # @deprecated Will be removed in 1.0
             option :operation_name do |o|
               o.type :string
               o.env Ext::ENV_OPERATION_NAME
               o.default Ext::OPERATION_NAME
+
+              o.after_set do |value|
+                if value && value != Ext::OPERATION_NAME
+                  Datadog::Core.log_deprecation do
+                    "The operation_name setting has no effect and will be removed in 1.0"
+                  end
+                end
+              end
             end
           end
         end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -28,56 +27,50 @@ module Datadog
           end
 
           def on_test_case_started(event)
-            @current_feature_span = CI::Recorder.trace(
-              configuration[:operation_name],
-              {
-                span_options: {
-                  resource: event.test_case.name,
-                  service: configuration[:service_name]
-                },
-                framework: Ext::FRAMEWORK,
-                framework_version: CI::Contrib::Cucumber::Integration.version.to_s,
-                test_name: event.test_case.name,
-                test_suite: event.test_case.location.file,
-                test_type: Ext::TEST_TYPE
-              }
+            CI.start_test(
+              event.test_case.name,
+              event.test_case.location.file,
+              tags: {
+                CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
+                CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Cucumber::Integration.version.to_s,
+                CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE
+              },
+              service: configuration[:service_name]
             )
           end
 
           def on_test_case_finished(event)
-            return if @current_feature_span.nil?
+            test_span = CI.active_test
+            return if test_span.nil?
 
             if event.result.skipped?
-              CI::Recorder.skipped!(@current_feature_span)
+              test_span.skipped!
             elsif event.result.ok?
-              CI::Recorder.passed!(@current_feature_span)
+              test_span.passed!
             elsif event.result.failed?
-              CI::Recorder.failed!(@current_feature_span)
+              test_span.failed!
             end
 
-            @current_feature_span.finish
+            test_span.finish
           end
 
           def on_test_step_started(event)
-            trace_options = {
-              resource: event.test_step.to_s,
-              span_type: Ext::STEP_SPAN_TYPE
-            }
-            @current_step_span = Tracing.trace(Ext::STEP_SPAN_TYPE, **trace_options)
+            CI.trace(Ext::STEP_SPAN_TYPE, event.test_step.to_s)
           end
 
           def on_test_step_finished(event)
-            return if @current_step_span.nil?
+            current_step_span = CI.active_span(Ext::STEP_SPAN_TYPE)
+            return if current_step_span.nil?
 
             if event.result.skipped?
-              CI::Recorder.skipped!(@current_step_span, event.result.exception)
+              current_step_span.skipped!
             elsif event.result.ok?
-              CI::Recorder.passed!(@current_step_span)
+              current_step_span.passed!
             elsif event.result.failed?
-              CI::Recorder.failed!(@current_step_span, event.result.exception)
+              current_step_span.failed!(exception: event.result.exception)
             end
 
-            @current_step_span.finish
+            current_step_span.finish
           end
 
           private

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

@@ -9,7 +9,7 @@ module Datadog
       module Minitest
         module Configuration
           # Custom settings for the Minitest integration
-          # TODO: mark as `@public_api` when GA
+          # @public_api
           class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
@@ -22,10 +22,19 @@ module Datadog
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
             end
 
+            # @deprecated Will be removed in 1.0
             option :operation_name do |o|
               o.type :string
               o.env Ext::ENV_OPERATION_NAME
               o.default Ext::OPERATION_NAME
+
+              o.after_set do |value|
+                if value && value != Ext::OPERATION_NAME
+                  Datadog::Core.log_deprecation do
+                    "The operation_name setting has no effect and will be removed in 1.0"
+                  end
+                end
+              end
             end
           end
         end