Address feedback

Author: jterapin

instrumentation/aws_sdk/lib/opentelemetry/instrumentation/aws_sdk/instrumentation.rb

@@ -38,7 +38,8 @@ module AwsSdk
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('2.0.0')
 
-        install do |_config|
+        install do |config|
+          resolve_config(config) unless config[:suppress_internal_instrumentation].nil?
           require_dependencies
           patch_telemetry_plugin if telemetry_plugin?
           add_plugins(Seahorse::Client::Base, *loaded_service_clients)
@@ -54,6 +55,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
 
         option :inject_messaging_context, default: false, validate: :boolean
         option :enable_internal_instrumentation, default: false, validate: :boolean
+        option :suppress_internal_instrumentation, default: nil, validate: :boolean
 
         def gem_version
           if Gem.loaded_specs['aws-sdk']
@@ -67,6 +69,13 @@ def gem_version
 
         private
 
+        def resolve_config(config)
+          OpenTelemetry.logger.warn(
+            'suppress_internal_instrumentation is deprecated, please use enable_internal_instrumentation instead'
+          )
+          config[:enable_internal_instrumentation] = !config[:suppress_internal_instrumentation]
+        end
+
         def require_dependencies
           require_relative 'handler'
           require_relative 'handler_helper'

instrumentation/aws_sdk/test/opentelemetry/instrumentation_test.rb

@@ -66,10 +66,21 @@
     end
   end
 
-  describe '#install with default options' do
-    it 'with default options' do
-      _(instrumentation.config[:inject_messaging_context]).must_equal(false)
-      _(instrumentation.config[:enable_internal_instrumentation]).must_equal(false)
-    end
+  it 'with default options' do
+    instrumentation.instance_variable_set(:@installed, false)
+    instrumentation.install
+    _(instrumentation.config[:inject_messaging_context]).must_equal(false)
+    _(instrumentation.config[:enable_internal_instrumentation]).must_equal(false)
+    assert_nil(instrumentation.config[:suppress_internal_instrumentation])
+  end
+
+  it 'honors deprecated config, :suppress_internal_instrumentation' do
+    instrumentation.instance_variable_set(:@installed, false)
+    instrumentation.install(suppress_internal_instrumentation: false)
+    _(instrumentation.config[:enable_internal_instrumentation]).must_equal(true)
+
+    instrumentation.instance_variable_set(:@installed, false)
+    instrumentation.install(suppress_internal_instrumentation: true)
+    _(instrumentation.config[:enable_internal_instrumentation]).must_equal(false)
   end
 end

instrumentation/aws_sdk/test/opentelemetry/patches/telemetry_test.rb

@@ -70,7 +70,7 @@
 
       it 'creates internal spans when enabled' do
         skip unless TestHelper.telemetry_plugin?(service_name)
-        stub_request(:get, 'https://lambda.us-east-1.amazonaws.com/2015-03-31/functions/')
+        stub_request(:get, 'https://lambda.us-east-1.amazonaws.com/2015-03-31/functions')
         client = Aws::Lambda::Client.new(
           telemetry_provider: otel_provider,
           credentials: Aws::Credentials.new('akid', 'secret'),