Botocore instrumentation checks if it has been suppressed

Author: NathanielRN

Diff for: instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py

@@ -56,6 +56,7 @@
 from botocore.client import BaseClient
 from wrapt import ObjectProxy, wrap_function_wrapper
 
+from opentelemetry import context as context_api
 from opentelemetry.instrumentation.botocore.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.sdk.trace import Resource
@@ -89,6 +90,8 @@ def _uninstrument(self, **kwargs):
         unwrap(BaseClient, "_make_api_call")
 
     def _patched_api_call(self, original_func, instance, args, kwargs):
+        if context_api.get_value("suppress_instrumentation"):
+            return original_func(*args, **kwargs)
 
         endpoint_name = deep_getattr(instance, "_endpoint._endpoint_prefix")
 

Diff for: instrumentation/opentelemetry-instrumentation-botocore/tests/test_botocore_instrumentation.py

@@ -23,8 +23,10 @@
     mock_lambda,
     mock_s3,
     mock_sqs,
+    mock_xray,
 )
 
+from opentelemetry.context import attach, detach, set_value
 from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.test.test_base import TestBase
@@ -275,3 +277,16 @@ def test_kms_client(self):
 
         # checking for protection on sts against security leak
         self.assertTrue("params" not in span.attributes.keys())
+
+    @mock_xray
+    def test_suppress_instrumentation_xray_client(self):
+        xray_client = self.session.create_client(
+            "xray", region_name="us-east-1"
+        )
+        token = attach(set_value("suppress_instrumentation", True))
+        xray_client.put_trace_segments(TraceSegmentDocuments=["str1"])
+        xray_client.put_trace_segments(TraceSegmentDocuments=["str2"])
+        detach(token)
+
+        spans = self.memory_exporter.get_finished_spans()
+        self.assertEqual(0, len(spans))