Remove configuring tracing.client_ip.enabled with ENV['DD_TRACE_CLIEN…

…T_IP_HEADER_DISABLED']
DataDog · Jan 25, 2024 · be32fc1 · be32fc1
1 parent b9c8ffb
commit be32fc1
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 19 deletions.
diff --git a/lib/datadog/tracing/configuration/ext.rb b/lib/datadog/tracing/configuration/ext.rb
@@ -91,7 +91,6 @@ module Transport
         # @public_api
         module ClientIp
           ENV_ENABLED = 'DD_TRACE_CLIENT_IP_ENABLED'
-          ENV_DISABLED = 'DD_TRACE_CLIENT_IP_HEADER_DISABLED' # TODO: deprecated, remove later
           ENV_HEADER_NAME = 'DD_TRACE_CLIENT_IP_HEADER'
         end
       end

diff --git a/lib/datadog/tracing/configuration/settings.rb b/lib/datadog/tracing/configuration/settings.rb
@@ -383,30 +383,14 @@ def self.extended(base)
                 # Whether client IP collection is enabled. When enabled client IPs from HTTP requests will
                 #   be reported in traces.
                 #
-                # Usage of the DD_TRACE_CLIENT_IP_HEADER_DISABLED environment variable is deprecated.
-                #
                 # @see https://docs.datadoghq.com/tracing/configure_data_security#configuring-a-client-ip-header
                 #
                 # @default `DD_TRACE_CLIENT_IP_ENABLED` environment variable, otherwise `false`.
                 # @return [Boolean]
                 option :enabled do |o|
                   o.type :bool
-                  o.default do
-                    disabled = Core::Environment::VariableHelpers.env_to_bool(Tracing::Configuration::Ext::ClientIp::ENV_DISABLED)
-
-                    enabled = if disabled.nil?
-                                false
-                              else
-                                Datadog::Core.log_deprecation do
-                                  "#{Tracing::Configuration::Ext::ClientIp::ENV_DISABLED} environment variable is deprecated, use #{Tracing::Configuration::Ext::ClientIp::ENV_ENABLED} instead."
-                                end
-
-                                !disabled
-                              end
-
-                    # ENABLED env var takes precedence over deprecated DISABLED
-                    Core::Environment::VariableHelpers.env_to_bool(Tracing::Configuration::Ext::ClientIp::ENV_ENABLED, enabled)
-                  end
+                  o.env Tracing::Configuration::Ext::ClientIp::ENV_ENABLED
+                  o.default false
                 end
 
                 # An optional name of a custom header to resolve the client IP from.

diff --git a/spec/datadog/tracing/configuration/settings_spec.rb b/spec/datadog/tracing/configuration/settings_spec.rb
@@ -824,5 +824,31 @@ def propagation_inject_style
           .to(true)
       end
     end
+
+    describe '#client_ip.enabled' do
+      context 'default' do
+        it do
+          expect(settings.tracing.client_ip.enabled).to eq(false)
+        end
+      end
+
+      {
+        'true' => true,
+        '1' => true,
+        'false' => false
+      }.each do |env, value|
+        context "when ENV['DD_TRACE_CLIENT_IP_ENABLED'] is '#{env}'" do
+          around do |example|
+            ClimateControl.modify('DD_TRACE_CLIENT_IP_ENABLED' => env) do
+              example.run
+            end
+          end
+
+          it do
+            expect(settings.tracing.client_ip.enabled).to eq(value)
+          end
+        end
+      end
+    end
   end
 end